deleteOrders

deleteOrders

Delete one or more orders. Supports partial success — returns successfully deleted orders alongside IDs that could not be deleted with the reason. Maximum 100 IDs per request.

Parameters

orderIdsrequired[ID!]!

List of order IDs to delete (max 100)

Returns

DeleteOrdersResult with successfully deleted orders and error details for orders that could not be deleted

mutation {
  deleteOrders(orderIds: ["order_id_1", "order_id_2"]) {
    orders {
      id
      ref
      status
    }
    error {
      alreadyLabelOrderIds
      inCollectOrderIds
      notFoundOrderIds
      withInvalidStatusOrderIds
    }
  }
}

Return Type

The mutation returns a DeleteOrdersResult object that supports partial success: some orders may be deleted while others fail.

Field	Type	Description
orders	[Order!]!	Successfully deleted orders
error	DeleteOrdersError	IDs grouped by reason for failure

DeleteOrdersError

Field	Type	Description
alreadyLabelOrderIds	[ID!]!	Orders that already have a label generated
inCollectOrderIds	[ID!]!	Orders currently assigned to a collect
notFoundOrderIds	[ID!]!	Order IDs not found
withInvalidStatusOrderIds	[ID!]!	Orders with a status that prevents deletion