List deliveries

GET

/orders

const url = 'https://api.govza.app/v1/delivery/orders?limit=20&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.govza.app/v1/delivery/orders?limit=20&offset=0' \
  --header 'Authorization: Bearer <token>'

Returns this API account’s deliveries, newest first.

Authorizations

apiKey

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

Number of deliveries to return.

offset

integer

Number of newest deliveries to skip.

Responses

200

The account’s deliveries.

application/json

object

success

boolean

data

object

orders

Array<object>

object

external_order_id

string

order_code

The human-readable Govza order code.

string

status

string

Allowed values: new assigned in_progress delivered cancelled

price

number

nullable

tracking_url

Public tracking page, safe to forward to the recipient. Expires 24 hours after the order is delivered or cancelled. Present on create; when reading or listing, null if the order has no link yet — reads never create one. Use POST /orders/{external_order_id}/tracking_link to issue one.

string

nullable

tracking_urls

Individual tracking pages, one per dropoff in your order, whatever order they are visited in. Null for a single-dropoff order or when unavailable.

Array<string>

nullable

visit_order

Zero-based positions in your dropoffs array, in the order the courier visits them. Everything else stays in your order: quote legs, tracking_urls and index in PATCH.

Array<integer>

limit

integer

offset

integer

Example

{
  "data": {
    "orders": [
      {
        "status": "new",
        "visit_order": [
          2,
          0,
          1
        ]
      }
    ]
  }
}

401

The key is missing, malformed, revoked, or its account can no longer create orders.

application/json

object

success

boolean

error

object

string

code

string

message

string

details

string

Example

{
  "success": false
}