Inventory

List inventory items

Get a paginated list of inventory items for the current merchant or service provider.

GET/inventory

Parameter	Type	Examples	Description
`q` Optional	string	`widget`	A search query to filter items by title, SKU, identifier, tag, or condition
`ids` Optional	array<integer>		Filter items by a list of item IDs
`merchant_skus` Optional	array<string>		Filter items by a list of merchant SKUs
`tag_ids` Optional	array<integer>		Filter items by a list of tag IDs
`available_quantity_gt` Optional	integer		Filter items with available quantity greater than this value
`available_quantity_lt` Optional	integer		Filter items with available quantity less than this value
`quantity_in_stock_gt` Optional	integer		Filter items with quantity in stock greater than this value
`quantity_in_stock_lt` Optional	integer		Filter items with quantity in stock less than this value
`missing_dimensions_only` Optional	boolean		When true, only return items missing dimension data
`sort_by` Optional	string		The field to sort results by
`sort_dir` Optional	string		The sort direction
`page` Optional	integer	`1`	The page number to retrieve (1-indexed)
`per_page` Optional	integer	`15`	The number of items per page

Create a new inventory item for the current merchant.

POST/inventory

Parameter	Type	Examples	Description
`merchant_sku` Required	string	`WIDGET-001`	The merchant's own SKU for this item
`title` Required	string	`Blue Widget`	The title or name of the item
`condition` Optional	string	`new`	The condition of the item
`condition_note` Optional	string	`Minor cosmetic damage`	Additional notes about the condition
`length_mm` Optional	integer	`150`	The length in millimetres
`width_mm` Optional	integer	`100`	The width in millimetres
`height_mm` Optional	integer	`50`	The height in millimetres
`weight_gm` Optional	integer	`500`	The weight in grams

Search for inventory items using a text query and optional filters.

POST/inventory/search

Parameter	Type	Examples	Description
`q` Required	string	`blue widget`	The search query string
`mode` Optional	string	`default`	The search mode to use. Defaults to 'default'.
`filters` Optional	object		Optional filters to apply to the search

Get a single inventory item by its ID.

GET/inventory/{item}

Parameter	Type	Examples	Description
`item` Required	integer	`1`	The ID of the inventory item

Update an existing inventory item.

PUT/inventory/{item}

Parameter	Type	Examples	Description
`item` Required	integer	`1`	The ID of the inventory item
`title` Optional	string	`Blue Widget`	The title or name of the item
`condition` Optional	string	`new`	The condition of the item
`condition_note` Optional	string	`Minor cosmetic damage`	Additional notes about the condition
`length_mm` Optional	integer	`150`	The length in millimetres
`width_mm` Optional	integer	`100`	The width in millimetres
`height_mm` Optional	integer	`50`	The height in millimetres
`weight_gm` Optional	integer	`500`	The weight in grams

Add a new identifier (ASIN, EAN, UPC, FNSKU, GTIN, or CUSTOM) to an inventory item.

POST/inventory/{item}/identifier

Parameter	Type	Examples	Description
`item` Required	integer	`1`	The ID of the inventory item
`identifier_type` Required	string	`ASIN`	The type of identifier to add
`identifier` Required	string	`B0001234AB`	The identifier value

Sync the company services associated with an inventory item.

POST/inventory/services

Parameter	Type	Examples	Description
`item_id` Required	integer	`1`	The ID of the inventory item
`services` Required	array<integer>	`[1,2,3]`	The list of company service IDs to associate with the item