Sign in
latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Warehouse Products API

Get a list of your warehouse products

Returns a list of warehouse products from your store

<div class="alert alert-info"> The response for this endpoint was documented as paginated, although it was not paginated. The behavior will be fixed and the paginated result will be set as the default. Currently to get paginated results please send <code>true</code>or <code>1</code> in <code>X-PF-Force-Pagination</code> header. </div>
get/warehouse/products

Query parameters

querystring

Filter by partial or full product name

limitinteger

Number of items per page (max 100)

offsetinteger

Result set offset

Headers

boolean
OR
integer

Whether the pagination behavior should be forced. The response will be paginated if the value is true or 1.

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

OK

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
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "total": 100,
    "offset": 10,
    "limit": 100
  }
}