Inventory

Making calls to the inventory API

Merchant Header Required

For any call on this page, you are required to set the merchant using the Merchant Header.

Index

Get a list of all inventory items. Returns up to 500 items in a single call, using Pagination.

GET/inventory

Example Response

View

See the details for a specific inventory item.

GET/inventory/{ITEM_ID}

Example Response

Search

The inventory search API allows you to search for items with a single parameter that filters by title, SKU, and any identifiers that are attached to the item (such as FNSKU, ASIN, or EAN). 10 items or less matching the title or SKU plus any items with matching identifiers are returned in a single calls.

POST/inventory/search

Parameter	Type	Examples	Description
`q` Optional	string	`X00CGJI1G66`	Search query

Example Response

Create

The inventory create API allows to create a new item within a merchant's inventory.

POST/inventory

Parameter	Type	Examples	Description
`merchant_sku` Required	string	`ABC-123`	(required) The SKU for the item. Min 3 characters, max 255 characters. The SKU must be unique for the merchant.
`title` Required	string	`Brilliant Gemstone`	(required) The title for the item. Min 3 characters, max 255 characters.
`condition` Optional	string	`new`	The condition of the item. The list of possible conditions are the same as Amazon's values.
`condition_note` Optional	string	`new`	Notes on the condition of the item
`asin` Optional	string	`B00X4WHP5E`	The Amazon ASIN for the item.

Example Response

Update

The inventory update API allows you to update an existing item.

PUT/inventory/{ITEM_ID}

Parameter	Type	Examples	Description
`length_mm` Required	integer	`140`	(required) The length of the item in millimeters. Min 1, max 500000.
`width_mm` Required	integer	`140`	(required) The width of the item in millimeters. Min 1, max 500000.
`height_mm` Required	integer	`140`	(required) The height of the item in millimeters. Min 1, max 500000.
`weight_gm` Required	integer	`240`	(required) The weight of the item in grams. Min 1, max 500000.

Example Response

Add Identifier

The add identifier endpoint allows you to add an identifier to an existing item.

POST/inventory/{ITEM_ID}/identifier

Parameter	Type	Examples	Description
`identifier` Required	string	`123456789012`	(required) The identifier for the item. The value should be the UPC, EAN, FNSKU, ASIN, or CUSTOM identifier for the item. The validation for each identifier is as follows: UPC: 12 digits, EAN: 13 digits, FNSKU: 10 characters, ASIN: 10 characters, CUSTOM: 1-255 characters.
`identifier_type` Required	string	`UPC`	(required) The type of identifier for the item. The list of possible values are: UPC, EAN, FNSKU, ASIN, CUSTOM.

Example Response

Add Service

The add services endpoint allows you to add services to an existing item.

POST/inventory/services

Parameter	Type	Examples	Description
`item_id` Required	int	`14`	(required) The primary key for the item you want to add services to.
`services` Required	array	`See services.* for ids example`	(required) An array of ids associated with the services you would like to add to the item.
`services.*` Required	int	`1`	(required) The ID for the service you would like to add to the item.