Skip to main content

Get Stock Transactions for Product

GET 

https://euwest.api.elasticpath.com/v2/inventories/:product_uuid/transactions

Returns the transactions recorded for the specified product.

Request

Path Parameters

    product_uuid UUIDrequired

    The unique identifier of the product.

Query Parameters

    page[offset] int

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the page length store setting is used.

Responses

Success. Returns the stock for the given product

Schema
    meta Meta
    updated_atstring

    The date and time a resource was updated.

    Example: 2017-01-10T11:41:19.244842Z
    created_atstring

    The date and time a resource was created.

    Example: 2017-01-10T11:41:19.244842Z
    data Transaction[]
  • Array [
  • idstring

    The unique identifier for the stock transaction.

    Example: f976dace-450f-4a5d-8877-d119c5a550a1
    typestringrequired

    The type represents the object being returned. Always stock-transaction.

    Possible values: [stock-transaction]

    Default value: stock-transaction
    Example: stock-transaction
    actionstring

    The type of action performed by this transaction.

    • increment - use this when you want to make products available for purchase, for example, when you have received stock from a supplier.

    • decrement - Use this when you want to remove stock from product inventory.

    • allocate - Use this when you want to allocate stock, normally to a reseller who sells on the stock.

    • deallocate - Use this when you want to deallocate any previously allocated stock.

    Possible values: [increment, decrement, allocate, deallocate]

    Example: allocate
    product_idstring

    The product identifier that this stock transaction is for.

    Example: 86b84d3e-0a86-43d6-a347-78ba4adacca2
    quantityint64

    The amount of stock affected by the stock transaction.

    Example: 5
    timestamps Timestamps
    updated_atstring

    The date and time a resource was updated.

    Example: 2017-01-10T11:41:19.244842Z
    created_atstring

    The date and time a resource was created.

    Example: 2017-01-10T11:41:19.244842Z
  • ]

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/inventories/:product_uuid/transactions");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com/v2
Auth
Parameters
— pathrequired
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!