Skip to main content

holdOrder

This action holds the order to prevent it from being fulfilled.

This mutation can be performed when the order is in the statuses of 'PENDING', 'ORDERED', or 'ALLOCATED'.

holdOrder(
input: HoldOrderInput!
): HoldOrderPayload

Arguments​

holdOrder.input ● HoldOrderInput! non-null input common​

Parameters for HoldOrder

Type​

HoldOrderPayload object common​

Autogenerated return type of HoldOrder.