Using shipping quotes
Learn how to provide your customers shipping options and process their selection
curl --location --request POST 'http://dispatch-test.digitalriver.com/shipping-quotes' \
--header 'Authorization: Bearer <API_key>' \
--header 'Content-Type: application/json' \
You must provide an array of products in your shipping quotes request. Each element of the
itemsarray represents a specific inventory item. For each inventory item, you're required to specify its unique identifier,
In order for Digital River to return accurate shipping quotes, you need to specify the
standarddelivery type is the most common and consists of the shipping carrier bringing the goods directly to the customer's home or place of business.
access_pointdeliveries, 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.
POST/shipping-quotesrequest returns a
quotesarray. Each object of that array represents a shipping quote. This object always contain a unique identifier associated with a shipping service level, as well as information on shipping costs, where the items are shipping from, and product availability.
The following table lists these enumerated shipping quote identifiers, their associated service levels, and the delivery type they support.
As an example, if you specify a
POST/shipping-quotesrequest, you'll get back a maximum of two shipping quotes. That is the number of service levels this delivery type supports.
We also give you information on any
feesincurred for non-standard services that may have been applied to the order.
A shipping quote's
signatureRequiredTypeindicates 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.
The value indicates whether the shipping carrier requires an
adultto sign for delivery or a
standardsigner of any age is acceptable.
signatureRequiredTypeis 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
On orders with split shipments, meaning items are going to different addresses or arriving at the same address at different times ,
handlingindicates the total signature collection cost for all the different shipments.
The order shipped notification you send customers should indicate whether they are required to provide a signature upon delivery.
You'll need to 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 places an order for enough of these products to exceed your pre-defined amount threshold, thereby 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.
estimatedMaximumDeliveryTimerepresent estimated minimum and maximum delivery times (in minutes) for this shipping method.
For each item in a shipping quote, we provide you its
inventoryItemIdas well as its
In a shipping quote, each element of the
itemsarray provides you a
shipFromaddress. This indicates the location of the warehouse where that specific product is shipped from. This allows you to build checkouts with products that ship from different addresses in different countries.
"line1": "27081 Aliso Creek Rd",
"city": "Aliso Viejo",
Specifically, you should retrieve the shipping quote's
totaland use these values to set the checkout's
If all of a shipping quote's ship from values are identical, you can use this one address to specify the checkout's
shipFrom. However, when describing a checkout's items, you have the ability to set
shipFromat the line-item level. 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.