List active simple products with pricing and stock

Returns a paginated list of active simple products enriched with price, stock, currency, main category, and variant attribute values.

Fixed filters applied by the server:

• Only products with is_active = true are returned.

• Only products with product_type = simple (code 0) are returned.

• Results are ordered by pk ascending.

Segment-aware pricing and stock: Pass the optional segment query parameter to retrieve prices and stock quantities from the price list and stock list associated with that segment. When segment is omitted or does not match a known segment, the product's default price and stock are returned; price will be "0.00" if the product has no entry on the requested price list.

Filtering: Use the filter parameters below to narrow the result set. Multiple values can be passed for pk__in and sku__in as comma-separated lists.

get

/products_advanced/

Authorizations

AuthorizationstringRequired

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

Query parameters

segmentintegerOptional

ID of a segment whose price list and stock list should be used to resolve price, currency, and stock for each product.

When omitted, the product's default price list and stock list are used.

Example: 5

idintegerOptional

Filter by exact product ID.

id__gtintegerOptional

Filter products whose ID is greater than the given value.

id__gteintegerOptional

Filter products whose ID is greater than or equal to the given value.

id__ltintegerOptional

Filter products whose ID is less than the given value.

id__lteintegerOptional

Filter products whose ID is less than or equal to the given value.

id__instringOptional

Filter by a comma-separated list of product IDs.

Example: 1,2,3

pk__instringOptional

Filter by a comma-separated list of product IDs. Equivalent to id__in.

Example: 1,2,3

skustringOptional

Filter by exact SKU.

Example: SHOE-RUN-BLU-42

sku__exactstringOptional

Filter by exact SKU. Equivalent to sku.

Example: SHOE-RUN-BLU-42

sku__instringOptional

Filter by a comma-separated list of SKUs.

Example: SHOE-RUN-BLU-42,SHOE-RUN-RED-42

base_codestringOptional

Filter by exact base code.

Example: SHOE-RUN-BLU

base_code__exactstringOptional

Filter by exact base code. Equivalent to base_code.

Example: SHOE-RUN-BLU

pageintegerOptional

The page number to return.

Default: 1

limitintegerOptional

The number of items to return per page.

Default: 10

Responses

200

A paginated list of products.

application/json

Paginated list of advanced product representations.

countintegerRequired

Total number of products matching the current filters.

Example: 150

nextstring · nullableOptional

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

previousstring · nullableOptional

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

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

get/products_advanced/

GET /api/remote/1/products_advanced/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 150,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 12345,
      "name": "Premium Running Shoes - Blue/White",
      "base_code": "SHOE-RUN-BLU",
      "sku": "SHOE-RUN-BLU-42",
      "product_type": "-1",
      "is_active": true,
      "price": "149.99",
      "currency": "try",
      "stock": 25,
      "category": "Running Shoes",
      "product_image": "https://cdn.akinon.com/products/shoe-main.jpg",
      "variants": {
        "Color": "Blue",
        "Size": "42"
      }
    }
  ]
}