Shipping and Tax Integration

A single API call fetches both shipping and tax costs for cart items in B2B stores.

In the Winter ‘24 release, we introduced Commerce extensions for pricing, inventory, shipping, taxes, and other services. While the checkout integrations framework is still supported, we recommend extensions over integrations because they offer more targeted customizations for your B2B or B2C store. Plus, they’re available for more Commerce domains. See Get Started With Salesforce Commerce Extensions.

Note

Shipping and Tax API

Because shipping and tax providers require the same inputs to make their respective calculations, a single API call fetches both shipping and tax costs for cart items.

An asynchronous shipping cost and tax API call to service providers is triggered when a shopper enters a shipping address.

Diagram of shipping and tax integration.

Here’s the structure of RetrieveDeliveryMethod, the triggering shipping and tax calculation API call.

1{
2   “id” : ID : // the cart delivery group id
3   “deliveryMethods” :  DeliveryMethodCollectionRepresentation :
4   “deliveryAddress” : AddressRepresentation : // selected delivery address
5   “cartItems” : CartItemCollectionRepresentation :
6}

Here’s a sample DeliveryGroupRepresentation.

1{
2   “id”:”2Dg456789012345678AAA”,
3   "cartItems":{
4       Total: 1,
5       carItems:
6       [
7         {
8           "cartItemId":"0a9456789012345678AAA",
9           "productId":"01txx0000006i44AAA",
10           "name":"shower bar",
11           "listPrice":"29.95",
12           "salesPrice":"20.00",
13           "totalTax":"1.85",
14           "totalAmount":"1",
15           "totalPrice":"31.80",
16           "totalAdjustmentAmount":"31.80"
17         }
18       ]
19   },
20   "deliveryMethods":{
21     “total: 2”,
22     “items” :
23     [
24       {
25         "id":"2Dm456789012345678AAA",
26         "shippingFee":14.00,
27         "currencyCode":"USD",
28         "carrier":"UPS",
29         "classOfService":"Next Day Shipping",
30         “timeOfArrival” : “2020-11-05T13:15:30Z”
31         "selected":true
32       },
33       {
34         "id":"2Dm123789012345678EAA",
35         "shippingFee":9.00,
36         "currencyCode":"USD",
37         "carrier":"UPS",
38         "classOfService":"Three Day Shipping",
39         “timeOfArrival” : “2020-11-07T16:15:30Z”
40         "selected":false
41       }
42     ]},
43   "shippingAddress":{
44      "AddressType":"Shipping",
45      "City":"Boston",
46      "Country":"USA",
47      "Id":"81Wxx0000000001EAA",
48      "IsPrimary":true,
49      "Name":"Home Address",
50      "PostalCode":"01234",
51      "State":"MA",
52      "Street":"1 Milk Street"
53   }
54}

Shipping Reference Package

A reference shipping integration package supports both B2B Commerce implementations. You can use it as a template to create your own shipping calculation package.

Clone or download the Shipping Reference Integration Package package.

Tax Reference Package

A reference tax integration package supports both B2B Commerce and implementations. You can use it as a template to create your own tax calculation package.

Clone or download the Tax Reference Integration Package package.