Skip to main content
GET
/
shipping
/
couriers
List available couriers
curl --request GET \
  --url https://api.salesive.com/api/v1/shipping/couriers \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "List available couriers",
  "data": [
    {
      "courier_id": "dhl",
      "name": "DHL Express",
      "image": "https://cdn.example.com/dhl.png"
    },
    {
      "courier_id": "gig",
      "name": "GIG Logistics",
      "image": "https://cdn.example.com/gig.png"
    }
  ]
}
Returns the list of couriers available from the carrier aggregator. Returns a bare array 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.

Response

List available couriers.

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[]