Skip to main content
GET
/
shipping
/
rates
Fetch live courier rates for an order
curl --request GET \
  --url https://api.salesive.com/api/v1/shipping/rates \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Fetch live courier rates for an order",
  "data": [
    {
      "courier_id": "dhl",
      "courier_name": "DHL Express",
      "courier_image": "https://cdn.example.com/dhl.png",
      "service_code": "dhl_express",
      "service_type": "express",
      "total": 2500,
      "delivery_eta": "1-2 days",
      "delivery_eta_time": "2026-06-30T17:00:00.000Z",
      "is_cod_available": false
    }
  ]
}
Fetches live courier shipping rates from the connected carrier aggregator for the given order and buyer shipping address, and caches them so a shipment can subsequently be created with a selected rate. Returns a bare array of courier rate objects as data. Requires the READ_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

shippingAddressId
string
required

ObjectId of the buyer's shipping address.

orderId
string
required

ObjectId of the order to rate.

Response

Fetch live courier rates for an order.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object[]