jv1
API Overview
The Commerce Delivery Service API provides estimation endpoints plus provisioning, routing, and health endpoints. It also predicts the estimated delivery date for one or more items on the storefront (from a product detail page (PDP) or checkout), reflecting the fulfillment location if an order is placed.
This specification includes both v1 and v2 API endpoints. Use version-prefixed paths (/v1/* or /v2/*) to access the respective API versions.
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
The API client must also have the sfcc.commercedeliveryservice.shopper OAuth scope. You must include the relevant scope in the client ID used to generate the token. For a full list of required permissions, see the Authorization Scopes Catalog.
For detailed setup instructions, see Authorization for Admin APIs.
Use Cases
Estimate Delivery Date
Use the delivery-date endpoint to provide an estimated delivery date or delivery date range when
- A shopper is on a PDP and wants to know the estimated delivery date for a product before adding it to their cart, or
- A shopper is checking out and wants to know the estimated delivery date for the products being purchased.
Estimate Delivery Date by Location
Use the delivery-date-by-locations endpoint to provide an estimated delivery date or delivery date range based on a specific location group level when
- A shopper is on a PDP and wants to know the estimated delivery date for a product based on a specific location before adding it to their cart, or
- A shopper is checking out and wants to know the estimated delivery date for the products being purchased based on a specific location.
Estimate Buy Online, Pick Up In Store (BOPIS) Time
Use the BOPIS endpoint to provide an estimated earliest pickup time for BOPIS orders when
- A shopper is on a Product Detail Page (PDP) and wants to know when a product will be ready for pickup at specific store locations before adding it to their cart.
- A shopper wants to find nearby stores within a specified radius where a product is available for pickup, sorted by distance, along with the earliest pickup time at each location. This use case supports "find stores near me" scenarios where you provide an address, radius distance, unit (miles/km), and an optional maximum number of locations to return, sorted by distance with pickup times.
- A shopper is checking out with a BOPIS delivery method and wants to know the earliest pickup time and available inventory for the products being purchased at nearby store locations.
Let us know so we can improve!