Partially update a delivery

PATCH

/orders/{external_order_id}

curl --request PATCH \
  --url https://api.govza.app/v1/partner/orders/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "pickup": { "address": {}, "contact": {} }, "dropoffs": [ { "address": {}, "contact": {}, "index": 1, "cargo_size": "S", "payment_type": "cash", "payment_amount": 1, "doorstep": true } ], "quote_id": "example", "cargo_size": "S", "routing_mode": "parallel", "payment_type": "cash", "payment_amount": 1, "delivery_time": "2026-04-15T12:00:00Z", "comment": "example" }'

Updates only the fields supplied while the order status is new or assigned. Nested address and contact fields are merged with the stored order. Send only the dropoffs that changed; use index to target a specific dropoff in a multi-dropoff order.

Authorizations

• apiKey

Parameters

Path Parameters

external_order_id

required

string

<= 128 characters

Your own identifier for the order.

Request Body^required

Media typeapplication/json

Send only the fields to change. Nested address and contact objects are merged with the stored values. Send only changed dropoffs. Set index to their zero-based position when targeting a specific dropoff; if omitted, array position is used.

object

pickup

object

address

object

key

additional properties

any

contact

object

key

additional properties

any

dropoffs

Array<object>

object

address

object

key

additional properties

any

contact

object

key

additional properties

any

index

Zero-based position of the dropoff to update.

integer

<= 9

cargo_size

string

Allowed values: S M L XL

payment_type

string

Allowed values: cash card

payment_amount

number

nullable

doorstep

boolean

quote_id

string

cargo_size

string

Allowed values: S M L XL

routing_mode

string

Allowed values: parallel sequential

payment_type

string

Allowed values: cash card

payment_amount

number

nullable

delivery_time

string format: date-time

nullable

comment

string

nullable <= 2000 characters

Responses

200

The delivery was updated.

Media typeapplication/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. 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 in dropoff order. Null for a single-dropoff order or when unavailable.

Array<string>

nullable

Example

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

400

The payload was rejected. error.details is a JSON array of { field, message } covering every offending field, not just the first, so one response is enough to fix the request.

Media typeapplication/json

object

success

boolean

error

object

id

string

code

string

message

string

details

string

Example

{
  "success": false,
  "error": {
    "id": "validation.partner_payload_invalid",
    "message": "dropoffs.0.address.latitude: latitude is required",
    "details": "[{\"field\":\"dropoffs.0.address.latitude\",\"message\":\"latitude is required\"}]"
  }
}

401

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

Media typeapplication/json

object

success

boolean

error

object

id

string

code

string

message

string

details

string

Example

{
  "success": false
}

404

No order exists for this external_order_id.

Media typeapplication/json

object

success

boolean

error

object

id

string

code

string

message

string

details

string

Example

{
  "success": false
}