Skip to main content

CancelFulfillmentInput

Autogenerated input type of CancelFulfillment

input CancelFulfillmentInput {
  brandId: ID @deprecated
  clientMutationId: String
  fulfillmentId: ID!
  metadata: JSON
  orderId: ID!
  releaseInventory: Boolean
}

Fields​

CancelFulfillmentInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Order's company context will be used instead.

The brand ID. This parameter is optional, but if not provided, you should provide the header 'X-Brand-Id' with the brand ID.

CancelFulfillmentInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

CancelFulfillmentInput.fulfillmentId ● ID! non-null scalar common​

The ID of the fulfillment to cancel. Must be in 'allocated', 'sent', or 'failed_to_fulfill' state.

CancelFulfillmentInput.metadata ● JSON scalar common​

The metadata for the cancellation. This can be used to store additional information such as the reason for cancellation.

CancelFulfillmentInput.orderId ● ID! non-null scalar common​

The ID of the order the fulfillment belongs to.

CancelFulfillmentInput.releaseInventory ● Boolean scalar common​

When cancelling from 'sent', release inventory allocations instead of retaining them (goods-in-transit default). Has no effect when cancelling from 'allocated' or 'failed_to_fulfill', where inventory release is unconditional.

Member Of​

cancelFulfillment mutation