List basket offers

Returns a paginated list of basket offers.

Results are ordered by urgency: offers with an end date in the future come first (soonest-ending first), followed by offers without an end date, and finally offers whose end date has already passed.

The most commonly used filters are documented below. The nested promotion, condition, and benefit objects are also filterable through double-underscore traversal (for example promotion__name=summer or benefit__benefit_type=percentage); text fields 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

/basket_offers/

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

labelstringOptional

Filter by label, case-insensitive partial match.

priorityintegerOptional

Filter by exact priority value.

is_visiblebooleanOptional

Filter by storefront visibility flag.

is_available_for_data_sourcesbooleanOptional

Filter by the data-source availability flag.

userintegerOptional

Filter by the identifier of the user the offer is assigned to.

user__isnullbooleanOptional

When true, returns only offers without an assigned user; when false, only offers assigned to a user.

user__qstringOptional

Free-text user search. Matches offers whose user's first name or last name contains the given value, or whose email equals it exactly.

voucher_codestringOptional

Filter by exact voucher code. The lookups voucher_code__contains, voucher_code__startswith, and voucher_code__endswith are also available for partial matching.

voucher_code__isnullbooleanOptional

When true, returns only offers without a voucher code; when false, only offers that have one.

start_datetimestring · date-timeOptional

Filter by exact campaign start date-time. The lookups start_datetime__gt, start_datetime__gte, start_datetime__lt, and start_datetime__lte are also available for range filtering.

end_datetimestring · date-timeOptional

Filter by exact campaign end date-time. The lookups end_datetime__gt, end_datetime__gte, end_datetime__lt, and end_datetime__lte are also available for range filtering.

modified_date__gtestring · date-timeOptional

Filter for offers modified on or after the given date-time. The lookups modified_date__gt, modified_date__lt, and modified_date__lte are also available.

promotionintegerOptional

Filter by the identifier of the nested promotion.

conditionintegerOptional

Filter by the identifier of the nested condition.

benefitintegerOptional

Filter by the identifier of the nested benefit.

Responses

200

A page of basket offers.

application/json

A page of basket offer results.

countintegerOptional

The total number of basket offers 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.

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

get/basket_offers/

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "label": null,
      "promotion": {
        "pk": 1,
        "name": "text",
        "slug": "text"
      },
      "condition": {
        "pk": 1,
        "condition_type": "distinct",
        "product_collection": null,
        "upsell_message": "text",
        "kwargs": {}
      },
      "benefit": {
        "pk": 1,
        "benefit_type": "multibuy",
        "product_collection": null,
        "kwargs": {}
      },
      "status": "active",
      "offer_type": "sitewide",
      "voucher_code": null,
      "user": null,
      "is_visible": true,
      "is_visible_on_list": false,
      "start_datetime": null,
      "end_datetime": null,
      "priority": 0,
      "is_mergable": true,
      "allowed_quantity_per_basket": 1,
      "max_usage_per_user": 0,
      "max_stock_limit": null,
      "currencies": [
        "try"
      ],
      "is_available_for_data_sources": false,
      "kwargs": null,
      "start_timedelta": null,
      "end_timedelta": null,
      "activation_timedelta": null,
      "activation_date": null,
      "bulk_coupon_file": "text",
      "bulk_email_file": null,
      "bulk_phone_number_file": null,
      "pk": 1,
      "modified_date": "2026-01-01T00:00:00.000Z",
      "remaining_stock_limit": 1
    }
  ]
}