Get Rate for Cart

1 min

POST

https://api.upstartcommerce.com/v1/shipping-method/rate/cart

This endpoint returns the shipping rate for the current cart.

Authorized permissions:

shipping.method.read

Authorized roles:

customer.default
customer.anonymous

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestring
Description
Unique identifier for the site.

Body Parameters

bodyCartShippingRatesRequestrequired
Description
The request must provide details of the cart for which shipping rate should be calculated.
- countrystring
  Example
  USA
  Description
  This represents the target country.
- currencystringrequired
  Example
  USD
  Description
  The 3-character ISO code.
- distanceUnitDistanceUnitsrequired
  Description
  An enumeration of the supported distance measurements.
- idstring<uuid>required
  Example
  8A218593-40EB-4DD0-94BD-8ACA1D95BB14
  Description
  Unique identifier for a cart.
  Format
  uuid
- itemsCartItem[]required
  Description
  An array of the items in the current cart.
  - catalogItemIdstringrequired
    Example
    catalogItemId
    Description
    Unique identifier for a catalog item.
  - idstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart item.
    Format
    uuid
  - pricingCartItemPricing
    Description
    The price breakdown for a single cart item: its base price plus fee, promotion and tax adjustments.
    - basePriceBasePrice
      Description
      The base price for a zone, before fees, promotions and tax are applied.
      - pricenumberrequired
      - typestringrequired
      - zonestringrequired
    - feePriceAdjustmentsFeePriceAdjustment[]required
      Description
      A fee applied to a price, identified by id, with the amount it adjusts by.
      - idstringrequired
      - valuenumberrequired
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]required
      Description
      A promotion applied to a price, identified by id, with the amount it adjusts by.
      - idstringrequired
      - valuenumberrequired
    - taxPriceAdjustmentTaxPriceAdjustment
      Description
      A tax applied to a price, with the tax code it was calculated under.
      - taxCodestringrequired
      - valuenumber
  - productItemSkuIdstringrequired
    Example
    SKU_item1
    Description
    Unique identifier of the stock keeping unit (SKU) of an item.
  - quantityinteger<int32>required
    Example
    1
    Description
    The quantity of this item in a cart.
    Format
    int32
  - shipmentIdstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart shipment.
    Format
    uuid
- locationIdstring
  Example
  locationToId
  Description
  Unique identifier for the location to which a shipment should be sent.
- postalCodestring
  Example
  43234
  Description
  This represents the ZIP code.
- shipmentsCartShipmentRequest[]required
  Description
  This represents the list of shipments.
  - idstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart shipment.
    Format
    uuid
  - shippingMethodIdstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart shipping method.
    Format
    uuid
  - rateServiceCodestring
    Example
    rateServiceCode
    Description
    This represents the rate service code.
  - trackingNumberstring
    Example
    123456789
    Description
    This represents the tracking number.
- shippingAddressAddress
  Description
  Standardized format for global addresses.
  - street1stringrequired
  - street2string
  - citystringrequired
  - countystring
  - stateOrRegionstringrequired
  - countrystringrequired
    Description
    Defaults to US.
    Min Length
    2
    Max Length
    2
  - postalCodestringrequired
  - poBoxboolean
  - nameName
    Description
    A person's name, broken into salutation, first, middle initial, last and suffix.
    - firststringrequired
      Example
      John
      Description
      The first name of the individual being addressed.
    - laststringrequired
      Example
      Smith
      Description
      The last name of the individual being addressed.
    - middleInitialstring
      Example
      D.
      Description
      The middle initial of the individual being addressed.
    - salutationstring
      Example
      Capt.
      Description
      The salutation of the individual being addressed.
    - suffixstring
      Example
      Sr.
      Description
      The optional suffix of the individual being addressed.
  - businessNamestring
  - phoneNumberstring
