Printago API
PUT /v1/orders/{orderId}

Update an order

Requires: order.edit

Path Parameters

orderId required
string
The order's unique identifier

Request Body

Fields to update on the order

PartialOrder
cancelledAtoptional
string
createdAtoptional
string
format: date-time
currencyoptional
string
customerIdoptional
string
customMetadataoptional
Record<string, any>
Construct a type with a set of properties K of type T
deadlineoptional
string
externalIdoptional
string
externalUrloptional
string
idoptional
string
pattern: ^[a-z0-9]{24}$
integrationIdoptional
string
noteoptional
string
orderNumberoptional
string
priceoptional
number
priceBucketoptional
number
processedAtoptional
string
shippedAtoptional
string
sourceoptional
any
sourceRefoptional
string
statusoptional
any
storeIdoptional
string
pattern: ^[a-z0-9]{24}$
syncDisabledoptional
boolean
updatedAtoptional
string
format: date-time

Example Request

application/json 
{
  "orderNumber": "string",
  "syncDisabled": true,
  "customMetadata": {},
  "id": "string",
  "storeId": "string",
  "createdAt": "2026-09-09T20:31:46.785Z",
  "updatedAt": "2026-09-09T20:31:46.785Z"
}

Response Schema

Order
cancelledAtoptional
string
createdAtrequired
string
format: date-time
currencyoptional
string
customerIdoptional
string
customMetadataoptional
Record<string, any>
Construct a type with a set of properties K of type T
deadlineoptional
string
externalIdoptional
string
externalUrloptional
string
idrequired
string
pattern: ^[a-z0-9]{24}$
integrationIdoptional
string
noteoptional
string
orderNumberrequired
string
priceoptional
number
priceBucketoptional
number
processedAtoptional
string
shippedAtoptional
string
sourceoptional
any
sourceRefoptional
string
statusrequired
any
storeIdrequired
string
pattern: ^[a-z0-9]{24}$
syncDisabledrequired
boolean
updatedAtrequired
string
format: date-time

Example Response

200 OK — application/json 
{
  "orderNumber": "string",
  "syncDisabled": true,
  "customMetadata": {},
  "id": "string",
  "storeId": "string",
  "createdAt": "2026-09-09T20:31:46.785Z",
  "updatedAt": "2026-09-09T20:31:46.785Z"
}