Shipping & Delivery

Checkout Shipping & Delivery

Configure shipping options and collect delivery preferences from your customers. These endpoints cover shipping method selection, delivery time slot selection, retail store and locker pickup, remote price calculation, delivery bags, and SMS notifications.

Authentication

These endpoints support both authenticated and anonymous sessions.

• Authenticated users: Session cookie (sessionid) tracks checkout progress.

• Anonymous users: Guest checkout is available when the CAN_GUEST_PURCHASE setting is enabled.

Request Format

Include the following header in all checkout requests:

• x-requested-with: XMLHttpRequest

Dynamic Settings

The following settings are managed at runtime through the admin interface and do not require a server restart.

CHECKOUT_SHIPPING_OPTION_SELECTION_PAGE

Determines which shipping option page is active:

• ShippingOptionSelectionPage — standard shipping options

• DataSourceShippingOptionSelectionPage — options grouped by supplier

• AttributeBasedShippingOptionSelectionPage — options grouped by product attribute

• RemoteShippingOptionSelectionPage — options fetched from an external service

ATTRIBUTE_KEYS_FOR_ATTRIBUTE_BASED_SHIPPING_OPTION

Rules that determine how basket items are grouped by product attribute when the attribute-based shipping page is active. Rules are evaluated in priority order; the first matching rule determines the grouping key.

REMOTE_SHIPPING_OPTION_PROVIDER

External service configuration used when RemoteShippingOptionSelectionPage is active. Includes the service URL and authentication credentials.

REMOTE_DELIVERY_OPTION_PROVIDER

External service configuration for fetching delivery options remotely.

CHECKOUT_RETAIL_STORE_FILTERS

Filtering options for the retail store list. When by_stock is enabled, only stores with available stock for basket items are shown.

DELIVERY_BAGS_CONF

Configuration for the delivery bags step. Set is_active to true to include the delivery bags page. Controls bag SKU, minimum quantity, and whether the customer can specify a custom quantity.

REMOTE_PRICE_ATTRIBUTE_KEY

Product attribute key indicating that an item requires remote price calculation.

Static Settings

The following settings are configured in the server environment and require a restart to take effect.

AUTOSELECT_SHIPPING

When enabled, if only one shipping option is available after filtering, it is selected automatically and the shipping selection page is skipped.

CHECKOUT_LIST_RETAIL_STORES

Controls whether retail stores are listed on the store selection page. When disabled, an empty list is returned.

ORDER_BARCODE_SENT_SMS_EXPIRATION_IN_SECONDS

Minimum interval in seconds between consecutive SMS sends for the same order. Prevents repeated sends within the cooldown period. Defaults to 1800 seconds (30 minutes).