- shippingCoordinatesCoordinates
  Description
  Represents geographical coordinates with latitude and longitude.
  - latitudenumber<double>required
    Example
    37.7749
    Description
    The latitude of the coordinate.
    Format
    double
  - longitudenumber<double>required
    Example
    -122.4194
    Description
    The longitude of the coordinate.
    Format
    double
- stateOrRegionstring
  Example
  California
  Description
  This represents the target state or region.
- metadataobject
  Description
  Metadata about the shipment calculation that are specific per calculator.
- pricingCartPricing
  Description
  The price breakdown for a cart: item and base totals, fees, tax and cart-level promotions.
  - promotionPriceAdjustmentsCartPromotionPriceAdjustment[]
    Description
    A cart-level promotion adjustment, with the value it applies and the items it covers.
    - idstringrequired
    - valuenumberrequired
    - itemIdsstring[]required
  - totalItemsPricenumber
    Description
    Cart items price including base price, promotions, fees. Excluding tax.
  - totalItemsBasePricenumber
    Description
    Cart items base price.
  - totalFeenumber
    Description
    Total fees.
  - totalTaxnumber
    Description
    Total tax.
  - totalItemCartPromotionnumber
    Description
    All item and cart promotion adjustments.

Responses

200

Success-shipping-rate calculation returned.

CartShippingRatesResponse
Description
This represents a successful response for the cart-shipping-rates request.
- countrystring
  Example
  USA
  Description
  This represents the target country.
- currencystringrequired
  Example
  USD
  Description
  The 3-character ISO code.
- errorsErrorMessage[]required
  Description
  This represents an array of errors, if applicable.
  - levelstring<INFO | WARN | ERROR>required
    Example
    INFO
    Description
    Level of an error message.
    Allowed
    INFOWARNERROR
  - codestringrequired
    Example
    ERR-123
    Description
    Code of an error message.
  - messagestring
    Example
    Something unexpected happened
    Description
    Message of an error message.
  - detailstring
    Example
    Could not contact other service
    Description
    Details of an error message.
- idstring<uuid>required
  Example
  8A218593-40EB-4DD0-94BD-8ACA1D95BB14
  Description
  Unique identifier for a cart.
  Format
  uuid
- itemsCartItem[]required
  Description
  An array of the items in the current cart.
  - catalogItemIdstringrequired
    Example
    catalogItemId
    Description
    Unique identifier for a catalog item.
  - idstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart item.
    Format
    uuid
  - pricingCartItemPricing
    Description
    The price breakdown for a single cart item: its base price plus fee, promotion and tax adjustments.
    - basePriceBasePrice
      Description
      The base price for a zone, before fees, promotions and tax are applied.
      - pricenumberrequired
      - typestringrequired
      - zonestringrequired
    - feePriceAdjustmentsFeePriceAdjustment[]required
      Description
      A fee applied to a price, identified by id, with the amount it adjusts by.
      - idstringrequired
      - valuenumberrequired
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]required
      Description
      A promotion applied to a price, identified by id, with the amount it adjusts by.
      - idstringrequired
      - valuenumberrequired
    - taxPriceAdjustmentTaxPriceAdjustment
      Description
      A tax applied to a price, with the tax code it was calculated under.
      - taxCodestringrequired
      - valuenumber
  - productItemSkuIdstringrequired
    Example
    SKU_item1
    Description
    Unique identifier of the stock keeping unit (SKU) of an item.
  - quantityinteger<int32>required
    Example
    1
    Description
    The quantity of this item in a cart.
    Format
    int32
  - shipmentIdstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart shipment.
    Format
    uuid
- locationIdstring
  Example
  locationToId
  Description
  Unique identifier for the location to which a shipment should be sent.
- postalCodestring
  Example
  43234
  Description
  This represents the ZIP code.
