Availability & promising in customer journey
Introduction
The customer journey in the web shop typically involves various steps, from searching for an item on an overview page to completing an order on the checkout page. Each step requires a different level of detail on the "available to promise" (ATP) information. In general, the responses of the ATP calls get more and more specific the further the user proceeds in the checkout journey.
This page gives an overview of the different requests that are recommended for each step in the (checkout) journey.
Endpoints per shop page
Product listing page
Is (a list of) article(s) currently available in the network? How much of it?
What is the earliest possible delivery date for an article?
What is the earliest possible pick-up date for an article?
How much stock is available for a list of articles and facilities on a specific delivery date?
Product detail page
Is the article currently available at the (pick-up) location? How much of it?
What is the earliest possible delivery date for an article?
What is the earliest possible pick-up date for an article?
What are possible delivery dates for an article in a specific time period (calendar functionality)?
Shopping cart
What carriers and carrier products are available for that article?
What carriers are available for that basket?
What are the delivery costs for that basket?
Are all articles in the basket available for shipping / pick-up?
Is an order split necessary to fulfill the order?
Checkout
How and where would the order be fulfilled if placed now (pre-reservation can already be made)?
What is the estimated delivery time and the respective latest possible acceptance time for the order?
Shop REST APIs
Stock summary
list of article IDs
facility filters (facility ID, status, etc.)
availableForPicking= amount currently available for shipping
includedFacilityRefs= facilities in which article is in stock (must not mean its available)
Stock distribution
one article ID
facility filters (facility ID, status, etc.)
availableForPicking= amount currently available for shipping/pick-up
Delivery earliest
list of article IDs
consumer address (country sufficient)
custom facility filters (optional)
desired delivery date (optional)
available carriers
earliest predicted delivery date
available facility connections
Collect earliest
list of article IDs
pick-up facilities IDs
desired collect date (optional)
available carriers
available facility connections
Delivery time period
basket of article IDs
consumer address (country sufficient)
time period
delivery preferences
available carriers
available facility connections
basket availability per date (all / part / none)
Delivery time point
list of article IDs
list of facilities (and their latest picking start)
desired delivery date
available amount per article and facility
Checkout options
basket of article IDs
consumer address (country sufficient)
delivery preferences
geo fence
target time (optional)
desired delivery date (optional)
available amounts for the articles in the basket per article and facility
available carriers per facility
available services per facility
facility details (closing days, picking times, etc.)
transit times
delivery costs
... and more
Delivery promise
basket of article IDs
consumer address
services
(pre-)reservation
available amounts for the articles in the basket per article and facility
available carriers per facility
available services per facility
facility details (closing days, picking times, etc.)
total shipping costs
packaging information
Last updated