Last updated
Last updated
with must contain a shippingChoice
. This data structure lets you define the delivery method customers select at checkout time. After you , you can to update the checkout totals you display to customers.
In and requests, you can send the following data in shippingChoice
:
If you don't send shippingChoice.id
in the request, Digital River doesn't generate an identifier that gets returned in the response.
If you pass shippingTerms
that are DAP
, then duties and import taxes are not returned in checkouts.
This means that when the products are delivered, customers may be presented with a bill for any outstanding importation costs. Customers typically must pay these costs before the carrier transfers ownership.
You should also remember that transactions not paid in full at the point of sale have higher rejection and return rates. This is because customers may be unaware of the outstanding balance or the outstanding balance is higher than they anticipated and, in response, they either refuse the delivery altogether or accept the products and then request a return.
You're not required to send shippingChoice
in either or . But if any of a checkout's contain a and shippingChoice
aren't set when you , you receive a 400 Bad Request
.
A shippingChoice.id
is typically a pass-through value from your fulfillment or logistics provider. You're not required to provide this identifier.
You can use a shippingChoice.amount
to pass the estimated cost of a customer's shipping method selection. This value should include handling and fees.
Whether Digital River adds taxes to or extracts taxes from shippingChoice.amount
is dependent on how you set the checkout's taxInclusive
flag. For details, refer to the page.
When or that contain , if you send shippingChoice
but fail to send shippingChoice.amount
, then a 400 Bad Request
is returned.
In a shippingChoice
, you can use serviceLevel
and description
to describe the shipping method selected by the customer.
In , you're not required to pass either of these values, but they can be useful for reporting purposes. Additionally, since it helps Digital River better detect fraud, we highly recommend that you send serviceLevel
.
You can designate a shippingChoice.shippingTerms
as either or . The default value is DDP
.
For more information, refer to on the page.
In with DAP
duty payment terms, you should inform customers that import charges are collected upon delivery.
If you pass shippingTerms
that are DDP
, and the exist to activate the , then estimated duties and import taxes are returned at checkouts.
This allows you to present customers with the of a transaction, thereby eliminating "surprise" charges at the time of delivery.
For more information, refer to the following sections on the page:
Once you collect a customer's shipping method choice and add shippingChoice.amount
to the , Digital River makes a tax computation and returns that value in shippingChoice.taxAmount
. For each of a items[]
, Digital River also returns a shipping
object that contains an amount
and a taxAmount
.
All of a taxes, including shippingChoice.taxAmount
, are aggregated into totalTax
.
Each time you update the , we recommend that you retrieve shippingChoice.amount
or totalShipping
and display this value to customers in the transaction details section of your UI. To provide customers more granularity on shipping costs, you might also decide to display each line item's shipping.amount
and shipping.taxAmount
.
Learn how to set and use a customer's shipping choice in checkouts