Earliest possible delivery date

What is the purpose of this endpoint?

The purpose of this endpoint is to provide the earliest possible delivery date for an item or a list of items. This information can be used on a search result or product overview page to inform the shop user about when the delivery of a specific item can be expected.

This becomes especially valuable in industries and situations where delivery time is as important as the item itself—such as when selling gifts that need to be delivered by a certain date or in the case of groceries when you need to be home to receive the delivery. In these contexts, having accurate delivery information is crucial to enhancing the shopping experience.

You find the documentation of this call here.

Please note:

• the maximum amount of days that are checked is limited to 45 days

• Since we check for delivery days it is mandatory to have transit times set p. carrier if you want to use this feature. If this is not the case we cannot perform our calculation ❗

• if set the average fulfillment time and the opening times are included in the calculation

How does it work?

Some additional info about the request:

• earliestDeliveryDate: This is set to "now" by default, meaning the customer is interested in an ASAP delivery. If a different future date is specified, available delivery dates will be checked starting from that point in time (i.e., the user does not want to receive their order before a given date).

• tenantArticleIds: The earliest delivery date can be calculated for a single item or a list of items. If a list of items is requested, the calculation is done for each item individually (not as a basket).

• 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 the calculation to consider region-specific non-delivery days.

Some additional info about the response:

You will receive a list of the requested items with

• earliestPredictedDeliveryDate: This is the earliest point in time when the user can expect this particular item to be delivered in case the order would be placed at this moment.

• availableCarrier:

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

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

delivery/earliest

POST/api/promises/checkoutoptions/delivery/earliest

Body

application/json

earliestDeliveryDatestring (date-time)

The date from which to search for the earliest potential delivery date. Defaults to "now" (timestamp of the request)

Example: "2024-06-01T00:00:00.000Z"

tenantArticleIds*array of string

consumerAddress*CheckoutOptionsConsumerAddress (object)

includeCalculationHintsboolean

Set this flag to true to get additional information about the availability of the requested articles

Response

200400401403

The request could be evaluated.

Body

application/json

checkoutOptions*array of CheckoutOptionsDeliveryEarliestResponseItem (object)

The results of the corresponding request containing information, if present, on when the items can supposingly be delivered earliest. Please note: When it was not possible to calculate the delivery information for a requested tenantArticleId there is no entry here.

calculationHintsarray of string

Hints generated during the calculation of the earliest delivery date. These are only returned if the includeCalculationHints flag was provided when performing the request.

Request

JavaScriptCurlPython

const response = await fetch('/api/promises/checkoutoptions/delivery/earliest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenantArticleIds": [
        "DE-ZGT-4711"
      ],
      "consumerAddress": {
        "country": "DE"
      }
    }),
});
const data = await response.json();

Response

200

{
  "checkoutOptions": [
    {
      "tenantArticleId": "DE-ZGT-4711",
      "earliestPredictedDeliveryDate": "2020-02-03T08:45:50.525Z",
      "availableCarriers": [
        {
          "name": "DHL",
          "carrierRef": "text",
          "nonDeliveryDays": [
            "DE-NW"
          ]
        }
      ]
    }
  ],
  "calculationHints": [
    "text"
  ]
}