Retrieve a shipping option group

Returns a single shipping option group by its identifier.

get

/shipping_option_groups/{id}/

Authorizations

AuthorizationstringRequired

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

Path parameters

idintegerRequired

The unique identifier of the shipping option group.

Responses

200

The requested shipping option group.

application/json

A shipping option group — the shipping cost line item attached to an order. Groups are created internally by the order pipeline when an order is placed, pairing the shipping_option that was selected with the final amount charged and the order items it covers. This resource is read-only; it cannot be created, updated, or deleted through this API.

pkintegerRequired

Unique identifier of the shipping option group.

amountstringRequired

Shipping cost charged for this group. Decimal with at most 12 total digits and 2 decimal places (i.e. up to 10 digits before the decimal point). Resolved by the shipping option's calculator at the time the order was placed; see the Dynamic Settings & Environment Variables section for the settings that influence how it was computed.

Example: 9.99

created_datestring · date-timeRequired

When the group was created.

Example: 2026-01-15T10:32:00Z

modified_datestring · date-timeRequired

When the group was last modified.

Example: 2026-01-15T10:32:00Z

order_itemsinteger[]Required

Identifiers of the order items covered by this shipping option group.

Example: [501,502]

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

404

The requested shipping option group does not exist.

application/json

get/shipping_option_groups/{id}/

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

{
  "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
  ]
}