v2

latestOpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Orders

Update shipment receipt data

Requires the order:update scope. Update shipment receipt / tracking ID for an order.

patch/v3/orders/{id}/shipment-receipt

Request body

shipment_receiptstring required

Response

Receipt updated successfully

idstring uuid

Canonical UUIDv7 order primary key returned by the partitioned orders table.

order_idstring

Order ID in string format

public_order_urlstring uri nullable

Public order URL built from metadata.custom_domain_full_url and secret_slug.

payment_urlstring uri nullable

Payment URL built from public_order_url with /success appended.

shipment_receiptstring nullable

Shipment receipt URL