Retrieve shipping options

Get a shipping option by ID

To get a shipping option by ID, specify the shipping option ID in the {shippingOptionId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options/{shippingOptionsId}

Path parameters

shippingOptionsId*string

Provide the identifier of the shipping option chosen for the cart.

Query parameters

Response

200401404

Successful response.

Body

application/json

one of

DefaultShippingOption (object)ExpandedShippingOption (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options/{shippingOptionsId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "shippingOption": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options/142400",
    "id": 142400,
    "description": "UPS Ground",
    "cost": {
      "currency": "USD",
      "value": "19.99"
    },
    "formattedCost": "19.99USD",
    "applyShippingOptionToCart": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/apply-shipping-option?shippingOptionId=142400"
    }
  }
}

Retrieve all shipping options

Use this method to get the available shipping options.

GEThttps://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultShippingOptions (object)ExpandedShippingOptions (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "shippingOptions": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options",
    "shippingOption": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options/5858800",
        "description": "UPS",
        "formattedCost": "19.99USD",
        "applyShippingOptionToCart": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/apply-shipping-option?shippingOptionId=5858800"
        }
      }
    ]
  }
}