Get Stock for all Products

GET 
/inventories

Returns all products and their associated stock.

Request

Query Parameters

page[offset] int64

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] int64

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 [
id string
The unique identifier of the product.
type stringrequired
Possible values: [stock]
Default value: stock
The type represents the object being returned. Always stock.
total integer
The total amount of stock we have.
available integer
The amount of stock available for purchase.
allocated integer
The amount of paid for stock, also known as reserved.
]
links object
Links are used to allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Sometimes, there aren’t enough entities for a project to fill multiple pages. In this situation, we return some defaults, instead of expecting you as a consumer to check for these special cases.
Property	Description
current	Always the current page.
first	Always the first page.
last	null if there is only one page.
current uri
first uri
last uri
meta object

timestamps StockTimestamps

The date and time a stock was created and last updated.

created_at date-timerequired

The date and time the stock was created.

updated_at date-timerequired

The date and time the stock was last updated.

results object

The results for this response for the entire collection.

total integer

The total number of records for this response for the entire collection.

page object

limit integer

The maximum number of records per page for this response.

offset integer

The current offset by number of records per page for this response.

current integer

The current number of records for this response per page.

total integer

The total number of records for this response per page.

Example (from schema)

{
  "data": [
    {
      "id": "f976dace-450f-4a5d-8877-d119c5a550a1",
      "type": "stock",
      "total": 100,
      "available": 75,
      "allocated": 25
    }
  ],
  "links": {
    "current": "?page[offset]=0&page[limit]=25",
    "first": "?page[offset]=0&page[limit]=25",
    "last": "?page[offset]=0&page[limit]=25"
  },
  "meta": {
    "timestamps": {
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:32:28Z"
    },
    "results": {
      "total": 50
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 50
    }
  }
}

500

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

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

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

Loading...