Agency Delivery Information

Get Orders By Status

get

https://test.swooveapi.comhttps://live.swooveapi.com

/agency/get-orders/

Returns a paginated list of deliveries filtered by date and status.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

from_dateinteger · int64Optional

Start of delivery range in timestamp format (ms)

to_dateinteger · int64Optional

End of delivery range in timestamp format (ms)

page_numberintegerOptional

Page number

Default: 1

statusstring · enumOptional

Filter orders by delivery status. UNASSIGNED, ACTIVE, ALL, OUTSOURCED, or specific statuses like PICKUP, ENDED, RETURNED, etc.

Possible values:

limitsintegerOptional

Number of deliveries to return per page

Default: 10

Responses

200

List of Deliveries

application/json

Responseall of

401

Unauthorized – missing or invalid token

application/json

get

/agency/get-orders/

HTTPcURLJavaScriptPython

GET /agency/get-orders/ HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "limit": 1,
  "page": 1,
  "pages": 1,
  "docs": [
    {
      "pickup": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "dropoff": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "items": [
        {
          "itemName": "text",
          "itemQuantity": 1,
          "itemCost": 1,
          "description": "text",
          "itemImages": [
            "text"
          ],
          "itemWeight": 1,
          "is_fragile": false,
          "dimensions": {
            "x": 1,
            "y": 1,
            "z": 1
          }
        }
      ],
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "instructions": "text",
      "reference": "text",
      "estimate_id": "text"
    }
  ]
}