POST api/SubmitCatalog

Add to or update your catalog.

Parameters

* Required
Property Description
Key (String)
* Your API key
SKUs (List)
* A list of the items to submit.
SKU (String)
* The item sku as it is presented on your e-commerce store.
ProductName (String)
* A brief description of the product to aid customs in identifying your parcel's contents.
Attribute1 (String)
An optional attribute.
Attribute2 (String)
An optional attribute.
Attribute3 (String)
An optional attribute.
Attribute4 (String)
An optional attribute.
Attribute5 (String)
An optional attribute.
Attribute6 (String)
An optional attribute.
HSCodeUS (String)
The US harmonization code for the item. If missing, our classifications department will add it within approximately a week.
CountryOfOrigin (String)
The item's country of manufacture.
CurrentPrice (Decimal)
* The price of the item in your local currency. This field is required if submitting a new item.
ProductURL (String)
The url to the item in your e-commerce store. This is not required, but is recommended to help us classify it faster.
Weight (Decimal)
The item weight. Required for new items unless you specify dimensions. Defaults to your country's weight unit unless you specify WeightInKilos or WeightUnit.
SKN (String)
The SKN of the item.
Length (Decimal)
The length of the item in inches. Required for new unless you specify weight. You can provide a unit other than inches in the DimensionUnit field.
Width (Decimal)
The width of the item in inches. Required for new items unless you specify weight. You can provide a unit other than inches in the DimensionUnit field.
Height (Decimal)
The height of the item in inches. Required for new items unless you specify weight. You can provide a unit other than inches in the DimensionUnit field.
ShipAlone (Boolean)
Will the item ship separately from other items in the order? Setting this to true will allow your shopper to exceed the weight limit when adding to their cart. You must split the parcel if the order exceeds the weight limit.
Delete (Boolean)
Flag this as true to delete this item from the catalog. Defaults to false.
WeightInKilos (Nullable)
Set this to true if the Weight parameter above is in kilos, or set WeightUnit to "k".
WeightUnit (String)
The unit representing the item's Weight.
DimensionUnit (String)
The unit representing the item's Length, Width, and Height. The default is the standard weight unit for your country.

Request body formats

application/json, text/json

Sample:
{
  "key": "939619d0-e3e2-42ff-8f10-87db10ba5475",
  "SKUs": [
    {
      "SKU": "Product123",
      "ProductName": "Concise description of the item",
      "Attribute1": "optional attribute",
      "Attribute2": "optional attribute",
      "Attribute3": "optional attribute",
      "Attribute4": "optional attribute",
      "Attribute5": "optional attribute",
      "Attribute6": "optional attribute",
      "HSCodeUS": "123456",
      "HSCodeCA": null,
      "CountryOfOrigin": "CN",
      "CurrentPrice": 12.34,
      "ProductURL": "http://example.com/product123",
      "Weight": 2.0,
      "SKN": "p123",
      "Length": 1.0,
      "Width": 1.0,
      "Height": 1.0,
      "ShipAlone": false,
      "BatteryType": null,
      "Delete": false,
      "WeightInKilos": false,
      "WeightUnit": null,
      "DimensionUnit": null
    }
  ]
}

application/xml, text/xml

Sample:
<SubmitCatalogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary">
  <SKUs xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models">
    <d2p1:CatalogSKUInfo>
      <d2p1:Active i:nil="true" />
      <d2p1:AssignedBy i:nil="true" />
      <d2p1:AssignedTo i:nil="true" />
      <d2p1:AssignedWhen i:nil="true" />
      <d2p1:Attribute1>optional attribute</d2p1:Attribute1>
      <d2p1:Attribute2>optional attribute</d2p1:Attribute2>
      <d2p1:Attribute3>optional attribute</d2p1:Attribute3>
      <d2p1:Attribute4>optional attribute</d2p1:Attribute4>
      <d2p1:Attribute5>optional attribute</d2p1:Attribute5>
      <d2p1:Attribute6>optional attribute</d2p1:Attribute6>
      <d2p1:BatteryType i:nil="true" />
      <d2p1:CSID i:nil="true" />
      <d2p1:CompanyId>0</d2p1:CompanyId>
      <d2p1:Completed>false</d2p1:Completed>
      <d2p1:CompletedBy i:nil="true" />
      <d2p1:CompletedDate i:nil="true" />
      <d2p1:CountryCode i:nil="true" />
      <d2p1:CountryOfOrigin>CN</d2p1:CountryOfOrigin>
      <d2p1:CurrentPrice>12.34</d2p1:CurrentPrice>
      <d2p1:Delete>false</d2p1:Delete>
      <d2p1:DimensionUnit i:nil="true" />
      <d2p1:EnteredBy i:nil="true" />
      <d2p1:EnteredDate i:nil="true" />
      <d2p1:HSCode i:nil="true" />
      <d2p1:HSCodeCA i:nil="true" />
      <d2p1:HSCodeUS>123456</d2p1:HSCodeUS>
      <d2p1:Height>1</d2p1:Height>
      <d2p1:Length>1</d2p1:Length>
      <d2p1:MerchantName i:nil="true" />
      <d2p1:ProductName>Concise description of the item</d2p1:ProductName>
      <d2p1:ProductURL>http://example.com/product123</d2p1:ProductURL>
      <d2p1:RequestDate i:nil="true" />
      <d2p1:SKN>p123</d2p1:SKN>
      <d2p1:SKU>Product123</d2p1:SKU>
      <d2p1:ShipAlone>false</d2p1:ShipAlone>
      <d2p1:Uploaded i:nil="true" />
      <d2p1:Weight>2</d2p1:Weight>
      <d2p1:WeightInKilos>false</d2p1:WeightInKilos>
      <d2p1:WeightUnit i:nil="true" />
      <d2p1:Width>1</d2p1:Width>
    </d2p1:CatalogSKUInfo>
  </SKUs>
  <key>939619d0-e3e2-42ff-8f10-87db10ba5475</key>
</SubmitCatalogRequest>