Shipping options

PreviousPayment methods NextWeb checkout

Last updated 8 months ago

Get a shipping option by ID

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

get

/v1/shoppers/me/carts/active/shipping-options/{shippingOptionsId}

Path parameters

shippingOptionsIdstringrequired

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

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-options/{shippingOptionsId}'

200

401

404

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

Successful response.

Retrieve all shipping options

Get the available shipping options.

get

/v1/shoppers/me/carts/active/shipping-options