Using a shipping endpoint
Gain a better understanding of how you can use a shipping endpoint to present dynamic shipping options in low-code checkouts
With low-code checkouts, you can save a shipping endpoint in Dashboard. Digital River calls it when processing transactions that involve physical products and uses the response to present customers with dynamic shipping options.
You might find this feature to be useful, if, for example, Global Logistics facilitates your international transactions and another logistics provider assists you with your domestic ones.
Global Logistics also has the capability to help process your domestic shipments.
Depending on whether you're using Global Logistics and/or a third-party logistics provider, the service you set up to handle our call can either filter and adjust the shipping options we send or use the request's data to make yet another call to your third-party provider to get their available options.
Either way, your endpoint must respond with the options you want us to present to customers in the shipping choice selection stage.
On this page, you’ll find details on:
In your create checkout-session request, we recommend that you either reference or directly pass the weight and weight unit of each physical product in the customer's cart.
A product's weight should be exclusive of its packaging but inclusive of its dunnage. In other words, don't include the weight of the product's box but do include the weight of the protective and supporting materials that go inside of it.
Global Logistics uses this data to get more precise shipping rates, and, if the transaction is being facilitated by a third-party logistics provider, they most likely can do the same.
Goods eligible for inclusion in cross-border shipments should also be assigned a
name, description, image, and url. For details on why this is important, refer to Defining basic product data on the Global Logistics page. If you send
items[].skuId in the request, you can store all this product data in the referenced SKU. Otherwise, you'll need to pass items[].productDetails. You'll need to restrict the countries that customers can select from during the shipping address collection stage to those that you support.
In Prebuilt Checkout, you can also use the modal's configuration object to restrict shipping and billing countries.
If you (1) select either low-code checkout solution, (2) enable the Global Logistics service, and (3) save a shipping endpoint in Dashboard, then you can use the information in this section to better understand:
Once customers input a shipping address, and it's determined that the transaction matches one of your trading patterns, our Global Logistics service calls the appropriate Global Logistics Provider to get the transaction’s available shipping options.
We then send a request to your shipping endpoint which lists these available options in
shippingMethods[]. The request also contains the checkout-session’s
currency, shipTo, items[], and unique identifier (sessionId). If you sent upstreamId in the create checkout-session request, we assign this value to sessionUpstreamId.POST /checkout/shipping-quotes
{
"sessionId": "614fa310-2e62-442f-8499-4a3d2b55fef4",
"currency": "EUR",
"shipTo": {
"address": {
"line1": "Oranienburger Str. 32",
"city": "Berlin",
"postalCode": "10117",
"country": "DE"
},
"name": "Johann Doe",
"phone": "07854319925",
"email": "[email protected]"
},
"items": [
{
"sku": {
"id": "sku_e628c0d0-33b7-4dea-aa40-9eadc43e1583",
"name": "Red shirt",
"eccn": "8A992",
"taxCode": "55101504.100",
"image": "https://mdbootstrap.com/img/Photos/Horizontal/E-commerce/Vertical/12.jpg",
"url": "https://digitalriver.com/physical-product",
"physical": true,
"skuGroupId": "physical-product",
"weight": 20.5,
"weightUnit": "oz"
},
"amount": 11.95,
"quantity": 1,
"id": "948264e5-13ac-4001-b553-baea65cdcdea"
}
],
"shippingMethods": [
{
"amount": 15.06,
"description": "Economy",
"serviceLevel": "XLTUS-DEFAULT",
"shippingTerms": "DAP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
},
{
"amount": 17.17,
"description": "Express",
"serviceLevel": "XLTUS-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
},
{
"amount": 18.1,
"description": "Economy",
"serviceLevel": "XLTUK-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
},
{
"amount": 24.84,
"description": "Express",
"serviceLevel": "XLTUK-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
}
]
}
If our request contains
shippingMethods[], your service could process these options by:- Discarding all the elements that have
shippingTermsofDAP. By doing so, you might potentially reduce the frequency of delivery refusals and returns. - Reducing one or more
amountvalues to give your customers a discount on their shipping costs.
Your service's response to our request must contain the
shippingMethods[] you want Digital River to present as options in the shipping choice selection stage. For each shippingMethods[], the values of description, serviceLevel, shippingTerms , and shipFrom must map to one of the methods we sent to your shipping endpoint. Each shippingMethods[] must also have an amount.Response
{
"shippingMethods": [
{
"amount": 16.99,
"description": "Express",
"serviceLevel": "XLTUS-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
},
{
"amount": 17.99,
"description": "Economy",
"serviceLevel": "XLTUK-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
},
{
"amount": 23.99,
"description": "Express",
"serviceLevel": "XLTUK-DEFAULT",
"shippingTerms": "DDP",
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
}
}
]
}
For each
shippingMethods[] your service sends back, Digital River displays its amount, description, serviceLevel, and shippingTerms in the shipping choice selection stage.In Prebuilt Checkout, Digital River renders
shippingTerms in such a way that its meaning is clearer to customers.Each time customers make a selection, we use its data to set the checkout-session’s
shippingChoice and shipFrom.After Digital River converts the checkout-session to an order and sends you the event with a
type of order.accepted, you can retrieve shippingChoice and shipFrom from its data.object and then pass it (along with other required data) in a ship request to your 3PL. This allows your 3PL to send this data to Global Logistics in a POST /shipping-labels request.
For details, refer to Managing a Global Logistics order.Event
{
"id": "e7f66af3-4207-4c23-b866-73efc8449525",
"type": "order.accepted",
"data": {
"object": {
"id": "255895420336",
...
"shipFrom": {
"address": {
"city": "Los Angeles",
"postalCode": "90245",
"state": "California",
"country": "US"
}
},
...
"shippingChoice": {
"amount": 17.99,
"description": "Economy",
"serviceLevel": "XLTUS-DEFAULT",
"taxAmount": 0.0,
"shippingTerms": "DDP"
},
...
"state": "accepted",
...
}
},
...
}
If you (1) select either low-code checkout solution, (2) save a shipping endpoint in Dashboard and (3) engage a third-party logistics service, you can use the information in this section to better understand:
Once customers input a shipping address and Digital River determines that a third-party logistics provider is facilitating the transaction, we send a request to your shipping endpoint.
POST /checkout/shipping-quotes
{
"sessionId": "8e8f8a1b-4049-4e4f-a8b6-d5c6a90b713b",
"currency": "USD",
"shipTo": {
"address": {
"line1": "1234 Rocky Mountain Highway",
"city": "Estes Park",
"state": "CO",
"postalCode": "80517",
"country": "US"
},
"name": "John D.",
"phone": "5555555555",
"email": "[email protected]"
},
"items": [
{
"sku": {
"id": "sku_e628c0d0-33b7-4dea-aa40-9eadc43e1583",
"name": "Blue shirt",
"eccn": "8A992",
"taxCode": "55101504.100",
"image": "https://mdbootstrap.com/img/Photos/Horizontal/E-commerce/Vertical/12.jpg",
"url": "https://digitalriver.com/blue-shirt",
"physical": true,
"skuGroupId": "physical-product",
"weight": 20.5,
"weightUnit": "oz"
},
"amount": 11.95,
"quantity": 1,
"id": "714eb8ef-5a11-4faa-b6e5-35992d01d628"
},
{
"sku": {
"id": "sku_32ee813a-e7a8-46dc-97f4-fca07b47eca6",
"name": "Red shirt",
"eccn": "8A992",
"taxCode": "55101504.100",
"image": "https://mdbootstrap.com/img/Photos/Horizontal/E-commerce/Vertical/12.jpg",
"url": "https://digitalriver.com/red-shirt",
"physical": true,
"skuGroupId": "physical-product",
"weight": 20.5,
"weightUnit": "oz"
},
"amount": 11.95,
"quantity": 1,
"id": "945gh8ed-3g21-6ffg-mj6e6-45113e11d628"
}
]
}
Since we don't yet know what shipping options are available, the request contains no
shippingMethods[]. It does, however, contain the checkout-session’s
currency, shipTo, items[], and unique identifier (sessionId). For each
items[], we also give you an id that uniquely identifies that line item in our system.And if you sent
upstreamId in the create checkout-session request, we assign this value to sessionUpstreamId.After you accept our request and determine that it contains no
shippingMethods[], you can use its currency, items[], and shipTo to call your logistics provider and get the transaction’s available shipping options. In that request, you'll most likely want to pass the
weight and weightUnit of each items[]. Usually, your logistics provider can use that data to give you back more precise shipping rates.In addition, depending on the sophistication of the integration you have with your logistics provider, they might also be able to give you the location of the warehouse(s) from which each
items[] will be shipped. After your logistics provider returns the available shipping options, your service could add a markup, discount them, and/or filter them by terms.
Your service must respond with the
shippingMethods[] you want Digital River to present as options in the shipping choice selection stage. Each element in this array must have an amount, description, and serviceLevel and can optionally include shippingTerms and a shipFrom location.If your logistic provider's service was able to tell you where each line item is going to ship from, your response can also contain
shipments[], each of which should have a single shipFrom and a nested array of itemIds[], each mapped to one of the items[].id we sent to your shipping endpoint. Response
{
"shipments": [
{
"itemIds": [
"714eb8ef-5a11-4faa-b6e5-35992d01d628"
],
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
}
},
{
"itemIds": [
"945gh8ed-3g21-6ffg-mj6e6-45113e11d628"
],
"shipFrom": {
"address": {
"line1": "1234 5th Ave",
"city": "New York",
"postalCode": "10005",
"state": "NY",
"country": "US"
}
}
}
],
"shippingMethods": [
{
"description": "Standard Shipping",
"serviceLevel": "Standard",
"amount": 2.99
},
{
"description": "Expedited Shipping",
"serviceLevel": "Expedited",
"amount": 10.98
}
]
}
For each
shipments[] in your response, we iterate through its itemsIds[], looking up each line item in our system and then using that shipments[].shipFrom to set the appropriate items[].shipFrom value(s) in the checkout-session. For each
shippingMethods[] in the response, Digital River displays its amount, description, serviceLevel, and shippingTerms in the shipping choice selection stage.Each time customers make a selection, we use its data to set the checkout-session’s
shippingChoice and, if that selection contains a shipFrom , we also use it to set that resource's shipFrom.After Digital River converts the checkout-session to an order and sends you the event with a
type of order.accepted, you can pass its data to your fulfillment service, which can then read the line-item level and/or order-level ship from values and route ship requests to the appropriate warehouses.Event
{
"id": "a443e1ee-61ec-4f9c-8c27-97b144c8f8f5",
"type": "order.accepted",
"data": {
"object": {
"id": "255896870336",
...
"items": [
{
"id": "185466030336",
"productDetails": {
"id": "physical-product-1",
"skuGroupId": "physical-product",
"name": "Blue shirt",
"url": "https://digitalriver.com/blue-shirt",
"countryOfOrigin": "US",
"image": "https://mdbootstrap.com/img/Photos/Horizontal/E-commerce/Vertical/12.jpg",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "Part123"
},
...
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
...
},
{
"id": "185466050336",
"productDetails": {
"id": "physical-product-2",
"skuGroupId": "physical-product",
"name": "Red shirt",
"url": "https://digitalriver.com/red-shirt",
"countryOfOrigin": "US",
"image": "https://mdbootstrap.com/img/Photos/Horizontal/E-commerce/Vertical/12.jpg",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "Part123"
},
...
"shipFrom": {
"address": {
"line1": "1234 5th Ave",
"city": "New York",
"postalCode": "10005",
"state": "NY",
"country": "US"
}
},
...
}
],
"shippingChoice": {
"amount": 10.98,
"description": "Expedited Shipping",
"serviceLevel": "Expedited",
"taxAmount": 0.0
},
...
}
},
...
}
Last modified 1mo ago