GuidesRecipesAPI Reference
API Reference

Cancel order item

Cancel a single order item on an order. Order items are fully cancelled by default. Order items can be partially cancelled by using the newQuantity parameter. Note that doing a partial cancellation will cancel the original order item and create a new order item representing the uncancelled quantity. Fulfilled items cannot be cancelled.

Path Params
string
required

ID of the order

string
required

ID of the order item

Body Params

The request body

integer
Defaults to 0

Allows partial item cancellation. The quantity of the item to remain uncancelled. Must be greater or equal to the fulfilled quantity and less than the total item quantity.

string

The reason for cancellation.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json