younifyd
Menu

List Stock

Get Stock for all Products

GET/inventories

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Stock action (under Inventory).
  3. Fill in the fields below, then reference the result from later steps as {{listStock.response.data}}.

Request

Query parameters

page[offset]integer (int)

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**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

page[limit]integer (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**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

filterstring (string)

Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

Response

Returns 200 with an object. Read it in later steps with {{listStock.response.data.<field>}}.

dataarray<object>
idstringrequired

The unique identifier.

typestringrequired

One ofstockDefault "stock"

attributesobjectrequired4 fields
metaobjectrequired2 fields
linksobject
json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "stock",
      "attributes": {
        "available": 20,
        "allocated": 10,
        "total": 30,
        "locations": {}
      },
      "meta": {
        "stock_id": "00000000-0000-0000-0000-000000000000",
        "timestamps": {
          "created_at": "2017-01-10T11:41:19.244842Z",
          "updated_at": "2017-01-10T11:41:19.244842Z"
        }
      }
    }
  ],
  "links": {}
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.