Skip to main content

Cancel an order

Request

This method cancels an order by its ID for a user with permission to view this request.

Security
BearerAuth
Path
orderIdstring, [ 1 .. 100 ] charactersrequired

Identifier of the order

Bodyapplication/jsonrequired

The Orders to be cancelled

reasonstring, [ 5 .. 4000 ] charactersrequired

Reason for cancellation

attachmentsArray of objects, <= 5 items(Attachment)

File(s) attached

lineIdsArray of strings, [ 0 .. 1 ] items

Refers to the lineId of product/service.

Example:
[ "1-D89731S" ]
Payload
{ "reason": "string", "attachments": [ { … } ], "lineIds": [ "1-D89731S" ] }

Responses

Accepted

Headers
Locationstring

Location of an order "/orders/1-23232322"

Example:"/orders/1-23232322"
Response
No content
Was this page helpful?