GraphQL API
Organization API
Organization / Types/ object

OrderCancelPayload

The response for the mutation containing the result and user errors.

Fields

2 fields
address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

avatar•Avatar

Avatar of the brand.

brandPortals•BrandPortalConnection!

Brand portals configured for this brand

communicationTemplates•CommunicationTemplateConnection!

Sparse localized overrides configured for this brand.

createdAt•DateTimeTz!

When the brand was created.

customsShipmentType•CustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmpty•Boolean!

Use reference if invoice number is empty

id•ID!

Unique primary key.

inboundGBEori•String

Import EORI for GB

inboundGBVat•String

Import VAT number for GB

logoPrint•Avatar

Logo print of the brand.

logoScreen•Avatar

Logo screen of the brand.

name•String!

Name of the brand

returnAddress•Address

Return address of the brand.

senderAddress•Address

Sender address of the brand.

updatedAt•DateTimeTz!

When the brand was last updated.

canceledAt•DateTimeTz

When the order was canceled.

createdAt•DateTimeTz!

When the order was created.

billingAddress•Address

Billing address of the customer

createdAt•DateTimeTz!

When the customer was created.

id•ID!

Unique primary key.

Customer orders

ordersCount•Int!

Customer orders count

recipientAddress•Address

Recipient address of the customer

reference•String

Reference of the customer

returnRequests•ReturnRequestConnection!

Customer return requests

returnRequestsCount•Int!

Customer return requests count

Customer shipments

shipmentsCount•Int!

Customer shipments count

updatedAt•DateTimeTz!

When the customer was last updated.

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE

A list of Event edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of OrderException edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

allocationStrategy•OrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

BULK_NON_PICKABLEFEFOLEFO
fulfillmentMode•FulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
printPackingSlip•Boolean

Print packing slip of the order fulfillment preferences.

returnShippingServiceMethodId•ID

ID of the return shipping service method.

shippingServiceMethodId•ID

ID of the shipping service method.

A list of Fulfillment edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

id•ID!

Unique primary key.

Category of the integration

invoicingpaymentshippingshop
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•DateTimeTz

When the last order was updated at the integration while syncing

Payment profiles exposed by the integration

productSyncUpdatedAt•DateTimeTz

When 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•String

Integration reference of the order

isUpdatable•Boolean!

Whether this order can be updated.

A list of OrderLine edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

locale•String

BCP-47 locale used for communication templates

A list of Metafield edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

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•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

reference•String

Reference of the order

A list of Shipment edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

shippedAt•DateTimeTz

When the order was shipped.

currency•String!

ISO 4217 currency code

value•String!

Amount

status•OrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

A list of SupportTicketAccess edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

updatedAt•DateTimeTz!

When the order was last updated.

field•[String!]
message•String!