Introduction

Key Terms#

Metric refers to the metric system of measurements in which dimensions
(length, width and height) are expressed in centimetres and weights in
kilograms - e.g. 12cm/1kg.


Imperial refers to the imperial system of measurements in which
dimensions are expressed in inches and weights in pounds - e.g. 6in/3lbs.


Marketplace means an online marketplace like Amazon or eBay.


Seller means an individual or business that sells products online.


Store means an online store operated by a seller on a marketplace.


Bundle means a group of products offered together on sale - e.g.
Set of 4 Solitaire Glasses or Keyboard and Mouse Bundle. A bundle
may contain multiple pieces of the same product or different pieces of
different products, in any combination. The process of packing multiple
products together to form a bundle is known as Bundling.


Item means a product or a bundle. Items are sellable.


SKU or Stock Keeping Unit means a unique code assigned to an
item. Many packaged products already carry an SKU in the form of a
product barcode. Sellers may refer to the SKU with different names such
as product code, part number, catalog number, EAN, GTIN,
UPC, ISBN, VIN, etc.


Prep, Item Prep or FBA Prep refer to the set of activities
to be performed on items to get them ready for sale on a store.
Prep activities usually include packing and labeling for most items,
and special actions like taping or bundling for certain types of items.


Prep Requirement or Prep Instruction refers to a particular prep
activity such as packing, labeling or taping. Not all marketplaces may
have the same prep requirements for the same item.


Prep Location refers to a storage location such as a warehouse that
can perform prep instructions on items on behalf of a seller. Sellers
usually store their items at prep locations and instruct the staff at
the location to carry out specific prep instructions for their items when
they are ready to dispatch the items to a marketplace.

General Tips#

a. Start with the Sandbox#

Users are encouraged to try out the APIs on our sandbox environment before
integrating with the live environment. This will help them familiarize with
common API elements, interaction patterns and responses.

b. Review field constraints#

Documentation for each API field includes applicable constraints such as
data type, permissible values and other guidance. When an error is
encountered, reviewing the field constraints normally helps in understanding
the root cause and taking necessary corrective actions.

c. Use the examples#

APIs that allow writing data come with multiple examples. Familiarization
with examples can help create mappings between your data to that expected
by the API.

d. Start small, build incrementally#

When pushing data using the APIs, start with the smallest data packet first,
ensure it works as expected and then build upon that.

Many APIs provide a Minimal example that shows the bare minimum data
required by that API. Users are strongly advised to start with this example
to ensure that basic interaction with the API works as expected.

Most APIs also provide a Recommended example. This example, which is more
comprehensive than the Minimal example, shows most common data elements for
that API.

Rate Limit#

Terms of Use#