/inventory-items/

get

http://app.shippingtree.co/api/inventory-items/

List the authenticated company's current Inventory Items. Results include stored on-hand and reserved counts, product details, warehouse and location information, optional container LPN, and lot-control fields. updated_after filters on InventoryItem.updated; changes only to related location, container, product, or warehouse data may not change that timestamp. This resource is read-only and requires X-API-KEY authentication.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

after_id

string

Cursor-based forward pagination. Returns only records with id strictly greater than the given value. Use the id of the last record in the previous page to fetch the next page.

before_id

string

Cursor-based backward pagination. Returns only records with id strictly less than the given value. Use the id of the first record in the current page to fetch the previous page.

created_after

string

Return records created on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

created_before

string

Return records created on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

updated_after

string

Return records updated on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

updated_before

string

Return records updated on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

warehouse

string

sku

string

lot_number

string

manufacture_date_after

date

Return inventory manufactured on or after this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

manufacture_date_before

date

Return inventory manufactured on or before this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

best_before_date_after

date

Return inventory with a best-before date on or after this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

best_before_date_before

date

Return inventory with a best-before date on or before this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

expiry_date_after

date

Return inventory expiring on or after this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

expiry_date_before

date

Return inventory expiring on or before this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

received_date_after

date

Return inventory received on or after this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

received_date_before

date

Return inventory received on or before this date. Accepts ISO 8601 date format (e.g. 2024-01-15).

inventory_type

string

ordering

string

Sort results by one or more fields. Allowed fields: id, created, updated, on_hand, reserved, received_date, expiry_date, inventory_type. Prefix with - for descending order (e.g. -created). Default: -created, -id.

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Response

200