Get Product Inventory Detail

GET 
/openapi/2022-01/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 string

Warehouse address id

Responses

200

200

application/json

Schema

Schema

product_idstring
Example: f854e9a2-986d-4e2b-9df0-8e4c139ae80e
variants object[]
Array [
variant_idstring
Example: 5723299f-238a-4491-8b42-a187462e748a
location_items object[]
Array [
location_idinteger
Default value: 0
Example: 327627904831724000
stockinteger
Default value: 0
Example: 1
]
]

Example

{
  "product_id": "f854e9a2-986d-4e2b-9df0-8e4c139ae80e",
  "variants": [
    {
      "variant_id": "5723299f-238a-4491-8b42-a187462e748a",
      "location_items": [
        {
          "location_id": 327627904831724000,
          "stock": 1
        }
      ]
    }
  ]
}

Result

{
    "product_id": "f854e9a2-986d-4e2b-9df0-8e4c139ae80e",
    "variants": [
        {
            "variant_id": "5723299f-238a-4491-8b42-a187462e748a",
            "location_items": [
                {
                    "location_id": 327627904831724058,
                    "stock": 1
                }
            ]
        }
    ]
}

500

500

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "invalid UUID length: 10"
  ]
}

Result

{
  "errors": [
    "invalid UUID length: 10"
  ]
}