List bulk voucher codes

Returns a paginated list of bulk voucher codes, newest first (descending identifier).

The most commonly used filters are documented below. Beyond these, a filter is automatically available for most other fields of the code record: 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

/bulk_voucher_codes/

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

basket_offerintegerOptional

Filter by the identifier of the parent basket offer. This is the primary filter for listing the codes of a single campaign.

codestringOptional

Filter by code value, case-insensitive partial match.

userintegerOptional

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

user__emailstringOptional

Filter by the email address of the user the code is assigned to.

orderintegerOptional

Filter by the identifier of the order the code was redeemed on.

Responses

200

A page of bulk voucher codes.

application/json

A page of bulk voucher code results.

countintegerOptional

The total number of voucher codes 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/bulk_voucher_codes/

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 1041,
      "code": "KOTON9AB3FF76",
      "basket_offer": 35763,
      "status": "active",
      "user": 20518,
      "user_email": "[e-mail]"
    }
  ]
}