Shippings

Retrieve shipping options for a data source

get

Returns a list of active shipping options available for the specified data source. Only shipping options that are currently active and associated with the given data source are returned.

If the data source does not exist or has no active shipping options associated with it, this endpoint returns an empty array [] rather than an error response.

This endpoint is publicly accessible and does not require authentication. Results are cached for optimal performance.

Path parameters

data_source_idintegerRequired

Unique identifier of the data source

Example: 1

Responses

200

Successfully retrieved shipping options. Returns an empty array if the data source does not exist or has no active shipping options.

application/json

Shipping option available for a specific data source

pkintegerOptional

Unique identifier for the shipping option

Example: 123

namestringOptional

Display name of the shipping option

Example: Standard Delivery

data_sourceintegerOptional

Unique identifier of the associated data source

Example: 1

descriptionstring · nullableOptional

Optional description providing additional details about the shipping option

Example: Standard shipping option for this data source

get/shippings/data-source-shipping-options/{data_source_id}

GET /shippings/data-source-shipping-options/{data_source_id} HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

Successfully retrieved shipping options. Returns an empty array if the data source does not exist or has no active shipping options.

[
  {
    "pk": 123,
    "name": "Standard Delivery",
    "data_source": 1,
    "description": "Standard shipping option for this data source"
  },
  {
    "pk": 124,
    "name": "Express Delivery",
    "data_source": 1,
    "description": "Fast shipping option with expedited handling"
  }
]

Retrieve available appointment dates for easy return

post

Returns a list of available appointment dates and time slots for scheduling an easy return pickup. The response includes dates within the specified range along with available hour ranges for each date.

Dynamic Configuration Requirement:

This endpoint requires authentication and is only available when the EASY_RETURN_PACKAGE_STRATEGY dynamic setting is configured to allow user selection. The setting must be set to: omnishop.orders.strategies.SelectionBasedEasyReturnPackageStrategy

This is a dynamic configuration that can be updated through the administration interface and takes effect immediately without requiring code deployment. When the strategy is set to rule-based mode, this endpoint will return a 400 Bad Request response.

Available Strategy Options:

• Rule-based (default): Shipping company is chosen automatically by product rules. This endpoint is not available in this mode.

• Selection-based: User chooses shipping company. This endpoint is available in this mode.

Request Requirements:

The pickup address must belong to the authenticated user and must be an active customer address. The start date must be today or later, and the end date must be after the start date.

Rate limiting applies to prevent abuse of this endpoint.

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123 or osessionid=abc123)

Example: sessionid=abc123def456

X-CSRFTokenstringRequired

CSRF token for request validation

Example: csrftoken1234567890abcdef

Body

Request payload for retrieving available appointment dates

shipping_companyintegerRequired

Unique identifier of the shipping company to use for the return. Must be an active easy return shipping company configured for user-selected appointments.

Example: 5

pickup_addressintegerRequired

Unique identifier of the pickup address. Must be an active customer address belonging to the authenticated user.

Example: 42

start_datetimestring · dateRequired

Start date of the date range to search for available appointments. Must be today or a future date.

Example: 2024-03-27

end_datetimestring · dateRequired

End date of the date range to search for available appointments. Must be after the start date and must be today or a future date.

Example: 2024-04-10

Responses

200

Successfully retrieved appointment dates

application/json

Available appointment date with time slots

datestring · dateOptional

The appointment date

Example: 2024-03-27

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

post/shippings/easy-return-appointment-dates

POST /shippings/easy-return-appointment-dates HTTP/1.1
Host: sandbox.akinon.com
Cookie: sessionid=abc123def456
X-CSRFToken: csrftoken1234567890abcdef
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "shipping_company": 5,
  "pickup_address": 42,
  "start_datetime": "2024-03-27",
  "end_datetime": "2024-04-10"
}

[
  {
    "date": "2024-03-27",
    "hour_ranges": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "13:00",
        "end": "18:00"
      },
      {
        "start": "18:00",
        "end": "23:00"
      }
    ]
  },
  {
    "date": "2024-03-28",
    "hour_ranges": [
      {
        "start": "09:00",
        "end": "23:00"
      }
    ]
  }
]