For the complete documentation index, see llms.txt. This page is also available as Markdown.

List products

Returns a paginated list of products. You filter, order, and page through the catalog using query parameters.

The most commonly used filters are documented below and behave exactly as described for each parameter. Beyond these, a filter is automatically available for most other product fields: text fields (such as the product name) match on a case-insensitive partial match, while the remaining fields match exactly.

Results are returned inside a pagination envelope that reports the total count and links to the next and previous pages.

get
/products/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters
pageintegerOptional

The page number to return.

Default: 1
limitintegerOptional

The number of items to return per page.

Default: 10
sortstringOptional

Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.

Example: -id
idintegerOptional

Filter by exact product identifier.

id__gtintegerOptional

Filter for products with an identifier greater than the given value.

id__gteintegerOptional

Filter for products with an identifier greater than or equal to the given value.

id__ltintegerOptional

Filter for products with an identifier less than the given value.

id__lteintegerOptional

Filter for products with an identifier less than or equal to the given value.

id__instringOptional

Filter by a comma-separated list of product identifiers.

Example: 12,34,56
pk__instringOptional

Filter by a comma-separated list of product identifiers.

Example: 12,34,56
skustringOptional

Filter by exact stock keeping unit (SKU).

sku__exactstringOptional

Filter by exact stock keeping unit (SKU).

sku__instringOptional

Filter by a comma-separated list of SKUs.

Example: SKU-1,SKU-2
base_codestringOptional

Filter by exact base code.

base_code__exactstringOptional

Filter by exact base code.

Responses
200

A paginated list of products.

application/json

A page of product results.

countintegerOptional

The total number of products matching the query.

nextstring · nullableOptional

The URL of the next page of results, when available.

previousstring · nullableOptional

The URL of the previous page of results, when available.

get/products/
GET /api/remote/1/products/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 1,
      "name": "text",
      "base_code": null,
      "sku": "text",
      "product_type": "-1",
      "is_active": true,
      "parent": null,
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "attributes_kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "extra_attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "is_seller_product": true,
      "group_products": [
        1
      ],
      "productimage_set": [
        {
          "pk": 1,
          "status": "text",
          "image": "text",
          "order": 1,
          "created_date": "2026-01-01T00:00:00.000Z",
          "specialimage_set": [
            {}
          ]
        }
      ],
      "attribute_set": 1,
      "custom_attribute_set": null,
      "is_listable": true,
      "listing_code": null,
      "data_source": null,
      "absolute_url": null,
      "is_form_required": true
    }
  ]
}

Last updated

Was this helpful?