List a variant's inventory history
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1/inventory-history?limit=50';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1/inventory-history?limit=50' \ --header 'x-api-key: <x-api-key>'Returns the variant’s stock adjustments, newest first, each with the quantity changed and the stock before and after.
Required scopes: read:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The variant ID.
The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Maximum number of adjustments to return. Defaults to 50 and is capped at 200.
Responses
Section titled “Responses”object
Kind of change: deduct, restore, reserve, release or adjustment.
Why the stock changed, such as manual_adjustment or order_placed.
Adjustment ID.
ID of the variant.
Number of units changed (always positive).
Stock before the change.
Stock after the change.
ID of the related record, such as an order, or null.
Type of the related record, or null.
Free-text note, or null.
Who made the change, or null for the system.
When the change happened, as an ISO 8601 timestamp.
Example
[ { "transaction_type": "deduct", "reason": "order_placed" }]The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}