Availability for delivery date

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

Summary

The purpose of this endpoint is to provide available stock quantities over facilities for items on a specific delivery date.

This information can be used to determine the availability of certain products for a delivery day selected by the customer. Thus, the consumer knows at an early stage of the checkout journey if an item can be delivered on a certain delivery date.

You find the documentation of this call here.

Additional info about the request:

• desiredDeliveryDate: This is the date when the item should arrive at the customer.

• tenantArticleIds: Contains all tenantArticleIds that the customer is interested in buying.

• facilityRef: Contains all facilities that should be considered for the delivery.

• latestPickingStart: This is the point in time at which the picking for the delivery must be started to arrive in time at the customer. If the latest possible picking start for a certain delivery date in a facility is not known, it can be requested via the /api/promises/checkoutoptions endpoint. Our systems then calculate the latestPickingStartbased on cut-off time of carriers and fulfillment process buffer.​

Additional info about the response:

The response lists the available quantity for all requested items and facilities. Facility / item combinations with zero availability are included.

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 we expect these deliveries to arrive as soon as possible and there is no exact date that our systems can use to check the potential availability of these stocks for incoming orders.

Example response

{
    "items": [
        {
            "facilityRef": "cgn-01",
            "tenantArticleId": "0631",
            "available": 300
        },
        {
            "facilityRef": "cgn-01",
            "tenantArticleId": "2027",
            "available": 200
        },
        {
            "facilityRef": "dus-01",
            "tenantArticleId": "06031",
            "available": 4
        },
        {   
            "facilityRef": "dus-01",
            "tenantArticleId": "2027",
            "available": 0
        }
    ]
}

This endpoint is to be used to get information about the possible delivery of items

POST/api/promises/checkoutoptions/delivery/timepoint

Body

application/json

desiredDeliveryDate*string (date-time)

The desired delivery date. (timestamp of the request)

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

tenantArticleIds*array of string

facilities*array of FacilityRefLatestPickingStartPair (object)

Pair of facilityRef and latestPickingStart values

Response

200400401403

The request could be evaluated.

Body

application/json

items*array of CheckoutOptionsDeliveryTimePointResponseItem (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/promises/checkoutoptions/delivery/timepoint', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "facilities": [
        {
          "facilityRef": "text",
          "latestPickingStart": "2020-02-03T09:45:51.525Z"
        }
      ],
      "tenantArticleIds": [
        "DE-ZGT-4711"
      ],
      "desiredDeliveryDate": "2024-06-03T00:00:00.000Z"
    }),
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "tenantArticleId": "DE-ZGT-4711",
      "available": 4,
      "facilityRef": "text",
      "latestPickingStart": "2020-02-03T09:45:51.525Z"
    }
  ]
}