Get Stock for all Products

GET 
https://euwest.api.elasticpath.com/v2/inventories

Returns all products and their associated stock.

Request

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

200

Success. All products and their stock values are returned

application/json

Schema

Schema

data Inventory[]
Array [
idstringrequired
The unique identifier of the product.
Example: f976dace-450f-4a5d-8877-d119c5a550a1
stock_idstring
The Stock ID of a product, or empty if the product ID matches the Stock ID
Example: ce9049af-bba2-4db2-8118-5df5268184c7
typestringrequired
The type represents the object being returned. Always stock.
Possible values: [stock]
Default value: stock
Example: stock
totalint64required
The total amount of stock we have.
Example: 100
availableint64required
The amount of stock available for purchase.
Example: 75
allocatedint64required
The amount of paid for stock, also known as reserved.
Example: 25
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
]
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

Example (auto)

{
  "data": [
    {
      "id": "f976dace-450f-4a5d-8877-d119c5a550a1",
      "stock_id": "ce9049af-bba2-4db2-8118-5df5268184c7",
      "type": "stock",
      "total": 100,
      "available": 75,
      "allocated": 25,
      "meta": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  ],
  "meta": {
    "updated_at": "2017-01-10T11:41:19.244842Z",
    "created_at": "2017-01-10T11:41:19.244842Z"
  }
}

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 stock 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");
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

page[offset] — query

page[limit] — query

ResponseClear

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