Get Product Stock

Get Stock for Product

GET/inventories/{product_uuid}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get Product Stock action (under Inventory (Legacy)).
Fill in the fields below, then reference the result from later steps as {{getProductStock.response.data}}.

Request

Path parameters

product_uuidstringrequired

The unique identifier of the product.

Response

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

dataobject

idstringrequired

The unique identifier of the product.

stock_idstring

The Stock ID of a product, or empty if the product ID matches the Stock ID

typestringrequired

The type represents the object being returned. Always `stock`.

One ofstockDefault "stock"

totalinteger (int64)required

The total amount of stock we have.

availableinteger (int64)required

The amount of stock available for purchase.

allocatedinteger (int64)required

The amount of paid for stock, also known as **reserved**.

metaany

json

{
  "data": {
    "id": "f976dace-450f-4a5d-8877-d119c5a550a1",
    "type": "stock",
    "total": 100,
    "available": 75,
    "allocated": 25,
    "stock_id": "ce9049af-bba2-4db2-8118-5df5268184c7",
    "meta": null
  },
  "meta": null
}

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

Was this page helpful?