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

Use case	API
Is (a list of) article(s) currently available in the network? How much of it?	stock summaries
What is the earliest possible delivery date for an article?	delivery earliest
What is the earliest possible pick-up date for an article?	collect earliest
How much stock is available for a list of articles and facilities on a specific delivery date?	delivery time point

Product detail page

Use case	API
Is the article currently available at the (pick-up) location? How much of it?	stock distribution
What is the earliest possible delivery date for an article?	delivery earliest
What is the earliest possible pick-up date for an article?	collect earliest
What are possible delivery dates for an article in a specific time period (calendar functionality)?	delivery time period

Shopping cart

Use case	API
What carriers and carrier products are available for that article?	delivery earliest
What carriers are available for that basket?	checkout options
What are the delivery costs for that basket?	checkout options
Are all articles in the basket available for shipping / pick-up?	checkout options
Is an order split necessary to fulfill the order?	checkout options

Checkout

Use case	API
How and where would the order be fulfilled if placed now (pre-reservation can already be made)?	delivery promise
What is the estimated delivery time and the respective latest possible acceptance time for the order?	delivery promise

Shop REST APIs

Stock summary

Request	Response
list of article IDs facility filters (facility ID, status, etc.)	availableForPicking = amount currently available for shipping includedFacilityRefs = facilities in which article is in stock (does not imply availability) No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for GET /api/stocks/summaries .

Stock distribution

Request	Response
one article ID facility filters (facility ID, status, etc.)	availableForPicking = amount currently available for shipping/pick-up No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for GET /api/articles/{tenantArticleId}/stockdistribution.

Delivery earliest

Request	Response
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 No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for POST /api/promises/checkoutoptions/delivery/earliest .

Collect earliest

Request	Response
list of article IDs pick-up facilities IDs desired collect date (optional)	available carriers available facility connections No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for POST /api/promises/checkoutoptions/collect/earliest .

Delivery time period

Request	Response
basket of article IDs consumer address (country sufficient) time period delivery preferences	available carriers available facility connections basket availability per date (all / part / none) No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for POST /api/promises/checkoutoptions/delivery/timeperiod .

Delivery time point

Request	Response
list of article IDs list of facilities (and their latest picking start) desired delivery date	available amount per article and facility No facilities (i.e. their stock) are filtered out by fences.

More information can be found in the REST API documentation for POST /api/promises/checkoutoptions/delivery/timepoint .

Checkout options

Request	Response
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 The response includes all information on possible facilities that have stock of at least one of the ordered items and have not been filtered out by fences.

More information can be found in the REST API documentation for POST /api/promises/checkoutoptions .

Delivery promise

Request	Response
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 When sending a "promise order", a routing decision is performed with the configured routing strategy and the respective stock is reserved.

More information can be found in the REST API documentation for POST /api/promises/deliverypromise .