Legacy Interoperability
Interoperability metadata for types that directly correspond to a REST Admin API resource. For example, on the Product type, LegacyInteroperability returns metadata for the corresponding Product object in the REST Admin API.
Anchor to FieldsFields
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
Anchor to Types implemented inTypes implemented in
- •OBJECT
Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
- Anchor to addressesaddresses•[Mailing
Address!]! non-null A list of addresses associated with the customer.
- Anchor to addressesV2addresses•Mailing
V2 Address Connection! non-null The addresses associated with the customer.
- Anchor to amountSpentamount•Money
Spent V2! non-null The total amount that the customer has spent on orders in their lifetime.
- Anchor to canDeletecan•Boolean!
Delete non-null Whether the merchant can delete the customer from their store.
A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.
- Anchor to companyContactProfilescompany•[Company
Contact Profiles Contact!]! non-null A list of the customer's company contact profiles.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the customer was added to the store.
- Anchor to dataSaleOptOutdata•Boolean!
Sale Opt Out non-null Whether the customer has opted out of having their data sold.
- Anchor to defaultAddressdefault•Mailing
Address Address The default address associated with the customer.
- Anchor to defaultEmailAddressdefault•Customer
Email Address Email Address The customer's default email address.
- Anchor to defaultPhoneNumberdefault•Customer
Phone Number Phone Number The customer's default phone number.
- Anchor to displayNamedisplay•String!
Name non-null The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
- Anchor to eventsevents•Event
Connection! non-null A list of events associated with the customer.
- Anchor to firstNamefirst•String
Name The customer's first name.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image!non-null
The image associated with the customer.
- Anchor to lastNamelast•String
Name The customer's last name.
- Anchor to lastOrderlast•Order
Order The customer's last order.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to lifetimeDurationlifetime•String!
Duration non-null The amount of time since the customer was first added to the store.
Example: 'about 12 years'.
- Anchor to localelocale•String!non-null
The customer's locale.
- Anchor to mergeablemergeable•Customer
Mergeable! non-null Whether the customer can be merged with another customer.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to multipassIdentifiermultipass•String
Identifier A unique identifier for the customer that's used with Multipass login.
- Anchor to notenote•String
A note about the customer.
- Anchor to numberOfOrdersnumber•Unsigned
Of Orders Int64! non-null The number of orders that the customer has made at the store in their lifetime.
- Anchor to ordersorders•Order
Connection! non-null A list of the customer's orders.
- Anchor to paymentMethodspayment•Customer
Methods Payment Method Connection! non-null A list of the customer's payment methods.
- Anchor to productSubscriberStatusproduct•Customer
Subscriber Status Product Subscriber Status! non-null Possible subscriber states of a customer defined by their subscription contracts.
- Anchor to statestate•Customer
State! non-null The state of the customer's account with the shop.
Please note that this only meaningful when Classic Customer Accounts is active.
- Anchor to statisticsstatistics•Customer
Statistics! non-null The statistics for a given customer.
- Anchor to storeCreditAccountsstore•Store
Credit Accounts Credit Account Connection! non-null Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.
- Anchor to subscriptionContractssubscription•Subscription
Contracts Contract Connection! non-null A list of the customer's subscription contracts.
- •[String!]!non-null
A comma separated list of tags that have been added to the customer.
- Anchor to taxExempttax•Boolean!
Exempt non-null Whether the customer is exempt from being charged taxes on their orders.
- Anchor to taxExemptionstax•[Tax
Exemptions Exemption!]! non-null The list of tax exemptions applied to the customer.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the customer was last updated.
- Anchor to verifiedEmailverified•Boolean!
Email non-null Whether the customer has verified their email address. Defaults to
true
if the customer is created through the Shopify admin or API.- Anchor to emailemail•StringDeprecated
- Anchor to emailMarketingConsentemail•Customer
Marketing Consent Email Marketing Consent State Deprecated - Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-nullDeprecated - Anchor to marketmarket•MarketDeprecated
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to phonephone•StringDeprecated
- Anchor to smsMarketingConsentsms•Customer
Marketing Consent Sms Marketing Consent State Deprecated - Anchor to unsubscribeUrlunsubscribe•URL!
Url non-nullDeprecated - Anchor to validEmailAddressvalid•Boolean!
Email Address non-nullDeprecated
- •OBJECT
An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers to pay with a secure checkout link.
- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
For draft orders in multiple currencies
is the source of truth for what a customer is going to be charged and
is an estimate of what the merchant might receive in their shop currency.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.
- Anchor to acceptAutomaticDiscountsaccept•Boolean
Automatic Discounts Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see
) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.
- Anchor to allowDiscountCodesInCheckoutallow•Boolean!
Discount Codes In Checkout non-null Whether discount codes are allowed during checkout of this draft order.
- Anchor to allVariantPricesOverriddenall•Boolean!
Variant Prices Overridden non-null Whether all variant prices have been overridden.
- Anchor to amountDueLaterSetamount•Money
Due Later Set Bag! non-null The amount due later. When there are payment terms, this is the total price minus the deposit amount (if any). When there are no payment terms, this is 0.
- Anchor to amountDueNowSetamount•Money
Due Now Set Bag! non-null The amount due now. When there are payment terms this is the value of the deposit (0 by default). When there are no payment terms, this is the total price.
- Anchor to anyVariantPricesOverriddenany•Boolean!
Variant Prices Overridden non-null Whether any variant prices have been overridden.
- Anchor to appliedDiscountapplied•Draft
Discount Order Applied Discount The custom order-level discount applied.
- Anchor to billingAddressbilling•Mailing
Address Address The billing address of the customer.
- Anchor to billingAddressMatchesShippingAddressbilling•Boolean!
Address Matches Shipping Address non-null Whether the billing address matches the shipping address.
- Anchor to bypassCartValidationsbypass•Boolean
Cart Validations Whether to bypass cart validations on this draft order.
- Anchor to completedAtcompleted•Date
At Time The date and time when the draft order was converted to a new order, and had it's status changed to Completed.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the draft order was created in Shopify.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The shop currency used for calculation.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null The custom information added to the draft order on behalf of the customer.
- Anchor to customercustomer•Customer
The customer who will be sent an invoice.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to depositdeposit•Deposit
Configuration The portion required to be paid at checkout.
- Anchor to discountCodesdiscount•[String!]!
Codes non-null All discount codes applied.
- Anchor to emailemail•String
The email address of the customer, which is used to send notifications.
- Anchor to eventsevents•Event
Connection! non-null The list of events associated with the draft order.
- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant has added timeline comments to the draft order.
- •ID!non-null
A globally-unique ID.
- Anchor to invoiceEmailTemplateSubjectinvoice•String!
Email Template Subject non-null The subject defined for the draft invoice email template.
- Anchor to invoiceSentAtinvoice•Date
Sent At Time The date and time when the invoice was last emailed to the customer.
- Anchor to invoiceUrlinvoice•URL
Url The link to the checkout, which is sent to the customer in the invoice email.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to lineItemsline•Draft
Items Order Line Item Connection! non-null The list of the line items in the draft order.
- Anchor to lineItemsSubtotalPriceline•Money
Items Subtotal Price Bag! non-null A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
- Anchor to localizedFieldslocalized•Localized
Fields Field Connection! non-null List of localized fields for the resource.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to namename•String!non-null
The identifier for the draft order, which is unique within the store. For example, #D1223.
- Anchor to note2note2•String
The text from an optional note attached to the draft order.
- Anchor to orderorder•Order
The order that was created from the draft order.
- Anchor to paymentTermspayment•Payment
Terms Terms The associated payment terms for this draft order.
- Anchor to phonephone•String
The assigned phone number.
- Anchor to platformDiscountsplatform•[Draft
Discounts Order Platform Discount!]! non-null The list of platform discounts applied.
- Anchor to poNumberpo•String
Number The purchase order number.
- Anchor to presentmentCurrencyCodepresentment•Currency
Currency Code Code! non-null The payment currency used for calculation.
- Anchor to purchasingEntitypurchasing•Purchasing
Entity Entity The purchasing entity.
- Anchor to readyready•Boolean!non-null
Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.
- Anchor to reserveInventoryUntilreserve•Date
Inventory Until Time The time after which inventory will automatically be restocked.
- Anchor to shippingAddressshipping•Mailing
Address Address The shipping address of the customer.
- Anchor to shippingLineshipping•Shipping
Line Line The line item containing the shipping information and costs.
- Anchor to statusstatus•Draft
Order Status! non-null The status of the draft order.
- Anchor to subtotalPriceSetsubtotal•Money
Price Set Bag! non-null The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
- •[String!]!non-null
The comma separated list of tags associated with the draft order. Updating
tags
overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the tagsAdd mutation.- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether the line item prices include taxes.
- Anchor to taxExempttax•Boolean!
Exempt non-null Whether the draft order is tax exempt.
- Anchor to taxLinestax•[Tax
Lines Line!]! non-null The list of of taxes lines charged for each line item and shipping line.
- Anchor to totalDiscountsSettotal•Money
Discounts Set Bag! non-null Total discounts.
- Anchor to totalLineItemsPriceSettotal•Money
Line Items Price Set Bag! non-null Total price of line items.
- Anchor to totalPriceSettotal•Money
Price Set Bag! non-null The total price, includes taxes, shipping charges, and discounts.
- Anchor to totalQuantityOfLineItemstotal•Int!
Quantity Of Line Items non-null The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.
- Anchor to totalShippingPriceSettotal•Money
Shipping Price Set Bag! non-null The total shipping price.
- Anchor to totalTaxSettotal•Money
Tax Set Bag! non-null The total tax.
- Anchor to totalWeighttotal•Unsigned
Weight Int64! non-null The total weight in grams of the draft order.
- Anchor to transformerFingerprinttransformer•String
Fingerprint Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.
- Anchor to visibleToCustomervisible•Boolean!
To Customer non-null Whether the draft order will be visible to the customer on the self-serve portal.
- Anchor to warningswarnings•[Draft
Order Warning!]! non-null The list of warnings raised while calculating.
- Anchor to localizationExtensionslocalization•Localization
Extensions Extension Connection! non-nullDeprecated - Anchor to marketNamemarket•String!
Name non-nullDeprecated - Anchor to marketRegionCountryCodemarket•Country
Region Country Code Code! non-nullDeprecated - Anchor to subtotalPricesubtotal•Money!
Price non-nullDeprecated - Anchor to totalPricetotal•Money!
Price non-nullDeprecated - Anchor to totalShippingPricetotal•Money!
Shipping Price non-nullDeprecated - Anchor to totalTaxtotal•Money!
Tax non-nullDeprecated
- •OBJECT
Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the fulfillment was created.
- Anchor to deliveredAtdelivered•Date
At Time The date that this fulfillment was delivered.
- Anchor to displayStatusdisplay•Fulfillment
Status Display Status Human readable display status for this fulfillment.
- Anchor to estimatedDeliveryAtestimated•Date
Delivery At Time The estimated date that this fulfillment will arrive.
- Anchor to eventsevents•Fulfillment
Event Connection! non-null The history of events associated with this fulfillment.
- Anchor to fulfillmentLineItemsfulfillment•Fulfillment
Line Items Line Item Connection! non-null List of the fulfillment's line items.
- Anchor to fulfillmentOrdersfulfillment•Fulfillment
Orders Order Connection! non-null A paginated list of fulfillment orders for the fulfillment.
- •ID!non-null
A globally-unique ID.
- Anchor to inTransitAtin•Date
Transit At Time The date and time when the fulfillment went into transit.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to locationlocation•Location
The location that the fulfillment was processed at.
- Anchor to namename•String!non-null
Human readable reference identifier for this fulfillment.
- Anchor to orderorder•Order!non-null
The order for which the fulfillment was created.
- Anchor to originAddressorigin•Fulfillment
Address Origin Address The address at which the fulfillment occurred. This field is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the
field on the
object instead.
- Anchor to requiresShippingrequires•Boolean!
Shipping non-null Whether any of the line items in the fulfillment require shipping.
- Anchor to serviceservice•Fulfillment
Service Fulfillment service associated with the fulfillment.
- Anchor to statusstatus•Fulfillment
Status! non-null The status of the fulfillment.
- Anchor to totalQuantitytotal•Int!
Quantity non-null Sum of all line item quantities for the fulfillment.
- Anchor to trackingInfotracking•[Fulfillment
Info Tracking Info!]! non-null Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the fulfillment was last modified.
- •OBJECT
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. Learn more about the relationships between inventory objects.
- Anchor to countryCodeOfOrigincountry•Country
Code Of Origin Code The ISO 3166-1 alpha-2 country code of where the item originated from.
- Anchor to countryHarmonizedSystemCodescountry•Country
Harmonized System Codes Harmonized System Code Connection! non-null A list of country specific harmonized system codes.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the inventory item was created.
- Anchor to duplicateSkuCountduplicate•Int!
Sku Count non-null The number of inventory items that share the same SKU with this item.
- Anchor to harmonizedSystemCodeharmonized•String
System Code The harmonized system code of the item. This must be a number between 6 and 13 digits.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryHistoryUrlinventory•URL
History Url The URL that points to the inventory history for the item.
- Anchor to inventoryLevelinventory•Inventory
Level Level The inventory item's quantities at the specified location.
- Anchor to inventoryLevelsinventory•Inventory
Levels Level Connection! non-null A list of the inventory item's quantities for each location that the inventory item can be stocked at.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to measurementmeasurement•Inventory
Item Measurement! non-null The packaging dimensions of the inventory item.
- Anchor to provinceCodeOfOriginprovince•String
Code Of Origin The ISO 3166-2 alpha-2 province code of where the item originated from.
- Anchor to requiresShippingrequires•Boolean!
Shipping non-null Whether the inventory item requires shipping.
- •String
Inventory item SKU. Case-sensitive string.
- Anchor to trackedtracked•Boolean!non-null
Whether inventory levels are tracked for the item.
- Anchor to trackedEditabletracked•Editable
Editable Property! non-null Whether the value of the
tracked
field for the inventory item can be changed.- Anchor to unitCostunit•Money
Cost V2 Unit cost associated with the inventory item. Note: the user must have "View product costs" permission granted in order to access this field once product granular permissions are enabled.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the inventory item was updated.
- Anchor to variantvariant•Product
Variant! non-null The variant that owns this inventory item.
- •OBJECT
Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have
and are configured with a shipping rate, pickup enabled or local delivery will be able to sell from their storefront.
- Anchor to activatableactivatable•Boolean!non-null
- Anchor to addressaddress•Location
Address! non-null The address of this location.
- Anchor to addressVerifiedaddress•Boolean!
Verified non-null Whether the location address has been verified.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) that the location was added to a shop.
- Anchor to deactivatabledeactivatable•Boolean!non-null
- Anchor to deactivatedAtdeactivated•String
At The date and time (ISO 8601 format) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as
".
- Anchor to deletabledeletable•Boolean!non-null
Whether this location can be deleted.
- Anchor to fulfillmentServicefulfillment•Fulfillment
Service Service Name of the service provider that fulfills from this location.
- Anchor to fulfillsOnlineOrdersfulfills•Boolean!
Online Orders non-null Whether this location can fulfill online orders.
- Anchor to hasActiveInventoryhas•Boolean!
Active Inventory non-null Whether this location has active inventory.
- Anchor to hasUnfulfilledOrdershas•Boolean!
Unfulfilled Orders non-null Whether this location has orders that need to be fulfilled.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryLevelinventory•Inventory
Level Level The quantities of an inventory item at this location.
- Anchor to inventoryLevelsinventory•Inventory
Levels Level Connection! non-null A list of the quantities of the inventory items that can be stocked at this location.
- Anchor to isActiveis•Boolean!
Active non-null - Anchor to isFulfillmentServiceis•Boolean!
Fulfillment Service non-null Whether this location is a fulfillment service.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to localPickupSettingsV2local•Delivery
Pickup Settings V2 Local Pickup Settings Local pickup settings for the location.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to namename•String!non-null
The name of the location.
- Anchor to shipsInventoryships•Boolean!
Inventory non-null Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
- Anchor to suggestedAddressessuggested•[Location
Addresses Suggested Address!]! non-null List of suggested addresses for this location (empty if none).
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) when the location was last updated.
- Anchor to isPrimaryis•Boolean!
Primary non-nullDeprecated - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •OBJECT
Represents actions that market a merchant's store or products.
- •App!non-null
The app that the marketing event is attributed to.
- Anchor to channelHandlechannel•String
Handle The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
- Anchor to descriptiondescription•String
A human-readable description of the marketing event.
- Anchor to endedAtended•Date
At Time The date and time when the marketing event ended.
- •ID!non-null
A globally-unique ID.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to manageUrlmanage•URL
Url The URL where the marketing event can be managed.
- Anchor to marketingChannelTypemarketing•Marketing
Channel Type Channel The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
- Anchor to previewUrlpreview•URL
Url The URL where the marketing event can be previewed.
- Anchor to remoteIdremote•String
Id An optional ID that helps Shopify validate engagement data.
- Anchor to scheduledToEndAtscheduled•Date
To End At Time The date and time when the marketing event is scheduled to end.
- Anchor to sourceAndMediumsource•String!
And Medium non-null Where the
occurred and what kind of content was used. Because
and
are often used interchangeably, this is based on a combination of
,
, and
type
to provide a consistent representation for any given piece of marketing regardless of the app that created it.- Anchor to startedAtstarted•Date
At Time! non-null The date and time when the marketing event started.
- Anchor to typetype•Marketing
Tactic! non-null The marketing event type.
- Anchor to utmCampaignutm•String
Campaign The name of the marketing campaign.
- Anchor to utmMediumutm•String
Medium The medium that the marketing campaign is using. Example values:
cpc
,banner
.- Anchor to utmSourceutm•String
Source The referrer of the marketing event. Example values:
google
,newsletter
.- Anchor to channelchannel•Marketing
Channel Deprecated - Anchor to targetTypeDisplayTexttarget•String!
Type Display Text non-nullDeprecated
- •App!
- •OBJECT
Metafields enable you to attach additional information to a Shopify resource, such as a Product or a Collection. For more information about where you can attach metafields refer to HasMetafields. Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.
- Anchor to compareDigestcompare•String!
Digest non-null The data stored in the resource, represented as a digest.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the metafield was created.
- Anchor to definitiondefinition•Metafield
Definition The metafield definition that the metafield belongs to, if any.
- •ID!non-null
A globally-unique ID.
- Anchor to jsonValuejson•JSON!
Value non-null The data stored in the metafield in JSON format.
- •String!non-null
The unique identifier for the metafield within its namespace.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to namespacenamespace•String!non-null
The container for a group of metafields that the metafield is associated with.
- Anchor to ownerowner•Has
Metafields! non-null The resource that the metafield is attached to.
- Anchor to ownerTypeowner•Metafield
Type Owner Type! non-null The type of resource that the metafield is attached to.
- Anchor to referencereference•Metafield
Reference Returns a reference object if the metafield definition's type is a resource reference.
- Anchor to referencesreferences•Metafield
Reference Connection A list of reference objects if the metafield's type is a resource reference list.
- Anchor to typetype•String!non-null
The type of data that is stored in the metafield. Refer to the list of supported types.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the metafield was updated.
- Anchor to valuevalue•String!non-null
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
- Anchor to descriptiondescription•StringDeprecated
- •OBJECT
The
Order
object represents a customer's request to purchase one or more products from a store. Use theOrder
object to handle the complete purchase lifecycle from checkout to fulfillment.Use the
Order
object when you need to:- Display order details on customer account pages or admin dashboards.
- Create orders for phone sales, wholesale customers, or subscription services.
- Update order information like shipping addresses, notes, or fulfillment status.
- Process returns, exchanges, and partial refunds.
- Generate invoices, receipts, and shipping labels.
The
Order
object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.NoteOnly the last 60 days' worth of orders from a store are accessible from the
Order
object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the,
, and
scopes.
CautionOnly use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.
- Anchor to additionalFeesadditional•[Additional
Fees Fee!]! non-null A list of additional fees applied to an order, such as duties, import fees, or tax lines.
- Anchor to agreementsagreements•Sales
Agreement Connection! non-null A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers.
- Anchor to alertsalerts•[Resource
Alert!]! non-null A list of messages that appear on the Orders page in the Shopify admin. These alerts provide merchants with important information about an order's status or required actions.
- •Order
App The application that created the order. For example, "Online Store", "Point of Sale", or a custom app name. Use this to identify the order source for attribution and fulfillment workflows. Learn more about building apps for orders and fulfillment.
- Anchor to billingAddressbilling•Mailing
Address Address The billing address associated with the payment method selected by the customer for an order. Returns
null
if no billing address was provided during checkout.- Anchor to billingAddressMatchesShippingAddressbilling•Boolean!
Address Matches Shipping Address non-null Whether the billing address matches the shipping address. Returns
true
if both addresses are the same, andfalse
if they're different or if an address is missing.- Anchor to cancellationcancellation•Order
Cancellation Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any staff notes.
- Anchor to cancelledAtcancelled•Date
At Time The date and time in ISO 8601 format when an order was canceled. Returns
null
if the order hasn't been canceled.- Anchor to cancelReasoncancel•Order
Reason Cancel Reason The reason provided for an order cancellation. For example, a merchant might cancel an order if there's insufficient inventory. Returns
null
if the order hasn't been canceled.- Anchor to canMarkAsPaidcan•Boolean!
Mark As Paid non-null Whether an order can be manually marked as paid. Returns
false
if the order is already paid, is canceled, has pending Shopify Payments transactions, or has a negative payment amount.- Anchor to canNotifyCustomercan•Boolean!
Notify Customer non-null Whether order notifications can be sent to the customer. Returns
true
if the customer has a valid email address.- Anchor to capturablecapturable•Boolean!non-null
Whether an authorized payment for an order can be captured. Returns
true
if an authorized payment exists that hasn't been fully captured yet. Learn more about capturing payments.- Anchor to cartDiscountAmountSetcart•Money
Discount Amount Set Bag The total discount amount applied at the time the order was created, displayed in both shop and presentment currencies, before returns, refunds, order edits, and cancellations. This field only includes discounts applied to the entire order.
- Anchor to channelInformationchannel•Channel
Information Information Details about the sales channel that created the order, such as the channel app type and channel name, which helps to track order sources.
- Anchor to clientIpclient•String
Ip The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis.
- Anchor to closedclosed•Boolean!non-null
Whether an order is closed. An order is considered closed if all its line items have been fulfilled or canceled, and all financial transactions are complete.
- Anchor to closedAtclosed•Date
At Time The date and time ISO 8601 format when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns
null
if the order isn't closed.- Anchor to confirmationNumberconfirmation•String
Number A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example,
) and isn't guaranteed to be unique across orders.
- Anchor to confirmedconfirmed•Boolean!non-null
Whether inventory has been reserved for an order. Returns
true
if inventory quantities for an order's line items have been reserved. Learn more about managing inventory quantities and states.- Anchor to createdAtcreated•Date
At Time! non-null The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The shop currency when the order was placed. For example, "USD" or "CAD".
- Anchor to currentCartDiscountAmountSetcurrent•Money
Cart Discount Amount Set Bag! non-null The current total of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations. This includes discount codes, automatic discounts, and other promotions that affect the whole order rather than individual line items. To get the original discount amount at the time of order creation, use the
field.
- Anchor to currentShippingPriceSetcurrent•Money
Shipping Price Set Bag! non-null The current shipping price after applying refunds and discounts. If the parent
field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
- Anchor to currentSubtotalLineItemsQuantitycurrent•Int!
Subtotal Line Items Quantity non-null The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations.
- Anchor to currentSubtotalPriceSetcurrent•Money
Subtotal Price Set Bag! non-null The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.
- Anchor to currentTaxLinescurrent•[Tax
Tax Lines Line!]! non-null A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same
rate
andtitle
.- Anchor to currentTotalAdditionalFeesSetcurrent•Money
Total Additional Fees Set Bag The current total of all additional fees for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. Additional fees can include charges such as duties, import fees, and special handling.
- Anchor to currentTotalDiscountsSetcurrent•Money
Total Discounts Set Bag! non-null The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.
- Anchor to currentTotalDutiesSetcurrent•Money
Total Duties Set Bag The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.
- Anchor to currentTotalPriceSetcurrent•Money
Total Price Set Bag! non-null The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.
- Anchor to currentTotalTaxSetcurrent•Money
Total Tax Set Bag! non-null The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies.
- Anchor to currentTotalWeightcurrent•Unsigned
Total Weight Int64! non-null The total weight of the order after returns and refunds, in grams.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes.
- Anchor to customercustomer•Customer
The customer who placed an order. Returns
null
if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about customer accounts.- Anchor to customerAcceptsMarketingcustomer•Boolean!
Accepts Marketing non-null Whether the customer agreed to receive marketing emails at the time of purchase. Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns. Learn more about building customer segments.
- Anchor to customerJourneySummarycustomer•Customer
Journey Summary Journey Summary The customer's visits and interactions with the online store before placing the order. Use this to understand customer behavior, attribution sources, and marketing effectiveness to optimize your sales funnel.
- Anchor to customerLocalecustomer•String
Locale The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language.
- Anchor to discountApplicationsdiscount•Discount
Applications Application Connection! non-null A list of discounts that are applied to the order, excluding order edits and refunds. Includes discount codes, automatic discounts, and other promotions that reduce the order total.
- Anchor to discountCodediscount•String
Code The discount code used for an order. Returns
null
if no discount code was applied.- Anchor to discountCodesdiscount•[String!]!
Codes non-null The discount codes used for the order. Multiple codes can be applied to a single order.
- Anchor to displayAddressdisplay•Mailing
Address Address The primary address of the customer, prioritizing shipping address over billing address when both are available. Returns
null
if neither shipping address nor billing address was provided.- Anchor to displayFinancialStatusdisplay•Order
Financial Status Display Financial Status An order's financial status for display in the Shopify admin.
- Anchor to displayFulfillmentStatusdisplay•Order
Fulfillment Status Display Fulfillment Status! non-null The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the
object.
- Anchor to displayRefundStatusdisplay•Order
Refund Status Display Refund Status The status of the refund(s) that can be shown to the merchant. Mostly used when a refund is in a deferred state (for example, it was not yet sent to the payments provider).
- Anchor to disputesdisputes•[Order
Dispute Summary!]! non-null A list of payment disputes associated with the order, such as chargebacks or payment inquiries. Disputes occur when customers challenge transactions with their bank or payment provider.
- Anchor to dutiesIncludedduties•Boolean!
Included non-null Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders.
- Anchor to editededited•Boolean!non-null
Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices.
- Anchor to emailemail•String
The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns
null
if no email address was provided during checkout.- Anchor to estimatedTaxesestimated•Boolean!
Taxes non-null Whether taxes on the order are estimated. This field returns
false
when taxes on the order are finalized and aren't subject to any changes.- Anchor to eventsevents•Event
Connection! non-null A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.
- Anchor to fulfillablefulfillable•Boolean!non-null
Whether there are line items that can be fulfilled. This field returns
false
when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.- Anchor to fulfillmentOrdersfulfillment•Fulfillment
Orders Order Connection! non-null A list of fulfillment orders for an order. Each fulfillment order groups line items that are fulfilled together, allowing an order to be processed in parts if needed.
- Anchor to fulfillmentsfulfillments•[Fulfillment!]!non-null
A list of shipments for the order. Fulfillments represent the physical shipment of products to customers.
- Anchor to fulfillmentsCountfulfillments•Count
Count The total number of fulfillments for the order, including canceled ones.
- Anchor to fullyPaidfully•Boolean!
Paid non-null Whether the order has been paid in full. This field returns
true
when the total amount received equals or exceeds the order total.- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant has added a timeline comment to the order.
- •ID!non-null
A globally-unique ID.
- Anchor to incotermInformationincoterm•Incoterm
Information Information Information about the incoterm used for the order.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to lineItemsline•Line
Items Item Connection! non-null A list of the order's line items. Line items represent the individual products and quantities that make up the order.
- Anchor to localizedFieldslocalized•Localized
Fields Field Connection! non-null List of localized fields for the resource.
- Anchor to merchantBusinessEntitymerchant•Business
Business Entity Entity! non-null The legal business structure that the merchant operates under for this order, such as an LLC, corporation, or partnership. Used for tax reporting, legal compliance, and determining which business entity is responsible for the order.
- Anchor to merchantEditablemerchant•Boolean!
Editable non-null Whether the order can be edited by the merchant. Returns
false
for orders that can't be modified, such as canceled orders or orders with specific payment statuses.- Anchor to merchantEditableErrorsmerchant•[String!]!
Editable Errors non-null A list of reasons why the order can't be edited. For example, canceled orders can't be edited.
- Anchor to merchantOfRecordAppmerchant•Order
Of Record App App The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to namename•String!non-null
The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking.
- Anchor to netPaymentSetnet•Money
Payment Set Bag! non-null The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.
- Anchor to nonFulfillableLineItemsnon•Line
Fulfillable Line Items Item Connection! non-null A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
- Anchor to notenote•String
The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes.
- Anchor to numbernumber•Int!non-null
The order number used to generate the name using the store's configured order number prefix/suffix. This number isn't guaranteed to follow a consecutive integer sequence (e.g. 1, 2, 3..), nor is it guaranteed to be unique across multiple stores, or even for a single store.
- Anchor to originalTotalAdditionalFeesSetoriginal•Money
Total Additional Fees Set Bag The total amount of all additional fees, such as import fees or taxes, that were applied when an order was created. Returns
null
if additional fees aren't applicable.- Anchor to originalTotalDutiesSetoriginal•Money
Total Duties Set Bag The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use
to retrieve the current duties amount after adjustments.
- Anchor to originalTotalPriceSetoriginal•Money
Total Price Set Bag! non-null The total price of the order at the time of order creation, in shop and presentment currencies. Use this to compare the original order value against the current total after edits, returns, or refunds.
- Anchor to paymentCollectionDetailspayment•Order
Collection Details Payment Collection Details! non-null The payment collection details for the order, including payment status, outstanding amounts, and collection information. Use this to understand when and how payments should be collected, especially for orders with deferred or installment payment terms.
- Anchor to paymentGatewayNamespayment•[String!]!
Gateway Names non-null A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".
- Anchor to paymentTermspayment•Payment
Terms Terms The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns
null
if no specific payment terms were set for the order.- Anchor to phonephone•String
The phone number associated with the customer for this order. Useful for contacting customers about shipping updates, delivery notifications, or order issues. Returns
null
if no phone number was provided during checkout.- Anchor to poNumberpo•String
Number The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement.
- Anchor to presentmentCurrencyCodepresentment•Currency
Currency Code Code! non-null The currency used by the customer when placing the order. For example, "USD", "EUR", or "CAD". This may differ from the shop's base currency when serving international customers or using multi-currency pricing.
- Anchor to processedAtprocessed•Date
At Time! non-null The date and time in ISO 8601 format when the order was processed. This date and time might not match the date and time when the order was created.
- Anchor to publicationpublication•Publication
The sales channel that the order was created from, such as the Online Store or Shopify POS.
- Anchor to purchasingEntitypurchasing•Purchasing
Entity Entity The business entity that placed the order, including company details and purchasing relationships. Used for B2B transactions to track which company or organization is responsible for the purchase and payment terms.
- Anchor to refundablerefundable•Boolean!non-null
Whether the order can be refunded based on its payment transactions. Returns
false
for orders with no eligible payment transactions, such as fully refunded orders or orders with non-refundable payment methods.- Anchor to refundDiscrepancySetrefund•Money
Discrepancy Set Bag! non-null The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.
- Anchor to refundsrefunds•[Refund!]!non-null
A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments.
- Anchor to registeredSourceUrlregistered•URL
Source Url The URL of the source that the order originated from, if found in the domain registry. Returns
null
if the source URL isn't in the domain registry.- Anchor to requiresShippingrequires•Boolean!
Shipping non-null Whether the order requires physical shipping to the customer. Returns
false
for digital-only orders (such as gift cards or downloadable products) andtrue
for orders with physical products that need delivery. Use this to determine shipping workflows and logistics requirements.- Anchor to restockablerestockable•Boolean!non-null
Whether any line items on the order can be restocked into inventory. Returns
false
for digital products, custom items, or items that can't be resold.- Anchor to retailLocationretail•Location
Location The physical location where a retail order is created or completed, except for draft POS orders completed using the "mark as paid" flow in the Shopify admin, which return
null
. Transactions associated with the order might have been processed at a different location.- Anchor to returnsreturns•Return
Connection! non-null The returns associated with the order. Contains information about items that customers have requested to return, including return reasons, status, and refund details. Use this to track and manage the return process for order items.
- Anchor to returnStatusreturn•Order
Status Return Status! non-null The order's aggregated return status for display purposes. Indicates the overall state of returns for the order, helping merchants track and manage the return process.
- Anchor to riskrisk•Order
Risk Summary! non-null The risk assessment summary for the order. Provides fraud analysis and risk scoring to help you identify potentially fraudulent orders. Use this to make informed decisions about order fulfillment and payment processing.
- Anchor to shippingAddressshipping•Mailing
Address Address The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns
null
for digital orders or orders that don't require shipping.- Anchor to shippingLineshipping•Shipping
Line Line A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs.
- Anchor to shippingLinesshipping•Shipping
Lines Line Connection! non-null The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order.
- Anchor to shopifyProtectshopify•Shopify
Protect Protect Order Summary The Shopify Protect details for the order, including fraud protection status and coverage information. Shopify Protect helps protect eligible orders against fraudulent chargebacks. Returns
null
if Shopify Protect is disabled for the shop or the order isn't eligible for protection. Learn more about Shopify Protect.- Anchor to sourceIdentifiersource•String
Identifier - Anchor to sourceNamesource•String
Name The name of the source associated with the order, such as "web", "mobile_app", or "pos". Use this field to identify the platform where the order was placed.
- Anchor to staffMemberstaff•Staff
Member Member The staff member who created or is responsible for the order. Useful for tracking which team member handled phone orders, manual orders, or order modifications. Returns
null
for orders created directly by customers through the online store.- Anchor to statusPageUrlstatus•URL!
Page Url non-null The URL where customers can check their order's current status, including tracking information and delivery updates. Provides order tracking links in emails, apps, or customer communications.
- Anchor to audienceaudience•Audience
Specifies the intended audience for the status page URL.
- Anchor to notificationUsagenotification•Notification
Usage Usage Specifies the intended notification usage for the status page URL.
Arguments
- Anchor to subtotalLineItemsQuantitysubtotal•Int!
Line Items Quantity non-null The sum of quantities for all line items that contribute to the order's subtotal price. This excludes quantities for items like tips, shipping costs, or gift cards that don't affect the subtotal. Use this to quickly understand the total item count for pricing calculations.
- Anchor to subtotalPriceSetsubtotal•Money
Price Set Bag The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If
is
true
, then the subtotal also includes tax.- Anchor to suggestedRefundsuggested•Suggested
Refund Refund A calculated refund suggestion for the order based on specified line items, shipping, and duties. Use this to preview refund amounts, taxes, and processing fees before creating an actual refund.
- •[String!]!non-null
A comma separated list of tags associated with the order. Updating
tags
overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether taxes are included in the subtotal price of the order. When
true
, the subtotal and line item prices include tax amounts. Whenfalse
, taxes are calculated and displayed separately.- Anchor to taxExempttax•Boolean!
Exempt non-null Whether taxes are exempt on the order. Returns
true
for orders where the customer or business has a valid tax exemption, such as non-profit organizations or tax-free purchases. Use this to understand if tax calculations were skipped during checkout.- Anchor to taxLinestax•[Tax
Lines Line!]! non-null A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same
rate
andtitle
.- Anchor to testtest•Boolean!non-null
Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa.
- Anchor to totalCapturableSettotal•Money
Capturable Set Bag! non-null The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.
- Anchor to totalCashRoundingAdjustmenttotal•Cash
Cash Rounding Adjustment Rounding Adjustment! non-null The total rounding adjustment applied to payments or refunds for an order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination.
- Anchor to totalDiscountsSettotal•Money
Discounts Set Bag The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.
- Anchor to totalOutstandingSettotal•Money
Outstanding Set Bag! non-null The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).
- Anchor to totalPriceSettotal•Money
Price Set Bag! non-null The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.
- Anchor to totalReceivedSettotal•Money
Received Set Bag! non-null The total amount received from the customer before returns, in shop and presentment currencies.
- Anchor to totalRefundedSettotal•Money
Refunded Set Bag! non-null The total amount that was refunded, in shop and presentment currencies.
- Anchor to totalRefundedShippingSettotal•Money
Refunded Shipping Set Bag! non-null The total amount of shipping that was refunded, in shop and presentment currencies.
- Anchor to totalShippingPriceSettotal•Money
Shipping Price Set Bag! non-null The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded.
- Anchor to totalTaxSettotal•Money
Tax Set Bag The total tax amount before returns, in shop and presentment currencies.
- Anchor to totalTipReceivedSettotal•Money
Tip Received Set Bag! non-null The sum of all tip amounts for the order, in shop and presentment currencies.
- Anchor to totalWeighttotal•Unsigned
Weight Int64 The total weight of the order before returns, in grams.
- Anchor to transactionstransactions•[Order
Transaction!]! non-null A list of transactions associated with the order.
- Anchor to transactionsCounttransactions•Count
Count The number of transactions associated with the order.
- Anchor to unpaidunpaid•Boolean!non-null
Whether no payments have been made for the order.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time in ISO 8601 format when the order was last modified.
- Anchor to cartDiscountAmountcart•Money
Discount Amount Deprecated - Anchor to channelchannel•ChannelDeprecated
- Anchor to customerJourneycustomer•Customer
Journey Journey Deprecated - Anchor to landingPageDisplayTextlanding•String
Page Display Text Deprecated - Anchor to landingPageUrllanding•URL
Page Url Deprecated - Anchor to localizationExtensionslocalization
Extensions