Shippings

get

This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos

Authorizations
Query parameters
calculatoranyOptional

Query parameter calculator used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

delivery_typestringOptional

Query parameter delivery_type used to filter results based on specific conditions.

descriptionstringOptional

Query parameter description used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

kwargsanyOptional

Query parameter kwargs used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

logostringOptional

Query parameter logo used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

ruleanyOptional

Query parameter rule used to filter results based on specific conditions.

slugstringOptional

Query parameter slug used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

sort_orderintegerOptional

Query parameter sort_order used to filter results based on specific conditions.

translationsany | nullableOptional

Query parameter translations used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/shippings/shipping-options/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "calculator": null,
      "created_date": "2025-06-27T09:02:03.773Z",
      "delivery_type": "same_day",
      "description": "text",
      "id": 1,
      "is_active": true,
      "kwargs": null,
      "logo": "https://example.com",
      "modified_date": "2025-06-27T09:02:03.773Z",
      "name": "text",
      "rule": null,
      "slug": "text",
      "sort_order": 1,
      "translations": null
    }
  ]
}
get

This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this shipping option.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/shippings/shipping-options/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "calculator": null,
  "created_date": "2025-06-27T09:02:03.773Z",
  "delivery_type": "same_day",
  "description": "text",
  "id": 1,
  "is_active": true,
  "kwargs": null,
  "logo": "https://example.com",
  "modified_date": "2025-06-27T09:02:03.773Z",
  "name": "text",
  "rule": null,
  "slug": "text",
  "sort_order": 1,
  "translations": null
}
PreviousReversionsNextSocial Account

Was this helpful?