Get product inventory

GET 
/openapi/2026-07/products/:product_id/inventory

Retrieves the inventory details of a product by its unique identifier (product_id).

Request

Path Parameters

product_id stringrequired

Product ID

Query Parameters

location_id uint64

Location to filter inventory details (optional) ID

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
product_idstring
Product ID
Stockint32
Product's inventory
variants object[]
List of variant objects containing inventory details
Array [
variant_idstring
Product variant ID
location_items object[]
Inventory details for each location
Array [
location_iduint64
Location ID
stockint32
Current stock quantity at the location
]
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "product_id": "string",
    "Stock": 0,
    "variants": [
      {
        "variant_id": "string",
        "location_items": [
          {
            "location_id": 0,
            "stock": 0
          }
        ]
      }
    ]
  }
}