DRAFT Create Hybrid Product

This resource accepts the data for the "Hybrid Product Create" feature. It uses the same authorisation mechanism as it described here: API Specifications.

DRAFT API call

undefined

Endpoint

https://SELLERCENTER-API/shop-api/v1/create-hybrid-product

Example:

https://SELLERCENTER-API/shop-api/v1/create-hybrid-product/?ServiceName=SHOP&Timestamp=2016-10-14T22%3A56%3A11%2B0200&Signature=2c93bd83586b212f9f29a3af4bc25f5ba4d0b754687b3082ed821be1d92b993

Parameters

Field

Title

Example

SellerSku

String

A unique identifier for the product within the SellerCenter instance that is to be added to the system. This identifier is usually freely assigned. Harmonized identifiers, such as UPC or EAN can be set via ProductId. Mandatory

SellerShortCode

String

Seller short code. Mandatory

ShopSetId

String

Shop unique identifier of a product set (config). Mandatory

ShopId

String

Shop unique identifier of a product (simple). Mandatory

ShopSku

String

Shop Sku of a product Mandatory

Status

String

One of the following values: 'active', 'inactive' or 'deleted'. Optional, defaults to 'active'.

SellingStatus

String

One of the fallowing values: 'active', 'inactice'. Optional, defaults to 'active'

Name

String

The name of the product as shown to the end-user. Mandatory

Variation

String

If a product is available in multiple variations (e.g., colors or size), this is the value of the variation. E.g., if the product is a jacket that comes in different sizes, this would be the size of the jacket's variation that is added with the call (e.g., 'Extra Small'). Mandatory

PrimaryCategory

String

The Shop ID of the primary category for his product. Mandatory

Categories

Array

List of one to thee sub-categories to which the product belongs. Each of the given sub-categories must descend from the category specified by the PrimaryCategory parameter. Optional

BrowseNodes

Array

List of one or two additional categories that are not necessarily related to the PrimaryCategory. Optional

Description

String

The description of the product, as shown to the end-user. 6 to 25000 characters. Embedding certain HTML tags is allowed, but must be escaped as character data (see below). Mandatory

Brand

String

The brand name of the product. Mandatory

Price

Decimal

The product's price. Not really a Double, but a Decimal. Mandatory

SalePrice

Decimal

The price for the product while it is on sale neeeds to be lower then the Price. If SalePrice is specified, either SaleStartDate or SaleEndDate must be given; vice versa, if at least one of SaleStartDate or SaleEndDate is specified, SalePrice is mandatory.

SaleStartDate

DateTime

Time and date for when the product goes on sale. If passed in, SalePrice becomes mandatory

SaleEndDate

DateTime

Time and date for when the product goes on sale. If passed in, SalePrice becomes mandatory.

TaxClass

String

The taxation class the product belongs to. The available tax classes are dependent on the specific installation the call is executed against. In a simple tax structure, 'default' suffices. Mandatory

ShipmentType

String

Indicates whether the product is shipped direcly upon receipt ('crossdocking') or is drop shipped ('dropshipping'). Which shipment types are permissible depends on what is set up for a specific seller. Optional

ProductId

String

A harmonized code for the product, such as Universal Product Code (UPC), International Article Number (EAN), Global Trade Item Number (GTIN) or International Standard Book Number (ISBN). Mandatory

Condition

String

Indicates whether the product is new or used. One of 'new', 'used' or 'refurbished'. Optional

ProductData

Subsection

Additional product attributes, depends on the primary category. Optional

Quantity

Integer

The current level of inventory for this product. Optional

VolumetricWeight

Number DECIMAL(10,2)

 undefined

ProductGroup

String

The name of the group

Request Example

{  
   "Request":{  
      "Product":{  
        "SellerSku": "4105382173aaee4",
        "ShopSetId": '12345-config',
        "ShopId" : "1234-simple",
        "ShopSku" : "4105382173aaee4-shop",
        "SellerShortCode" : "MY12345",        
        "Status": "active",
        "Name": "Magic Product",
        "Variation": "XXL",
        "PrimaryCategory": "4",
        "Categories": "2,3,5",
        "Description": "This is a <b>bold<\/b> product.",
        "Brand": "ASM",
        "Price": "100.00",
        "SalePrice": "32.5",
        "SaleStartDate": "2013-09-03T11:31:23+00:00",
        "SaleEndDate": "2013-10-03T11:31:23+00:00",
        "TaxClass": "default",
        "ShipmentType": "dropshipping",
        "ProductId": "xyzabc",
        "Condition": "new",
        "ProductData": {
           "Megapixels": "490",
           "OpticalZoom": "7",
           "SystemMemory": "4",
           "NumberCpus": "32",
           "Network": "This is network"
        },
        "Quantity": "10"         
      }
   }
}

Success response

Request was successfully interpreted:

{  
   "SuccessResponse":{  
      "Head":{  
         "RequestId":"",
         "RequestAction":"CreateHybridProduct",
         "ResponseType":"",
         "Timestamp": "2016-10-15T06:45:37+0200"
      },
      "Body":{  
         "processed": {},
         "failed": {}
         }
      }
   }

Error response

In case request message was improperly formatted:

{
  "ErrorResponse": {
    "Head": {
      "RequestAction": "CreateHybridProduct",
      "ErrorType": "",
      "ErrorCode": "1001",
      "ErrorMessage": "Empty product"
    },
    "Body": ""
}