- shipmentsCartShipmentResponse[]required
  Description
  This represents the list of shipments.
  - addressFromAddress
    Description
    Standardized format for global addresses.
    - street1stringrequired
    - street2string
    - citystringrequired
    - countystring
    - stateOrRegionstringrequired
    - countrystringrequired
      Description
      Defaults to US.
      Min Length
      2
      Max Length
      2
    - postalCodestringrequired
    - poBoxboolean
    - nameName
      Description
      A person's name, broken into salutation, first, middle initial, last and suffix.
      - firststringrequired
        Example
        John
        Description
        The first name of the individual being addressed.
      - laststringrequired
        Example
        Smith
        Description
        The last name of the individual being addressed.
      - middleInitialstring
        Example
        D.
        Description
        The middle initial of the individual being addressed.
      - salutationstring
        Example
        Capt.
        Description
        The salutation of the individual being addressed.
      - suffixstring
        Example
        Sr.
        Description
        The optional suffix of the individual being addressed.
    - businessNamestring
    - phoneNumberstring
  - addressToAddress
    Description
    Standardized format for global addresses.
    - street1stringrequired
    - street2string
    - citystringrequired
    - countystring
    - stateOrRegionstringrequired
    - countrystringrequired
      Description
      Defaults to US.
      Min Length
      2
      Max Length
      2
    - postalCodestringrequired
    - poBoxboolean
    - nameName
      Description
      A person's name, broken into salutation, first, middle initial, last and suffix.
      - firststringrequired
        Example
        John
        Description
        The first name of the individual being addressed.
      - laststringrequired
        Example
        Smith
        Description
        The last name of the individual being addressed.
      - middleInitialstring
        Example
        D.
        Description
        The middle initial of the individual being addressed.
      - salutationstring
        Example
        Capt.
        Description
        The salutation of the individual being addressed.
      - suffixstring
        Example
        Sr.
        Description
        The optional suffix of the individual being addressed.
    - businessNamestring
    - phoneNumberstring
  - errorsErrorMessage[]required
    Description
    This represents an array of errors, if applicable.
    - levelstring<INFO | WARN | ERROR>required
      Example
      INFO
      Description
      Level of an error message.
      Allowed
      INFOWARNERROR
    - codestringrequired
      Example
      ERR-123
      Description
      Code of an error message.
    - messagestring
      Example
      Something unexpected happened
      Description
      Message of an error message.
    - detailstring
      Example
      Could not contact other service
      Description
      Details of an error message.
  - idstring<uuid>required
    Example
    8A218593-40EB-4DD0-94BD-8ACA1D95BB14
    Description
    Unique identifier for a cart shipment.
    Format
    uuid
  - locationFromIdstring
    Example
    locationFromId
    Description
    Unique identifier for the location from which a shipment is sent.
  - locationToIdstring
    Example
    locationToId
    Description
    Unique identifier for the location to which a shipment should be sent.
  - packagesShippingPackage[]required
    Description
    This represents shipping packages.
    - dimensionsDimensions
      Description
      Represents the dimensions of a shipping package.
      - widthnumber<double>required
        Example
        10.5
        Description
        The width of the package.
        Format
        double
      - lengthnumber<double>required
        Example
        20
        Description
        The length of the package.
        Format
        double
      - heightnumber<double>required
        Example
        15
        Description
        The height of the package.
        Format
        double
      - unitstring<cm | m | in | mm>required
        Example
        cm
        Description
        The unit of measurement for dimensions.
        Allowed
        cmminmm
    - insuredValuenumber
      Example
      100
      Description
      This represents the value of an insurance.
      Default
      0
    - packageCodestring
      Example
      PackageCode
      Description
      This represents a package code.
      Default
    - weightWeightrequired
      Description
      Represents the weight of a shipping package.
      - valuenumber<double>required
        Example
        2.5
        Description
        The weight value.
        Format
        double
      - unitstring<g | kg | lb>required
        Example
        kg
        Description
        The unit of measurement for the weight.
        Allowed
        gkglb
  - rateServiceCodestring
    Example
    rateServiceCode
    Description
    This represents a rate service code.
  - rateVariantsShippingRate[]required
    Description
    This represents rate variants.
    - carrierCodestringrequired
      Example
      carrierCode
      Description
      Unique identifier for the carrier.
    - carrierDeliveryDatesstringrequired
      Description
      This represents carrier delivery dates or delivery estimation.
    - carrierIdstringrequired
      Example
      DHL
      Description
      Unique identifier for the carrier.
    - deliveryDaysinteger<int32>
      Example
      5
      Description
      This represents a number of days to deliver a shipping.
      Format
      int32
    - estimatedDeliveryDatestring<date-time>
      Example
      2017-07-21T17:32:28Z
      Description
      This represents an estimated date of delivery.
      Format
      date-time
    - packageTypestring
      Example
      packageType
      Description
      This represents a package type.
    - pricingShippingRatePricingrequired
      Description
      This represents a pricing of a shipping rate.
      - confirmationnumber
        Example
        200
        Description
        This represents the confirmation.
      - insurancenumber
        Example
        100
        Description
        This represents the value of an insurance.
      - othernumber
        Example
        10
        Description
        This represents other pricing.
      - shippingnumberrequired
        Example
        100
        Description
        This represents the value of a shipping.
      - feenumber
        Example
        20
        Description
        This represents the sum of all the additional shipping fees.
    - rateIdstringrequired
      Example
      rate1
      Description
      Unique identifier for a shipping rate.
    - serviceCodestringrequired
      Example
      serviceCode
      Description
      This represents a service code.
    - serviceTypestringrequired
      Example
      serviceType
      Description
      This represents a service type.
    - shipDatestring<date-time>
      Example
      2017-07-21T17:32:28Z
      Description
      This represents an actual date of shipping.
      Format
      date-time
  - shippingMethodIdstring<uuid>required
    Description
    Unique identifier for a shipping method.
    Format
    uuid
  - shippingMethodNamestring
    Example
    Standard shipping
    Description
    This represents a shipping method name.
  - shippingMethodTaxCodestring
    Example
    TAX01
    Description
    This represents a tax code for a shipping method.
  - shippingToDistanceDistance
    Description
    This defines a generic distance.
    - valuenumber<double>
      Example
      157.75
      Description
      The numeric portion of the distance.
      Format
      double
    - unitDistanceUnits
      Description
      An enumeration of the supported distance measurements.
  - trackingNumberstring
    Example
    123456789
    Description
    This represents the tracking number.
  - metadatamap<string, string>
    Description
    Additional metadata for the shipment.
  - maxHaulAwayLimitnumber<Int32>
    Format
    Int32
  - haulAwayEnabledbooleanrequired
