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