Skip to main content

UnshipOrderPayload

Autogenerated return type of UnshipOrder.

type UnshipOrderPayload {
  clientMutationId: String
  orderId: ID!
  resultStatus: StatusResultEnum!
}

Fields​

UnshipOrderPayload.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

UnshipOrderPayload.orderId ● ID! non-null scalar​

The ID of the order that was unshipped.

UnshipOrderPayload.resultStatus ● StatusResultEnum! non-null enum​

The result of the unship operation. This will be 'SUCCESS' if the order was successfully unshipped. A SUCCESS results does not indicate that the order was successfully unshipped but the request was received by the system and it is being processed.

Returned By​

unshipOrder mutation