- shippingAddressAddress
  Description
  Standardized format for global addresses.
  - street1stringrequired
  - street2string
  - citystringrequired
  - countystring
  - stateOrRegionstringrequired
  - countrystringrequired
    Description
    Defaults to US.
    Min Length
    2
    Max Length
    2
  - postalCodestringrequired
  - poBoxboolean
  - nameName
    Description
    A person's name, broken into salutation, first, middle initial, last and suffix.
    - firststringrequired
      Example
      John
      Description
      The first name of the individual being addressed.
    - laststringrequired
      Example
      Smith
      Description
      The last name of the individual being addressed.
    - middleInitialstring
      Example
      D.
      Description
      The middle initial of the individual being addressed.
    - salutationstring
      Example
      Capt.
      Description
      The salutation of the individual being addressed.
    - suffixstring
      Example
      Sr.
      Description
      The optional suffix of the individual being addressed.
  - businessNamestring
  - phoneNumberstring
- stateOrRegionstring
  Example
  California
  Description
  This represents the target state or region.
- haulAwayEnabledbooleanrequired
- maxHaulAwayLimitinteger
  Example
  5
  Description
  The maximum number of haul-away items allowed.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Description
Error payload returned when a request fails validation, identifying the offending input by name, code and detail.
- namestringrequired
- codestringrequired
- detailstring
- reasonstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/shipping-method/rate/cart \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "currency": "USD",
     "distanceUnit": "",
     "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
     "items": [
     {
     "catalogItemId": "catalogItemId",
     "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
     "pricing": {
     "basePrice": {
     "price": "",
     "type": "",
     "zone": ""
     },
     "feePriceAdjustments": [
     {
     "id": "",
     "value": ""
     }
     ],
     "promotionPriceAdjustments": [
     {
     "id": "",
     "value": ""
     }
     ],
     "taxPriceAdjustment": {
     "taxCode": ""
     }
     },
     "productItemSkuId": "SKU_item1",
     "quantity": 1,
     "shipmentId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
     }
     ],
     "shipments": [
     {
     "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
     "shippingMethodId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
     }
     ],
     "shippingAddress": {
     "street1": "",
     "city": "",
     "stateOrRegion": "",
     "country": "",
     "postalCode": "",
     "name": {
     "first": "John",
     "last": "Smith"
     }
     },
     "shippingCoordinates": {
     "latitude": 37.7749,
     "longitude": -122.4194
     },
     "pricing": {
     "promotionPriceAdjustments": [
     {
     "id": "",
     "value": "",
     "itemIds": []
     }
     ]
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "currency": "USD",
   "distanceUnit": "",
   "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
   "items": [
      {
         "catalogItemId": "catalogItemId",
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "feePriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         },
         "productItemSkuId": "SKU_item1",
         "quantity": 1,
         "shipmentId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shipments": [
      {
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "shippingMethodId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shippingAddress": {
      "street1": "",
      "city": "",
      "stateOrRegion": "",
      "country": "",
      "postalCode": "",
      "name": {
         "first": "John",
         "last": "Smith"
      }
   },
   "shippingCoordinates": {
      "latitude": 37.7749,
      "longitude": -122.4194
   },
   "pricing": {
      "promotionPriceAdjustments": [
         {
            "id": "",
            "value": "",
            "itemIds": []
         }
      ]
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/shipping-method/rate/cart", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/shipping-method/rate/cart")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "currency": "USD",
   "distanceUnit": "",
   "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
   "items": [
      {
         "catalogItemId": "catalogItemId",
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "feePriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         },
         "productItemSkuId": "SKU_item1",
         "quantity": 1,
         "shipmentId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shipments": [
      {
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "shippingMethodId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shippingAddress": {
      "street1": "",
      "city": "",
      "stateOrRegion": "",
      "country": "",
      "postalCode": "",
      "name": {
         "first": "John",
         "last": "Smith"
      }
   },
   "shippingCoordinates": {
      "latitude": 37.7749,
      "longitude": -122.4194
   },
   "pricing": {
      "promotionPriceAdjustments": [
         {
            "id": "",
            "value": "",
            "itemIds": []
         }
      ]
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/shipping-method/rate/cart"

payload = json.dumps({
   "currency": "USD",
   "distanceUnit": "",
   "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
   "items": [
      {
         "catalogItemId": "catalogItemId",
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "feePriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         },
         "productItemSkuId": "SKU_item1",
         "quantity": 1,
         "shipmentId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shipments": [
      {
         "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
         "shippingMethodId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
      }
   ],
   "shippingAddress": {
      "street1": "",
      "city": "",
      "stateOrRegion": "",
      "country": "",
      "postalCode": "",
      "name": {
         "first": "John",
         "last": "Smith"
      }
   },
   "shippingCoordinates": {
      "latitude": 37.7749,
      "longitude": -122.4194
   },
   "pricing": {
      "promotionPriceAdjustments": [
         {
            "id": "",
            "value": "",
            "itemIds": []
         }
      ]
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Success-shipping-rate calculation returned.
{
  "country": "USA",
  "currency": "USD",
  "errors": [
    {
      "level": "INFO",
      "code": "ERR-123",
      "message": "Something unexpected happened",
      "detail": "Could not contact other service"
    }
  ],
  "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
  "items": [
    {
      "catalogItemId": "catalogItemId",
      "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
      "pricing": {
        "basePrice": {
          "price": 0,
          "type": "",
          "zone": ""
        },
        "feePriceAdjustments": [
          {
            "id": "",
            "value": 0
          }
        ],
        "promotionPriceAdjustments": [
          {
            "id": "",
            "value": 0
          }
        ],
        "taxPriceAdjustment": {
          "taxCode": "",
          "value": 0
        }
      },
      "productItemSkuId": "SKU_item1",
      "quantity": 1,
      "shipmentId": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14"
    }
  ],
  "locationId": "locationToId",
  "postalCode": "43234",
  "shipments": [
    {
      "addressFrom": {
        "street1": "",
        "street2": "",
        "city": "",
        "county": "",
        "stateOrRegion": "",
        "country": "",
        "postalCode": "",
        "poBox": false,
        "name": {
          "first": "John",
          "last": "Smith",
          "middleInitial": "D.",
          "salutation": "Capt.",
          "suffix": "Sr."
        },
        "businessName": "",
        "phoneNumber": ""
      },
      "addressTo": {
        "street1": "",
        "street2": "",
        "city": "",
        "county": "",
        "stateOrRegion": "",
        "country": "",
        "postalCode": "",
        "poBox": false,
        "name": {
          "first": "John",
          "last": "Smith",
          "middleInitial": "D.",
          "salutation": "Capt.",
          "suffix": "Sr."
        },
        "businessName": "",
        "phoneNumber": ""
      },
      "errors": [
        {
          "level": "INFO",
          "code": "ERR-123",
          "message": "Something unexpected happened",
          "detail": "Could not contact other service"
        }
      ],
      "id": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
      "locationFromId": "locationFromId",
      "locationToId": "locationToId",
      "packages": [
        {
          "dimensions": {
            "width": 10.5,
            "length": 20,
            "height": 15,
            "unit": "cm"
          },
          "insuredValue": 100,
          "packageCode": "PackageCode",
          "weight": {
            "value": 2.5,
            "unit": "kg"
          }
        }
      ],
      "rateServiceCode": "rateServiceCode",
      "rateVariants": [
        {
          "carrierCode": "carrierCode",
          "carrierDeliveryDates": "",
          "carrierId": "DHL",
          "deliveryDays": 5,
          "estimatedDeliveryDate": "2017-07-21T17:32:28Z",
          "packageType": "packageType",
          "pricing": {
            "confirmation": 200,
            "insurance": 100,
            "other": 10,
            "shipping": 100,
            "fee": 20
          },
          "rateId": "rate1",
          "serviceCode": "serviceCode",
          "serviceType": "serviceType",
          "shipDate": "2017-07-21T17:32:28Z"
        }
      ],
      "shippingMethodId": "",
      "shippingMethodName": "Standard shipping",
      "shippingMethodTaxCode": "TAX01",
      "shippingToDistance": {
        "value": 157.75,
        "unit": ""
      },
      "trackingNumber": "123456789",
      "metadata": "",
      "maxHaulAwayLimit": "",
      "haulAwayEnabled": false
    }
  ],
  "shippingAddress": {
    "street1": "",
    "street2": "",
    "city": "",
    "county": "",
    "stateOrRegion": "",
    "country": "",
    "postalCode": "",
    "poBox": false,
    "name": {
      "first": "John",
      "last": "Smith",
      "middleInitial": "D.",
      "salutation": "Capt.",
      "suffix": "Sr."
    },
    "businessName": "",
    "phoneNumber": ""
  },
  "stateOrRegion": "California",
  "haulAwayEnabled": false,
  "maxHaulAwayLimit": 5
}

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}