Theme switcher

Cancel a partial order

Header Parameters

x-apikeystring

Body Parameters

eventIdstring Required

Host event ID

orderIdstring

Source order ID, unique ID on the agent side

orderLocatorIdstring

Ticketmaster order ID

lineItemIdsToCancelarray

IDs of the line items to cancel

Response

200
Object

Order partial cancellation is complete

Response Attributes

timestampstring

timestamp of the operation

messagestring

Complete message to explain request status

cidstring

Correlation ID - Communicate with this ID for support

orderIdstring

Source order ID, unique ID on the agent side

agentIdstring

Agent ID

eventIdstring

Host event ID

orderOriginationTimestring

timestamp of the order creation

orderSourceLastUpdateTimestring

timestamp of the last update on the order

globalAccountIdstring

Source order ID, unique ID on the agent side

orderLocatorIdstring

Ticketmaster order ID

orderStatusstring

Order status, SURRENDERED means the ticket has been transferred

Enum values:
STATUS_UNSPECIFIED,ACTIVE,CANCELEDSURRENDERED
lineItemsarray

Information on cancelled line items

400
Object

Invalid partial order cancellation request

Response Attributes

timestampstring

timestamp of the operation

errorstring

Error code representing the error type

messagestring

Error message providing more details about the error

cidstring

Correlation ID - Communicate with this ID for support

errorsarray

List of explicit error messages

403
Object

Missing or invalid API KEY (x-apikey header)

404
Object

Order does not exist

Response Attributes

timestampstring

timestamp of the operation

errorstring

Error code representing the error type

messagestring

Error message providing more details about the error

cidstring

Correlation ID - Communicate with this ID for support

422
Object

Cannot process the partial order cancellation request

Response Attributes

timestampstring

timestamp of the operation

errorstring

Error code representing the error type

messagestring

Error message providing more details about the error

cidstring

Correlation ID - Communicate with this ID for support

500
Object

Unknown error

Response Attributes

timestampstring

timestamp of the operation

errorstring

Error code representing the error type

messagestring

Error message providing more details about the error

cidstring

Correlation ID - Communicate with this ID for support

statusnumber

POST

/

Select
1

Response