Shipping Companies

As an Admin, you can view shipping companies via the API.

List Shipping Companies

GET/shipping-companies Bearer Token

Retrieve a paginated list of shipping companies.

Parameter	Type	Required	Description
per_page	number	No	Results per page

Response

Success (200):

{
  "data": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Express Delivery",
      "status": "active",
      "can_track_status": true
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 8,
      "pages": 1
    }
  }
}

Show Shipping Company

GET/shipping-companies/{id}/show Bearer Token

Retrieve a single shipping company by ID.

Response

Success (200):

{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "name": "Express Delivery",
    "status": "active",
    "can_track_status": true,
    "created_at": "2025-01-10T08:00:00Z",
    "updated_at": "2025-01-10T08:00:00Z"
  },
  "meta": {}
}

Not found (404):

{
  "error": {
    "code": "HTTP_ERROR",
    "message": "Resource not found."
  }
}