orderHold
Place an order on hold.
Arguments
2 argumentsid•ID!ID of the order.
remarks•StringRemarks about why the order is being held
Possible return
id•ID!Unique primary key.
integrationReference•StringIntegration reference of the order
quantityOrdered•Int!Quantity ordered
quantityAllocated•Int!Quantity allocated in to fulfillments
quantityShipped•Int!Quantity (already) shipped
quantityUnallocated•Int!Quantity that is not (yet) allocated to a fulfillment
reference•StringReference of the order
currency•String!ISO 4217 currency code
value•String!Amount
status•OrderStatus!Status of the order
CANCELEDCREATEDEXPECTEDALLOCATEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDcustomsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLElocale•StringBCP-47 locale used for communication templates
canceledAt•DateTimeTzWhen the order was canceled.
shippedAt•DateTimeTzWhen the order was shipped.
createdAt•DateTimeTz!When the order was created.
updatedAt•DateTimeTz!When the order was last updated.
isUpdatable•Boolean!Whether this order can be updated.
id•ID!Unique primary key.
name•String!Name of the brand
customsShipmentType•CustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmpty•Boolean!Use reference if invoice number is empty
inboundGBEori•StringImport EORI for GB
inboundGBVat•StringImport VAT number for GB
createdAt•DateTimeTz!When the brand was created.
updatedAt•DateTimeTz!When the brand was last updated.
url•String!Url of the avatar
url•String!Url of the avatar
url•String!Url of the avatar
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[BrandPortalEdge!]!A list of BrandPortal edges.
pageInfo•PageInfo!Pagination information about the list of edges.
A list of CommunicationTemplate edges.
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
reference•StringReference of the customer
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
createdAt•DateTimeTz!When the customer was created.
updatedAt•DateTimeTz!When the customer was last updated.
ordersCount•Int!Customer orders count
returnRequestsCount•Int!Customer return requests count
shipmentsCount•Int!Customer shipments count
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[OrderEdge!]!A list of Order edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ReturnRequestEdge!]!A list of ReturnRequest edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ShipmentEdge!]!A list of Shipment edges.
id•ID!Unique primary key.
isEnabled•Boolean!Synchronization enabled
name•String!Name of the integration
isOrderSyncEnabled•Boolean!Order sync enabled
orderSyncUpdatedAt•DateTimeTzWhen the last order was updated at the integration while syncing
isProductSyncEnabled•Boolean!Product sync enabled
productSyncUpdatedAt•DateTimeTzWhen the last product was updated at the integration while syncing
isStockSyncEnabled•Boolean!Stock sync enabled
name•String!Profile name
integrationReference•String!Reference provided by the integration
createdAt•DateTimeTz!When the integration was created.
updatedAt•DateTimeTz!When the integration was last updated.
shippingServiceMethodId•IDID of the shipping service method.
returnShippingServiceMethodId•IDID of the return shipping service method.
printPackingSlip•BooleanPrint packing slip of the order fulfillment preferences.
fulfillmentMode•FulfillmentModeFulfillment mode of the order fulfillment preferences.
DELIVERYLOCAL_PICKUPallocationStrategy•OrderAllocationStrategyAllocation strategy of the order fulfillment preferences.
FEFOLEFOBULK_NON_PICKABLEhasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•Fulfillment!The Fulfillment node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•OrderLine!The OrderLine node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•Event!The Event node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•OrderException!The OrderException node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•Metafield!The Metafield node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•Shipment!The Shipment node.
cursor•String!A unique cursor that can be used for pagination.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
endCursor•StringThe cursor to continue paginating forwards.
node•SupportTicketAccess!The SupportTicketAccess node.
cursor•String!A unique cursor that can be used for pagination.
message•String!field•[String!]