Carriers API
Look up the carriers that Easel recognizes. Carrier IDs are used when creating
and updating fulfillments.
Endpoints
- List Carriers -
GET /api/v1/carriers/
List Carriers
Retrieve the full list of carriers. This endpoint is not paginated.
Endpoint: GET /api/v1/carriers/
Permission Required: Read
Request
curl -X GET "https://studio.easel.engineering/api/v1/carriers/" \
-H "Authorization: Bearer your_api_key_here"
Response
Status: 200 OK
{
"data": [
{
"id": 1,
"name": "17 Post Service"
},
{
"id": 2,
"name": "2ebox"
}
]
}
The list is ordered by name. IDs are stable, but new carriers may be added
over time, so always use the id returned by this endpoint rather than
assuming a value.
Error Responses
Failed to list carriers
Status: 500 Internal Server Error
{
"error": "Internal server error",
"code": "INTERNAL_ERROR"
}
Carrier Object
Fields
| Field | Type | Description |
|---|---|---|
id |
integer | Carrier ID, used when creating or updating a fulfillment |
name |
string | Carrier name |