List shipping option groups

Returns a paginated list of shipping option groups — the shipping cost line items attached to orders.

get

/shipping_option_groups/

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 shipping option group identifier.

pkintegerOptional

Filter by the exact identifier of a shipping option group. Equivalent to id.

pk__instringOptional

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

Example: 1,2,3

orderintegerOptional

Filter by the identifier of the order the group's covered order items belong to.

order_itemintegerOptional

Filter by the identifier of a specific order item covered by the group.

Responses

200

A page of shipping option groups.

application/json

A paginated list of shipping option groups.

countintegerOptional

Total number of shipping option groups.

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_option_groups/

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 1,
      "amount": "9.99",
      "created_date": "2026-01-15T10:32:00Z",
      "modified_date": "2026-01-15T10:32:00Z",
      "shipping_option": {
        "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"
        }
      },
      "order_items": [
        501,
        502
      ]
    }
  ]
}