LogoLogo
System Status
2021-12-13
2021-12-13
  • 2021-12-13
  • Charges
    • Charge basics
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File Links
    • File link basics
  • Files
    • File basics
  • Fulfillments
  • Fulfillment cancellations
  • Fulfillment orders
  • Fulfillment returns
  • Inventory items
  • Inventory levels
  • Invoices
    • Invoice basics
  • Logistics returns
  • Orders
    • Order basics
  • Payouts
  • Plans
    • Plan basics
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping labels
  • Shipping quotes
  • SKUs
  • SKU Groups
  • Sources
  • Subscriptions
    • Subscription basics
  • Tax identifiers
  • Webhooks
  • Drop-in checkout links
  • Drop-in checkout sessions
    • Checkout-sessions basics
  • Drop-in shipping quotes
  • Store credit callout
Powered by GitBook
On this page

Drop-in shipping quotes

PreviousCheckout-sessions basicsNextStore credit callout

Last updated 6 months ago

The Drop-in Shipping Quotes resource provides a seamless integration for retrieving real-time shipping costs directly within your application. It enables developers to access up-to-date shipping information from multiple carriers, empowering businesses to offer accurate pricing to their customers at checkout. The resource is designed to be easy to use, requiring minimal setup while offering robust and customizable features to fit diverse shipping needs.

Returns shipping method quotes

post

Get all available shipping method quotes

Body
sessionIdstringRequired

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

Example: 7765374748
sessionUpstreamIdstringOptional

The upstreamId of the checkout-session associated with the shipping quotes request.

Example: 8234373746
currencystringRequired

A three-letter ISO currency code.

Example: USD
Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /checkout/shipping-quotes HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 1448

{
  "sessionId": "7765374748",
  "sessionUpstreamId": "8234373746",
  "currency": "USD",
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "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,
          "sundayDelivery": false
        },
        "supportCutoffTime": "180000"
      },
      "amount": 5.99,
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ]
}
{
  "shipments": [
    {
      "itemIds": [
        "1234-4567-7890-12345"
      ],
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "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,
          "sundayDelivery": false
        },
        "supportCutoffTime": "180000"
      },
      "amount": 5.99,
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      }
    }
  ],
  "liveMode": false
}