Using shipping quotes
Learn how to provide your customers shipping options and process their selection
Last updated
Learn how to provide your customers shipping options and process their selection
Last updated
This page explains how to use the in 2020-12-17, 2020-02-23, and 2021-03-23 as part of a .
In , you call the during to provide customers with shipping options.
In a , you must you'd like to ship and .
In the response, we give you an array of , each describing the quote's , , , , , and ship-from.
These shipping quotes can then be displayed to the customer. Once the customer selects, you can .
In a request, you need to provide the currency used to pay for the shipping, the , and their .
This call to the typically occurs late in the , after customers have finalized their carts and you've collected their shipping address. So, much of the data you need to define the request can be retrieved from the .
Checkout
POST/shipping-quotes
currency
âž”
currency
items[].skuId
âž”
items[].inventoryItemId
items[].amount
âž”
items[].price
items[].quantity
âž”
items[].quantity
shipTo.postalCode
âž”
shipTo.postalCode
shipTo.state
âž”
shipTo.state
shipTo.country
âž”
shipTo.country
For Digital River to return accurate shipping quotes, you need to specify the shipTo block's state, country, and postalCode.
A standard delivery type is the most common and consists of the shipping carrier bringing the goods directly to the customer's home or place of business.
With access_point deliveries, customers pick up their products at stand-alone lockers located in high-traffic areas like shopping centers and train stations. Alternatively, the goods can be delivered to so-called "parcel shops", such as convenience and grocery stores, where the customer picks them up.
When you specify cash_on_delivery, end customers must pay the shipping carrier for the goods at the time of delivery. This cash-on-delivery (COD) payment method is particularly popular in Japan, China, Mexico, Indonesia, Germany, Spain, Turkey, UAE, Russia and other countries.
The following table lists these enumerated shipping quote identifiers, their associated service levels, and the delivery type they support.
A1
accessPointExpress
access_point
AG
accessPointStandard
access_point
D1
expressNextDay
standard
D2
expressSecondDay
standard
IH
inHome
standard
IC
internationalExpress
standard
IS
internationalStandard
standard
SG
standard
standard
COD
standardCOD
cash_on_delivery
We will also give you information on any fees incurred for non-standard services that may have been applied to the order.
The value indicates whether the shipping carrier requires an adult to sign for delivery or a standard signer of any age is acceptable.
If signatureRequiredType is not contained in the response, it means that no delivery confirmation is needed for any of the products in the shipping quote.
Shipping carriers typically charge for performing this signature collection service. If you decide to pass this cost on to customers, then the amount the carrier charged is reflected in handling.
On orders with split shipments, meaning items are going to different addresses or arriving at the same address at different times, handling indicates the total signature collection cost for all the different shipments.
The order shipped notification you send customers should indicate whether they must provide a signature upon delivery.
You must contact your account manager to configure and enable the signature required feature.
The configuration process involves several steps. First, specific products within your channel's catalog need to be flagged. When these flagged products are included in an order, they trigger the signature required feature.
You can also set item-level and order-level amount thresholds. These tell us when to activate the feature. Let's say you have a product that is not flagged for signature collection. But a customer orders enough of these products to exceed your pre-defined amount threshold, triggering a mandatory signature collection.
And finally, you'll need to tell us whether you or the customer will pay the cost the shipping carrier charges for providing this service.
The estimatedMinimumDeliveryTime and estimatedMaximumDeliveryTime represent estimated minimum and maximum delivery times (in minutes) for this shipping method.
For each item in a shipping quote, we provide you its inventoryItemId as well as its quantity, availableQuantity, and availableTime.
Specifically, you should retrieve the shipping quote's id and total and use these values to set the checkout's shippingChoice.serviceLevel and shippingChoice.amount.
quotes[].id
âž”
shippingChoice.serviceLevel
quotes[].total
âž”
shippingChoice.amount
quotes[].items[].shipFrom
âž”
shipFrom or items[].shipFrom
You must provide an array of products in your shipping quote request. Each element of the items array represents a specific . For each inventory item, you're required to specify its unique identifier, price, and quantity.
In , your form synchronous pairs. So the items[].skuId can be used to set the items[].inventoryItemId.
You can also use shipTo to set type. This parameter represents the final step in the fulfillment process, actually delivering the products to a customer. The type options are (default), , or . The delivery type affects .
If you set type to cash_on_delivery, once is initiated, we send this data downstream to the fulfiller, who, in turn, notifies the shipping carrier to collect COD.
A successful request returns a quotes array. Each object of that array represents a . This object always contains a , information on , where the , and .
Depending on your configuration, you may also get back data on and .
Every contains a unique id which is associated with a shipping method. This shipping method is designated by serviceLevel. That service level is, in turn, associated with the you specify in the request.
As an example, if you specify a of access_point in the POST/shipping-quotes request, you'll get back a maximum of two shipping quotes. That is the number of service levels this delivery type supports.
A provides you with order-level and item-level shipping and handling costs. We aggregate these amounts into both an item total and an order total.
A signatureRequiredType indicates whether a signature is needed upon delivery and, if it is, what type of signature is required. It's commonly used to prevent the theft of high-dollar items from a customer's doorstep after the goods have been delivered.
You can also retrieve this same data by making a request.
In a , each element of the items array provides you with a shipFrom address. This indicates the warehouse location from which that specific product is shipped. This allows you to .
In that use either the or , after you , present them to the customer.
Once the customer selects a specific shipping quote, retrieve its data and send it in a or request. This associates the shipping quote with the .
If all of a are identical, you can use this one address to specify . However, when , you have the ability to . So, if the shipping quote contains items with different ship from addresses, pass each of these unique values to the checkout's corresponding line item.