List inventory

Retrieve a list of inventory items for the specified retailer.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retailer_id · integer · required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Example:

1001

Response

200 - application/json

OK

count · integer · required

Total number of records

Example:

2231

results · object[] · required

Show child attributes

results. inventory · integer · required

Inventory level associated with the record

Required range: -2147483648 <= x <= 2147483647

Example:

50

results. id · integer

Unique identifier for the inventory history record

Example:

9876

results. updated_at · string

Timestamp of when this inventory record was updated

Example:

"2024-04-18T14:22:00Z"

results. event · string

Type of event that caused the inventory change (e.g., restock, sale)

Example:

"restock"

results. location · string

Inventory location where the event occurred

Example:

"Main Warehouse"

results. user · string

User responsible for the inventory update

Example:

"[e-mail]"

next · string | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=2"

previous · string | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=1"