Availability in delivery time period

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 and 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 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.

Get delivery time period

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CheckoutOptionsDeliveryTimePeriodRequest

endDatestring · date-timeOptional

End date-time of the period

includeCalculationHintsbooleanOptional

Whether to include calculation hints in the response

startDatestring · date-timeOptional

Start date-time of the period

Responses

200

The request could be evaluated

application/json

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post

/api/promises/checkoutoptions/delivery/timeperiod

HTTPcURLJavaScriptPython

POST /api/promises/checkoutoptions/delivery/timeperiod HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 543

{
  "basket": [
    {
      "quantity": 1,
      "tenantArticleId": "text"
    }
  ],
  "consumerAddress": {
    "addressType": "POSTAL_ADDRESS",
    "city": "text",
    "country": "DE",
    "houseNumber": "text",
    "postalCode": "text",
    "province": "text",
    "street": "text"
  },
  "deliveryPreferences": {
    "carrierProductCategory": "STANDARD",
    "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
    "preferredCarriers": [
      "text"
    ],
    "preferredCarriersWithProduct": [],
    "preselectedFacilities": [
      null
    ],
    "serviceLevel": "DELIVERY"
  },
  "endDate": "2026-03-02T21:48:40.326Z",
  "includeCalculationHints": true,
  "startDate": "2026-03-02T21:48:40.326Z"
}

{
  "calculationHints": [
    "text"
  ],
  "checkoutOptions": [
    {
      "availableCarriers": [
        {
          "carrierRef": "text",
          "latestPickingStartDate": "2026-03-02T21:48:40.326Z",
          "name": "text",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "availableFacilityConnections": [
        {
          "connectionRef": "text",
          "latestPickingStartDate": "2026-03-02T21:48:40.326Z",
          "nonDeliveryDays": [
            "text"
          ]
        }
      ],
      "date": "2026-03-02T21:48:40.326Z",
      "overallStatus": "ALL"
    }
  ]
}