GuidesRecipesAPI Reference
API Reference

Cancel order item

Cancel a single seller 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 seller order item and create a new order item representing the uncancelled quantity. Fulfilled items cannot be cancelled.

Note: 'Order item' in this context specifically refers to seller order items (found at order.sellerOrders[].items[]). The top-level order items (found at order.items[]) are not modified by cancellation endpoints.

Path Params
string
required

ID of the order

string
required

ID of the seller order

string
required

ID of the seller order item to cancel

Body Params

An object with cancellation settings

integer
Defaults to 0

Allows partial item cancellation. The quantity of the item to remain uncancelled. Must be less than the original 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