Skip to main content
POST
shipping.delivery.instructions.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
trackingNumber
string
required

Printed shipment tracking number in your own carrier account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9-]+$
instruction
enum<string>
required

Requested delivery action.

Available options:
reattempt,
return-to-origin,
reschedule-pickup,
defer-delivery,
update-delivery-details
confirm
boolean
required

Confirm delivery instruction.

date
string<date>

Local calendar date, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
slot
string

Requested slot.

Required string length: 1 - 100
address
object

Delivery address patch.

phone
string

Updated delivery phone.

Required string length: 1 - 30
remarks
string

Requested remarks.

Required string length: 1 - 500

Response

The result

trackingNumber
string
required

Printed shipment tracking number in your own carrier account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9-]+$
state
enum<string>
required

Instruction request state after one status check.

Available options:
accepted,
pending,
failed