Update order

PATCH/orders/{orderId}

Update an existing order

Parameters

orderIdpathrequired

string

Order ID

Request Body

customerIdstringNew customer ID

customerNotesstringUpdated customer notes

internalNotesstringUpdated internal notes

metadataobjectUpdated metadata (merged with existing)

extendExpirybooleanExtend the order expiry time

▼addItemsobject[]Line items to add to the order

type*"ticket" | "product" | "addon" | "fee" | "tax" | "discount"Type of line item

name*stringLine item name

descriptionstringLine item description

unitPrice*integerUnit price in integer minor units (e.g. 2500 = £25.00)

quantityintegerQuantity (defaults to 1)

ticketDetailsobjectTicket-specific details

productDetailsobjectProduct-specific details

feeDetailsobjectFee-specific details

metadataobjectCustom metadata

▼updateItemsobject[]Line items to update

itemId*stringLine item ID

▶updates*object

removeItemsstring[]Line item IDs to remove

Response

Order updated successfully

Code Samples

No code examples available for this operation.

Try It

Path Parameters

orderId*Order ID

Request Body

customerIdNew customer ID

customerNotesUpdated customer notes

internalNotesUpdated internal notes

metadata{ "priority": "high" }Updated metadata (merged with existing)

extendExpiryNot settruefalseExtend the order expiry time

addItemsLine items to add to the order

updateItemsLine items to update

removeItems[ "oli_remove1", "oli_remove2" ]Line item IDs to remove