Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Dynamic Checkout API lets you retrieve available delivery options for a specific checkout session, based on real-time context such as the shipping address, cart contents, and the merchant configuration in Sendcloud. It is designed to power dynamic, address-aware checkout experiences, where delivery options (home delivery, service points, same-day, etc.) are shown and updated before payment. Using this API enables you to retrieve eligible delivery options for a given checkout context, display them in a custom checkout UI, and allow the customer to select their preferred delivery option before completing the order. This API does not create shipments or labels — it only informs what delivery options are available at the time of the request.
Note: This guide covers our latest version, Dynamic Checkout API v3. For full endpoint and schema documentation, see the API reference.

​
When to use the Dynamic Checkout API

Use the Dynamic Checkout API to dynamically determine which delivery options are available during checkout, based on real-time context. It’s particularly useful when you want to:
  • Show delivery options in real time as the customer updates their address
  • Adapt delivery choices based on live checkout data
  • Power a custom or headless checkout flow
Typical implementation scenarios include:
  • Custom storefronts or headless commerce setups
  • Platforms where native Sendcloud checkout extensions are not available
  • Checkout flows that must resolve delivery options before payment
The Dynamic Checkout API:
  • Does not create shipments
  • Does not generate labels
  • Does not list or search service points

​
How it fits into the Sendcloud workflow

The Dynamic Checkout API represents the delivery option resolution phase which operates before order creation and shipment fulfillment. It resolves which delivery options are available to the customer at checkout, based on real-time context. Typical flow includes:
  1. Customer enters a destination address in checkout
  2. Your system calls the Retrieve a list of delivery options endpoint
  3. The API returns eligible delivery options for that context
  4. The customer selects one option
  5. Your system stores the selected option with the order
  6. During fulfillment, you create a shipment using the Shipments or Ship-an-Order API.

​
Key Concepts

ConceptDefinition
Delivery optionThe delivery option is the core response object from the API. Each delivery option represents a valid carrier service that a customer could choose at checkout. The API returns one delivery option per carrier configured for a delivery method.
checkout_identifierEach delivery option includes a checkout_identifier field that can be used downstream (for example, to map to a shipping option code in the Shipments API, enabling shipment creation with the selected option).
Mapping to configured delivery methodsIf a delivery method uses multiple carriers (e.g., the Service Point delivery method configured with more than one carrier), the API will return multiple delivery options with distinct carriers but referencing the same delivery method ID.