Rate Shopping

POST/api/v3/rates/shop

Shop shipping rates across all enabled carrier accounts

Queries every enabled carrier account in parallel, normalizes the quotes, applies each account's service allow-list and markup, filters by the given constraints, and returns all surviving quotes sorted best-first per the strategy. Carriers that fail or time out are reported per-account in failures without blocking the shop.

Request body (optional)

shipmentobjectrequired

shipFromobjectrequired

countryCodestringrequired

postalCodestringrequired

citystring

stateOrProvinceCodestring

residentialboolean

shipToobjectrequired

countryCodestringrequired

postalCodestringrequired

citystring

stateOrProvinceCodestring

residentialboolean

packagesobject[]required

weightnumberrequired

lengthnumber

widthnumber

heightnumber

shipDatestring

unitsenum

imperialmetric

optionsobject

strategyenum

cheapestfastestbest_value

deliverBystring

maxTransitDaysinteger

guaranteedOnlyboolean

carriersenum[]

Responses

200Shop result (quotes sorted best-first)

strategyenumrequired

cheapestfastestbest_value

bestobjectrequired

accountIdstringrequired

accountNamestringrequired

carrierenumrequired

upsfedexuspsdhl_expressamazon_shipping

modeenumrequired

emulatedsandboxlive

serviceCodestringrequired

serviceNamestringrequired

rateTypeenumrequired

accountlist

currencystringrequired

totalChargenumberrequired

customerPricenumberrequired

billableWeightobject

valuenumberrequired

unitenumrequired

lbkg

transitDaysnumber

estimatedDeliveryAtstring

guaranteedbooleanrequired

purchaseRefobject

requestTokenstringrequired

rateIdstringrequired

quotesobject[]required

accountIdstringrequired

accountNamestringrequired

carrierenumrequired

upsfedexuspsdhl_expressamazon_shipping

modeenumrequired

emulatedsandboxlive

serviceCodestringrequired

serviceNamestringrequired

rateTypeenumrequired

accountlist

currencystringrequired

totalChargenumberrequired

customerPricenumberrequired

billableWeightobject

valuenumberrequired

unitenumrequired

lbkg

transitDaysnumber

estimatedDeliveryAtstring

guaranteedbooleanrequired

purchaseRefobject

requestTokenstringrequired

rateIdstringrequired

constraintMetbooleanrequired

failuresobject[]required

accountIdstringrequired

accountNamestringrequired

carrierenumrequired

upsfedexuspsdhl_expressamazon_shipping

modeenumrequired

emulatedsandboxlive

errorstringrequired

metaobjectrequired

requestIdstringrequired

durationMsnumberrequired

400Invalid shipment input

errorstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X POST 'https://v3.revolutionstreetwxs.io/api/v3/rates/shop' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "shipment": {
    "shipFrom": {
      "countryCode": "US",
      "postalCode": "02110",
      "city": "Boston",
      "stateOrProvinceCode": "state or province code",
      "residential": true
    },
    "shipTo": {
      "countryCode": "US",
      "postalCode": "02110",
      "city": "Boston",
      "stateOrProvinceCode": "state or province code",
      "residential": true
    },
    "packages": [
      {
        "weight": 2.5,
        "length": 12,
        "width": 12,
        "height": 12
      }
    ],
    "shipDate": "ship date",
    "units": "imperial"
  },
  "options": {
    "strategy": "cheapest",
    "deliverBy": "deliver by",
    "maxTransitDays": 1,
    "guaranteedOnly": true,
    "carriers": [
      "ups"
    ]
  }
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/rates/shop", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "shipment": {
      "shipFrom": {
        "countryCode": "US",
        "postalCode": "02110",
        "city": "Boston",
        "stateOrProvinceCode": "state or province code",
        "residential": true
      },
      "shipTo": {
        "countryCode": "US",
        "postalCode": "02110",
        "city": "Boston",
        "stateOrProvinceCode": "state or province code",
        "residential": true
      },
      "packages": [
        {
          "weight": 2.5,
          "length": 12,
          "width": 12,
          "height": 12
        }
      ],
      "shipDate": "ship date",
      "units": "imperial"
    },
    "options": {
      "strategy": "cheapest",
      "deliverBy": "deliver by",
      "maxTransitDays": 1,
      "guaranteedOnly": true,
      "carriers": [
        "ups"
      ]
    }
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/rates/shop",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "shipment": {
        "shipFrom": {
          "countryCode": "US",
          "postalCode": "02110",
          "city": "Boston",
          "stateOrProvinceCode": "state or province code",
          "residential": True
        },
        "shipTo": {
          "countryCode": "US",
          "postalCode": "02110",
          "city": "Boston",
          "stateOrProvinceCode": "state or province code",
          "residential": True
        },
        "packages": [
          {
            "weight": 2.5,
            "length": 12,
            "width": 12,
            "height": 12
          }
        ],
        "shipDate": "ship date",
        "units": "imperial"
      },
      "options": {
        "strategy": "cheapest",
        "deliverBy": "deliver by",
        "maxTransitDays": 1,
        "guaranteedOnly": True,
        "carriers": [
          "ups"
        ]
      }
    },
)
data = response.json()

Response 200

{
  "strategy": "cheapest",
  "best": {
    "accountId": "account id",
    "accountName": "account name",
    "carrier": "ups",
    "mode": "emulated",
    "serviceCode": "service code",
    "serviceName": "service name",
    "rateType": "account",
    "currency": "currency",
    "totalCharge": 1.5,
    "customerPrice": 1.5,
    "billableWeight": {
      "value": 1.5,
      "unit": "lb"
    },
    "transitDays": 1.5,
    "estimatedDeliveryAt": "estimated delivery at",
    "guaranteed": true,
    "purchaseRef": {
      "requestToken": "request token",
      "rateId": "rate id"
    }
  },
  "quotes": [
    {
      "accountId": "account id",
      "accountName": "account name",
      "carrier": "ups",
      "mode": "emulated",
      "serviceCode": "service code",
      "serviceName": "service name",
      "rateType": "account",
      "currency": "currency",
      "totalCharge": 1.5,
      "customerPrice": 1.5,
      "billableWeight": {
        "value": 1.5,
        "unit": "lb"
      },
      "transitDays": 1.5,
      "estimatedDeliveryAt": "estimated delivery at",
      "guaranteed": true,
      "purchaseRef": {
        "requestToken": "request token",
        "rateId": "rate id"
      }
    }
  ],
  "constraintMet": true,
  "failures": [
    {
      "accountId": "account id",
      "accountName": "account name",
      "carrier": "ups",
      "mode": "emulated",
      "error": "error"
    }
  ],
  "meta": {
    "requestId": "request id",
    "durationMs": 1.5
  }
}