Default

Get Product List

get

Returns a list of products with pagination, filtering (facets), and sorting (sorters).

Query parameters

formatstring · enumOptional

Response format (must be json)

Default: jsonPossible values:

Responses

200

Successful response with product list

application/json

get

HTTPcURLJavaScriptPython

GET /list/ HTTP/1.1
Host: example.com
Accept: */*

200

Successful response with product list

{
  "in_stock": true,
  "product": {
    "pk": 1,
    "name": "text",
    "sku": 1,
    "base_code": "text",
    "attributes": {},
    "attribute_set": 1,
    "attributes_kwargs": {},
    "extra_attributes": {},
    "productimage_set": [
      {}
    ],
    "price": 1,
    "in_stock": true,
    "currency_type": "text",
    "retail_price": 1,
    "unit_type": "text",
    "absolute_url": "text",
    "productvideo_set": [
      {}
    ],
    "product_type": 1,
    "price_type": "text",
    "form_schema": null,
    "is_ready_to_basket": true,
    "stock": 1,
    "data_source": null,
    "basket_offers": [
      {
        "pk": 1,
        "label": "text",
        "listing_kwargs": {},
        "kwargs": {
          "show_benefit_products": true
        }
      }
    ]
  },
  "variants": [
    {
      "attribute_key": "text",
      "attribute_name": "text",
      "options": [
        {
          "is_selected": true,
          "is_selectable": true,
          "is_selectable_without_stock": true,
          "in_stock": true,
          "order": 1,
          "label": "text",
          "value": "text",
          "product": {}
        }
      ]
    }
  ],
  "selected_variant": {}
}