Inventory API migration guide
A new version V3 of the Inventory API is released, replacing the previous versions. Previous versions are now deprecated but will remain available until 31 May, 2023.
This document highlights the differences between the previous versions and V3 and supports the migration to V3.
Compared to older Inventory API versions, V3 provides a simpler and more secure way to read and write inventory data.
However, how inventories work remains the same. For example, the flow from
STORE
to SOLD
is the same as in older versions.By default, V3 allows 4 requests per second.
The rate limit is not a hard limit. V3 monitors and measures the average rate in a short time period continuously. Then it determines if requests will be blocked.
/V3
is added as top level prefix to the request paths.organizations/{organizationUuid}
is removed from the request paths. Instead, the organization is identified from the authentication data.
- The
/stock
endpoint is used to fetch data about inventory level, such as balances and low stock level settings. - The
/inventories
endpoint is used to fetch data about available inventories. - The
/products
endpoint is used to fetch data about tracked products.
All endpoints that return lists can be paginated.
To paginate, include the
Link
header from the current response in the request for next responses until the Link
header is no longer present in the response.See Pagination.
- The
/movements
endpoint is used to make changes on inventory balances. - The
/products
endpoint is used to enable and disable tracking products. - The
/custom-low-stock
endpoint is used to update custom low stock settings.
If you have any questions, please contact our developer support.