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.

filter string

Responses

200

Success. Returns the stock for the given product

application/json

Schema

Schema

data object[]
Array [
idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
typeStockTransactionType (string)required
Possible values: [stock-transaction]
Default value: stock-transaction
Example: stock-transaction
attributes objectrequired
actionstringrequired
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_idUUID (string)required
The unique identifier.
Example: 00000000-0000-0000-0000-000000000000
quantityint64required
The amount of stock affected by the stock transaction.
Example: 5
locationstring
The slug of the location that the transaction should act on.
Possible values: non-empty and <= 128 characters
Example: milton-keynes-warehouse
meta object
timestamps Timestampsrequired
updated_atstring
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z
]
links object
property name* Link
anyOf
LinkURI
stringnullable
Example: http://example.com/articles/1/comments
LinkObject
hrefuri
Example: http://example.com/articles/1/comments
titlestring
Example: Comments
describedbyuri
Example: http://example.com/schemas/article-comments

Example (auto)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "stock-transaction",
      "attributes": {
        "action": "allocate",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "quantity": 5,
        "location": "milton-keynes-warehouse"
      },
      "meta": {
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z"
        }
      }
    }
  ],
  "links": {}
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "Your request was invalid"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No location found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors object[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

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

Bearer Token

Parameters

product_uuid — pathrequired

page[offset] — query

page[limit] — query

filter — query

ResponseClear

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