Skip to main content

CancellationItemInput

Input type for cancelling an order item.

input CancellationItemInput {
  orderItemId: String!
  cancellationReason: String!
  units: Int!
}

Fields​

CancellationItemInput.orderItemId ● String! non-null scalar​

The identifier of the order item to be cancelled. Format: UUID

CancellationItemInput.cancellationReason ● String! non-null scalar​

The reason for cancellation. Note: use the orderReasons endpoint to know which ones are available for cancellations in your business unit

CancellationItemInput.units ● Int! non-null scalar​

The number of units to be cancelled. Can be less than the total units of the order item for partial cancellations.

Member Of​

orderCancel mutation ● refundOrder mutation