List shipping options

Returns a paginated list of shipping options. Results are returned in the language resolved for the current request, falling back to the default language when no translation exists for the active language.

get

/shipping_options/

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

pkintegerOptional

Filter by the exact identifier of a shipping option.

pk__instringOptional

Filter by a comma-separated list of identifiers. Returns only shipping options whose identifier is in the list.

Example: 1,2,3

namestringOptional

Filter by name. Case-insensitive partial match.

slugstringOptional

Filter by slug. Case-insensitive partial match.

is_activebooleanOptional

Filter by active status.

sort_orderintegerOptional

Filter by exact sort order value.

descriptionstringOptional

Filter by exact description.

Responses

200

A page of shipping options.

application/json

A paginated list of shipping options.

countintegerOptional

Total number of shipping options.

nextstring · nullableOptional

URL of the next page, or null if this is the last page.

previousstring · nullableOptional

URL of the previous page, or null if this is the first page.

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

get/shipping_options/

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 1,
      "name": "Free Shipping",
      "slug": "free-shipping",
      "is_active": true,
      "calculator": {
        "slug": "free-calculator"
      },
      "rule": {
        "slug": "any-rule"
      },
      "sort_order": 0,
      "description": null,
      "kwargs": {
        "required_fields": []
      },
      "delivery_type": {
        "value": "standard",
        "label": "Standard"
      }
    }
  ]
}