Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Drop-in Shipping Quotes

Returns shipping method quotes

Get all available shipping method quotes

post/checkout/shipping-quotes

Request body

sessionIdstring required

The identifier of the checkout session associated with the shipping quotes request.

sessionUpstreamIdstring

The <code>upstreamId</code> of the checkout-session associated with the shipping quotes request.

currencystring required

A three-letter ISO currency code.

Example request

{
  "sessionId": "7765374748",
  "sessionUpstreamId": "8234373746",
  "currency": "USD",
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "items": [
    {
      "id": "abc",
      "amount": 9.99,
      "quantity": 1,
      "sku": {
        "id": "sku_5823594809",
        "eccn": "EAR99",
        "taxCode": "4323.310_A",
        "name": "Athena Womens Running Shoes",
        "image": "https://imageurl.com",
        "url": "https://producturl.com",
        "physical": true,
        "metadata": {
          "coupon": "iOS"
        }
      },
      "logisticsOptions": {
        "deliveryOptions": [
          "[\"direct_delivery_only\",\"additional_handling\"]"
        ],
        "dangerousGoods": [
          "nimh_battery"
        ]
      }
    }
  ],
  "shippingMethods": [
    {
      "id": "65",
      "description": "Standard",
      "serviceLevel": "Standard",
      "shippingTerms": "DDP",
      "deliveryInformation": {
        "businessDaysInTransit": "3 - 5 Business Days",
        "estimatedArrival": {
          "date": "2018-04-25T20:36:00Z",
          "dayOfWeek": "Tuesday"
        },
        "pickupDate": "2018-04-25T20:36:00Z",
        "weekendService": {
          "saturdayDelivery": true
        },
        "supportCutoffTime": "180000"
      },
      "amount": 5.99,
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ]
}

Response

200 OK

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "shipments": [
    {
      "itemIds": [
        "1234-4567-7890-12345"
      ],
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ],
  "shippingMethods": [
    {
      "id": "65",
      "description": "Standard",
      "serviceLevel": "Standard",
      "shippingTerms": "DDP",
      "deliveryInformation": {
        "businessDaysInTransit": "3 - 5 Business Days",
        "estimatedArrival": {
          "date": "2018-04-25T20:36:00Z",
          "dayOfWeek": "Tuesday"
        },
        "pickupDate": "2018-04-25T20:36:00Z",
        "weekendService": {
          "saturdayDelivery": true
        },
        "supportCutoffTime": "180000"
      },
      "amount": 5.99,
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ]
}