API Portal

WMS Portal

Rate Inquiry

This API is used to get shipping rates for available channels. If serviceCodes is not specified, the system will return rates for all channels available under the current account.

Request URL

/shipment/rates

Request Method

POST

Request Body Parameters

Parameter NameExampleTypeRequiredDescription
sellerOrderNumberTESTORDER-001StringNoSales order number
serviceCodes[]ArrayNoList of service codes. If omitted, all available services are queried.
shipFrom (Object) — Sender’s address
code–StringNoSender address code
nameTESTStringYesSender company or name
attentionNameTESTStringNoContact person
countryCodeUSStringYes2-letter country code
stateCodeCAStringYes2-letter state code
cityrowland heightStringYesCity
addressLine1testStringYesAddress line 1
addressLine2–StringNoAddress line 2
postalCode91748StringYesZIP/Postal code
phone0000000000StringYesPhone number
phoneExtension0000StringNoPhone extension
isResidentialfalseBooleanYesIs it a residential address
shipTo (Object) — Recipient’s address
nameTESTStringYesRecipient company or name
attentionNameTESTStringNoContact person
countryCodeUSStringYes2-letter country code
stateCodeCAStringYes2-letter state code
cityrowland heightStringYesCity
addressLine1testStringYesAddress line 1
addressLine2–StringYesAddress line 2
postalCode91748StringYesZIP/Postal code
phone0000000000StringYesPhone number
phoneExtension0000000000StringNoPhone extension
isResidentialtrueBooleanYesIs it a residential address
packages (Object) — Package information
length10NumberYesPackage length
width10NumberYesPackage width
height10NumberYesPackage height
weight14NumberYesPackage weight (per unit)
quantity1NumberYesQuantity of packages
declaredValue100NumberNoDeclared insurance value (USD)
reference1REF01StringNoReference number 1
reference2–StringNoReference number 2
options (Object) — Shipment options
dimensionUnitCodeINStringYesDimension unit (use “IN” for inches)
weightUnitCodeLBSStringYesWeight unit (use “LBS” for pounds)
packageTypecustomPackageStringNoPackage type (default: customPackage)
shipDate2022-05-14StringNoShipping date (YYYY-MM-DD)
deliveryConfirmationsignatureStringNoSignature service (none, signature, or adultSignature)

Request Example

{
  "sellerOrderNumber": "TESTORDER-001",
  "serviceCodes": [],
  "shipFrom": {
    "code": "",
    "name": "TEST",
    "attentionName": "TEST",
    "countryCode": "US",
    "stateCode": "CA",
    "city": "rowland height",
    "addressLine1": "test",
    "addressLine2": "",
    "postalCode": "91748",
    "phone": "0000000000",
    "phoneExtension": "0000",
    "isResidential": false
  },
  "shipTo": {
    "name": "TEST",
    "attentionName": "TEST",
    "countryCode": "US",
    "stateCode": "CA",
    "city": "rowland height",
    "addressLine1": "test",
    "addressLine2": "",
    "postalCode": "91748",
    "phone": "0000000000",
    "phoneExtension": "0000000000",
    "isResidential": true
  },
  "packages": [
    {
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 14,
      "quantity": 1,
      "declaredValue": 100,
      "reference1": "REF01",
      "reference2": ""
    }
  ],
  "options": {
    "dimensionUnitCode": "IN",
    "weightUnitCode": "LBS",
    "packageType": "customPackage",
    "shipDate": "2022-05-14",
    "deliveryConfirmation": "signature"
  }
}

Response Example

{
  "code": 200,
  "data": {
    "rates": [
      {
        "rateId": "rate_clrt0d0o2hotek12v7u0",
        "rate": 13.06,
        "chargeItems": null,
        "currencyCode": "USD",
        "carrierCode": "FedEx",
        "carrierName": "FedEx",
        "serviceCode": "FedExGround",
        "accountCode": "FedEx",
        "isCubic": false
      }
    ],
    "messages": null
  },
  "message": "success"
}