Get shipping rate quotes

POST

/shipping/v4/shipments/rates

POST

/seller/v1/shipping/v4/shipments/rates

curl -X POST https://marketplace.walmart.com/seller/v1/shipping/v4/shipments/rates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "shipTo": {
    "name": "string",
    "addressLine1": "string",
    "city": "string",
    "stateOrRegion": "string",
    "postalCode": "string",
    "countryCode": "US"
  },
  "shipFrom": {
    "name": "string",
    "addressLine1": "string",
    "city": "string",
    "stateOrRegion": "string",
    "postalCode": "string",
    "countryCode": "US"
  },
  "packages": [
    {
      "dimensions": {
        "length": 1.1,
        "width": 1.1,
        "height": 1.1,
        "unit": "inches"
      },
      "weight": {
        "value": 1.1,
        "unit": "oz"
      },
      "packageClientReferenceId": "string"
    }
  ],
  "channelDetails": {
    "channelType": "WALMART_MARKETPLACE"
  }
}'

{
  "payload": {
    "rates": [
      {
        "rateId": "string",
        "carrier": {
          "id": "string",
          "name": "string"
        },
        "service": {
          "id": "string",
          "name": "string"
        },
        "totalCharge": {
          "amount": "string",
          "currencyCode": "USD"
        },
        "billedWeight": {
          "value": 1.1,
          "unit": "oz"
        },
        "expirationTime": "2024-01-15T09:30:00Z",
        "promise": {
          "deliveryWindow": {
            "start": "2024-01-15T09:30:00Z",
            "end": "2024-01-15T09:30:00Z"
          },
          "pickupWindow": {
            "start": "2024-01-15T09:30:00Z",
            "end": "2024-01-15T09:30:00Z"
          }
        },
        "supportedDocumentSpecifications": [
          {}
        ],
        "availableValueAddedServices": [
          {}
        ]
      }
    ],
    "ineligibleRates": [
      {
        "carrierName": "string",
        "serviceName": "string",
        "ineligibilityReasons": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    ],
    "requestToken": "string"
  }
}

Returns a list of shipping rate quotes for the given shipment request. The seller can then call purchaseShipment with the selected rateId to commit to a label purchase.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

shipToobjectRequired

shipFromobjectRequired

packageslist of objectsRequired

channelDetailsobjectRequired

returnToobjectOptional

shipDatedatetimeOptional

When the shipment will be tendered to the carrier.

serviceSelectionobjectOptional

Optional seller-supplied filter to restrict the rate quote to a specific carrier(s) and/or service(s).

valueAddedServiceslist of objectsOptional

Response

Rate quotes returned successfully

payloadobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error