Availability in delivery time period

Summary

This endpoint provides all available delivery dates based on a basket of items within a defined timeframe. This information might be used in order to provide a calendar view to the user that indicates the available delivery dates.

More API information can be found here: REST API documentation – checkoutoptions/delivery/timeperiod

The length of the time period is restricted to 60 days. Please note that the longer the time period, the more time may be needed to calculate the results (depending on the size of the fulfillment network).

Request & response

Request

• startDate: Start date of the requested time range. If no info is given, the default is "now" (timestamp of the request).

• endDate: End date of the requested time range. If no info is given, the default is "now" (timestamp of the request).

• basket:Contains all tenantArticleIds and the respective quantities that the customer is interested in buying.

• consumerAddress:The request must include at least the consumer's country. This is important because non-delivery days are taken into account when calculating the earliest delivery date, and these vary by country and region. It is also possible to provide a postal code in the request (e.g., for logged-in shop users). Doing so allows considering region-specific non-delivery days.

• deliveryPreferences: By setting deliveryPreferences like preferredCarrier(s) or preferredCarrierProductCategories only matching carrier options are considered when evaluating which dates are possible delivery dates.

Response

• date: Date on which the calculation took place and for which the below information applies.

• overallStatus: The result can be be ALL, NONE or PARTIAL.

  • ALL: all items of the requested basket can be delivered on the corresponding date

  • NONE: none of the items of the requested basket can be delivered on the corresponding date

  • PARTIAL: part of the items of the requested basket can be delivered on the corresponding date

• availableCarriers:

  • name:Name of the carrier (key) like "DHL"

  • nonDeliveryDays:Regions where this particular date is a non delivery date of the corresponding carrier (e.g., DE-NW: DHL does not deliver on the March 3rd 2025 in North Rhine Westphalia due to carnival)

Expected stocks that were announced via purchase order are also considered in the response. Only purchase orders with requestedDate.type "ASAP" are not considered as these deliveries are expected to arrive as soon as possible and there is no exact date that can be used to check the potential availability of these stocks for incoming orders.