Skip to main content
GET
/
checkout
/
configurations
/
{configuration_id}
/
delivery-options
Retrieve a list of delivery options
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/checkout/configurations/{configuration_id}/delivery-options \
  --header 'Authorization: Basic <encoded-value>'
{
  "configuration_id": "bae462c1-d659-48d0-aacd-fb7e3550de14",
  "delivery_options": [
    {
      "id": "431c1736-9a8f-480a-bf27-234016918417",
      "title": "DHL Delivery - Standard",
      "internal_title": "standard_delivery_dhl",
      "description": "Reliable and cost-effective delivery for your order",
      "delivery_method_type": "standard_delivery",
      "cut_off_time": "2024-11-27T15:00:00+01:00",
      "checkout_identifier": {
        "type": "shipping_option_code",
        "value": "dhl:complete/standard"
      },
      "shipping_rate": {
        "value": "5.00",
        "currency": "EUR"
      },
      "carrier": {
        "code": "dhl",
        "name": "DHL",
        "logo_url": "https://sendcloud-prod-scp-static-files.s3.amazonaws.com/dhl/img/logo.svg"
      },
      "delivery_dates": null,
      "lead_time_hours": {
        "p10": 48,
        "p20": 48,
        "p30": 72,
        "p40": 72,
        "p50": 96,
        "p60": 96,
        "p70": 120,
        "p80": 120,
        "p90": 144,
        "p95": 168
      },
      "sustainability_rating": "high"
    }
  ]
}
To use this API, you first need to create your own Dynamic Checkout configuration in the Sendcloud platform.
Follow these steps to get started:
  1. Log in to your Sendcloud account and navigate to the Dynamic Checkout tab.
  2. Select your API integration from the Shops section to customize your delivery options.
  3. When you’re done, click Publish to connect your configuration to the selected API integration.
This API allows your customers to choose their preferred delivery options during checkout. The options returned by this endpoint are based on the delivery methods previously configured in addition to cart or order information, such as parcel weight, total order value, destination country, and more. You can display the returned delivery options to your customers on your checkout page, where they can select their preferred option for their order.

​
How do delivery options correspond to configured delivery methods?

This API returns one delivery option per carrier configured in Dynamic Checkout. If a delivery method is configured with multiple carriers, then multiple delivery options will be returned - one per carrier. In cases when delivery options correspond to the same delivery method, delivery options’ ids will refer to the same delivery method id, leaving API users with a flexibility to perform grouping based on a delivery method id, if desired.

​
How can I create a shipment out of the selected delivery option?

Use the checkout_identifier_type=shipping_option_code parameter when requesting delivery options. This makes the checkout_identifier field of the selected delivery option contain the shipping option code required for creating a shipment. To proceed, call the Create and announce a shipment asynchronously endpoint, setting ship_with.type to "shipping_option_code" and ship_with.properties.shipping_option_code to the value of the checkout_identifier field.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
configuration_id
string<uuid>
required

The unique ID of the checkout configuration used to retrieve delivery options

Example:

"465e2fe8-4589-4ae2-b49c-0c64153e5169"

Query Parameters

​
weight_value
integer
required

The total weight of the cart or order, specified in grams by default. This parameter is used to select the most suitable shipping option.

Required range: x >= 1
Example:

2500

​
total_order_value
string
required

The total price of the cart or order, specified in the currency of the checkout configuration. This parameter is used to calculate the shipping rate if rates are configured for the delivery method. It can also be used to determine if free shipping is applicable based on the configured pricing rules.

Minimum string length: 1
Example:

"45.90"

​
from_country_code
string
required

The sender's country code for the shipment, formatted as an ISO 3166-1 alpha-2 code A country represented by its ISO 3166-1 alpha-2 code

Example:

"NL"

​
to_country_code
string
required

The recipient's country code for the shipment, formatted as an ISO 3166-1 alpha-2 code A country represented by its ISO 3166-1 alpha-2 code

Example:

"NL"

​
checkout_identifier_type
enum<string>
default:shipping_option_code

Specifies how to retrieve the shipping label. Currently, only the shipping_option_code type is supported. When this type is used, the checkout_identifier field in each delivery option contains the shipping option code, which is required to create and announce a shipment asynchronously.

Available options:
shipping_option_code
​
to_postal_code
string

The recipient's postal code. Use this in combination with Checkout Rules to show or hide delivery options for specific locations.

Maximum string length: 15
Example:

"5611EM"

​
parcel_length
number

The parcel's length in centimeters (e.g., "48" or "52.3")

Example:

48

​
parcel_width
number

The parcel's width in centimeters (e.g., "48" or "52.3")

Example:

48

​
parcel_height
number

The parcel's height in centimeters (e.g., "48" or "52.3")

Example:

48

​
checkout_metadata
string

An arbitrary text field that can be used with Checkout Rules to control which delivery options are displayed during checkout. For example, you might use it to pass a product SKU, goods category, or any other custom property to show or hide specific delivery options during checkout

Maximum string length: 128
Example:

"demo_sku_12345"

Response

Successful Response

Delivery options response

​
configuration_id
string<uuid>
required

The unique ID of the checkout configuration used to generate the delivery options in the response

Example:

"bae462c1-d659-48d0-aacd-fb7e3550de14"

​
delivery_options
Delivery Option Object · object[]
required

A list of delivery options available for the given cart or order details. Each delivery option corresponds to a configured delivery method and includes detailed information, such as shipping rates, delivery dates, and carrier information.

Example:
[
  {
    "id": "ec9ce3b9-7d3f-4298-bc1c-8f3aaa8d27e9",
    "title": "Same day delivery",
    "internal_title": "same_day_delivery_trunkrs",
    "description": "Order now and get your delivery today!",
    "delivery_method_type": "same_day_delivery",
    "cut_off_time": "2024-11-27T15:00:00+01:00",
    "checkout_identifier": {
      "type": "shipping_option_code",
      "value": "trunkrs:same_day"
    },
    "shipping_rate": { "value": "5.00", "currency": "EUR" },
    "carrier": {
      "code": "trunkrs",
      "name": "Trunkrs",
      "logo_url": "https://sendcloud-prod-scp-static-files.s3.amazonaws.com/trunkrs/img/logo.svg"
    },
    "delivery_dates": [
      {
        "delivery_date": "2024-11-27T15:00:00+01:00",
        "parcel_handover_date": "2024-11-27T15:00:00+01:00"
      }
    ],
    "lead_time_hours": {
      "p10": 0,
      "p20": 0,
      "p30": 0,
      "p40": 0,
      "p50": 0,
      "p60": 0,
      "p70": 0,
      "p80": 24,
      "p90": 24,
      "p95": 24
    },
    "sustainability_rating": "low"
  }
]