removeOrderItem
DEPRECATED
Legacy Orders V1 mutation. It applies to V1 orders only and will be removed once Orders V1 support ends. For V2 orders, use updateOrderItems.
Remove an item from an order. This mutation allows you to remove an existing order item. You need to provide the ID of the order item you want to remove. The mutation will return the status of the operation and the name of the removed item. If the order item with the provided ID does not exist, it will raise an 'Order item not found' error.
Parameters:
| Name | Type | Description |
|---|---|---|
| id | ID | ID of the order item to remove |
Errors:
| Error | Description |
|---|---|
| Order item not found | The order item with the provided ID does not exist |
Returns:
| Name | Type | Description |
|---|---|---|
| status | StatusResultEnum | Status of the operation |
| removed_item | String | The name of the removed item |
removeOrderItem(
input: RemoveOrderItemInput!
): RemoveOrderItemPayload @deprecated
Arguments
removeOrderItem.input ● RemoveOrderItemInput! non-null input common
Parameters for RemoveOrderItem
Type
RemoveOrderItemPayload object common
Autogenerated return type of RemoveOrderItem.