Read a delivery

GET

/orders/{external_order_id}

const url = 'https://api.govza.app/v1/partner/orders/example';
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/partner/orders/example \
  --header 'Authorization: Bearer <token>'

Authorizations

apiKey

Parameters

Path Parameters

external_order_id

required

string

<= 128 characters

Your own identifier for the order.

Responses

200

The current state of the delivery.

application/json

object

success

boolean

data

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.

string

nullable

tracking_urls

Individual tracking pages in dropoff order. Null for a single-dropoff order or when unavailable.

Array<string>

nullable

status_changes

Array<object>

object

Example

{
  "data": {
    "status": "new"
  }
}

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
}

404

No order exists for this external_order_id.

application/json

object

success

boolean

error

object

string

code

string

message

string

details

string

Example

{
  "success": false
}