Inventory

GET/inventory

List inventory items

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

Optional attributes

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

Request

GET/inventory

curl -G https://YOUR_DOMAIN/api/inventory \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

Loading response...

POST/inventory

Create an inventory item

Create a new inventory item for the current merchant.

Required attributes

Name
merchant_sku
Type
string
Description
The merchant's own SKU for this item WIDGET-001
Name
title
Type
string
Description
The title or name of the item Blue Widget

Optional attributes

Name
condition
Type
string
Description
The condition of the item new
Name
condition_note
Type
string
Description
Additional notes about the condition Minor cosmetic damage
Name
length_mm
Type
integer
Description
The length in millimetres 150
Name
width_mm
Type
integer
Description
The width in millimetres 100
Name
height_mm
Type
integer
Description
The height in millimetres 50
Name
weight_gm
Type
integer
Description
The weight in grams 500

Request

POST/inventory

curl -X POST https://YOUR_DOMAIN/api/inventory \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "merchant_sku": "WIDGET-001",
    "title": "Blue Widget",
    "condition": "new",
    "condition_note": "Minor cosmetic damage",
    "length_mm": 150,
    "width_mm": 100,
    "height_mm": 50,
    "weight_gm": 500
}'

Loading response...

POST/inventory/search

Search inventory items

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

Required attributes

Name
q
Type
string
Description
The search query string blue widget

Optional attributes

Name
mode
Type
string
Description
The search mode to use. Defaults to 'default'. default
Name
filters
Type
object
Description
Optional filters to apply to the search

Request

POST/inventory/search

curl -X POST https://YOUR_DOMAIN/api/inventory/search \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "blue widget",
    "mode": "default",
    "filters": {
        "condition_type": "new"
    }
}'

Loading response...

GET/inventory/{item}

Show an inventory item

Get a single inventory item by its ID.

Required attributes

Name
item
Type
integer
Description
The ID of the inventory item 1

Request

GET/inventory/{item}

curl -G https://YOUR_DOMAIN/api/inventory/{item} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

Loading response...

PUT/inventory/{item}

Update an inventory item

Update an existing inventory item.

Required attributes

Name
item
Type
integer
Description
The ID of the inventory item 1

Optional attributes

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

Request

PUT/inventory/{item}

curl -X PUT https://YOUR_DOMAIN/api/inventory/{item} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Blue Widget",
    "condition": "new",
    "condition_note": "Minor cosmetic damage",
    "length_mm": 150,
    "width_mm": 100,
    "height_mm": 50,
    "weight_gm": 500
}'

Loading response...

POST/inventory/{item}/identifier

Add an identifier to an inventory item

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

Required attributes

Name
item
Type
integer
Description
The ID of the inventory item 1
Name
identifier_type
Type
string
Description
The type of identifier to add ASIN
Name
identifier
Type
string
Description
The identifier value B0001234AB

Request

POST/inventory/{item}/identifier

curl -X POST https://YOUR_DOMAIN/api/inventory/{item}/identifier \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier_type": "ASIN",
    "identifier": "B0001234AB"
}'

Loading response...

POST/inventory/services

Manage services for an inventory item

Sync the company services associated with an inventory item.

Required attributes

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

Request

POST/inventory/services

curl -X POST https://YOUR_DOMAIN/api/inventory/services \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "item_id": 1,
    "services": [
        1,
        2,
        3
    ]
}'

Loading response...

DELETE/identifier/{identifier}

Delete an inventory item identifier

Delete an identifier (ASIN, EAN, UPC, FNSKU, GTIN, or CUSTOM) from an inventory item.

Required attributes

Name
identifier
Type
integer
Description
The ID of the inventory item identifier to delete 1

Request

DELETE/identifier/{identifier}

curl -X DELETE https://YOUR_DOMAIN/api/identifier/{identifier} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

Loading response...

POST/inventory/batch/delete

Batch delete inventory items

Delete multiple inventory items at once.

Required attributes

Name
items
Type
array<Item>
Description
The inventory items to delete
Name
items.*.id
Type
integer
Description
The ID of the inventory item to delete 1

Request

POST/inventory/batch/delete

curl -X POST https://YOUR_DOMAIN/api/inventory/batch/delete \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
        {
            "id": 1
        }
    ]
}'

Loading response...