latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Warehouse Products API

Get warehouse product data

Returns warehouse product data by ID

get/warehouse/products/{id}

Path parameters

integer required

string required

Product ID

Headers

X-PF-Store-Idstring

Use this to specify which store you want to use (required only for account level token).

The store IDs can be retrieved with the Get basic information about stores endpoint.

Response

codeinteger

Response status code 200

Example response

{
  "code": 200,
  "result": {
    "id": 12,
    "name": "Some product name",
    "status": "draft",
    "currency": "USD",
    "image_url": "url.to/your/image/location.png",
    "retail_price": 12.99,
    "variants": [
      {
        "id": 12,
        "name": "SomeName",
        "sku": "some-sku-12",
        "image_url": "url.to/image/variant.png",
        "retail_price": 1.1,
        "quantity": 10,
        "length": 3.21,
        "width": 2.13,
        "height": 3.11,
        "weight": 1.11,
        "stock_locations": [
          {
            "facility": "Charlotte Steele Point, United States",
            "stocked": 10,
            "available": 10
          }
        ]
      }
    ]
  }
}