Choose a version:

Node

interface

An object with an ID field to support global identification, in accordance with the Relay specification. This interface is used by the node and nodes queries.

Anchor to FieldsFields

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to AdditionalFeeSale AdditionalFeeSale

•OBJECT

A sale that includes an additional fee charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to AdjustmentSale AdjustmentSale

•OBJECT

A sale event that results in an adjustment to the order price.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to AppliedGiftCard AppliedGiftCard

•OBJECT

The details about the gift card used on the checkout.

Anchor to amountUsedamountUsed •MoneyV2! non-null: The amount deducted from the gift card.
Anchor to balancebalance •MoneyV2! non-null: The remaining amount on the gift card.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lastCharacterslastCharacters •String! non-null: The last characters of the gift card.
Anchor to presentmentAmountUsedpresentmentAmountUsed •MoneyV2! non-null: The amount applied to the checkout in its currency.

Anchor to Checkout Checkout

•OBJECT

A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to appliedGiftCardsappliedGiftCards •[AppliedGiftCard!]! non-null: The gift cards used on the checkout.
Anchor to availableShippingRatesavailableShippingRates •AvailableShippingRates: The available shipping rates for this Checkout. Should only be used when checkout requiresShipping is true and the shipping address is valid.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the checkout was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The currency code for the checkout.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: The extra information added to the checkout.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection! non-null: The discounts applied on the checkout.
Anchor to emailemail •String: The email associated with this checkout.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemslineItems •CheckoutLineItemConnection! non-null: A list of line item objects, each containing information about an item in the checkout.
Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice •MoneyV2! non-null: The sum of all the prices of all the items in the checkout, excluding duties, taxes, shipping, and discounts.
Anchor to notenote •String: The note associated with the checkout.
Anchor to paymentDuepaymentDue •MoneyV2! non-null: The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards.
Anchor to readyready •Boolean! non-null: Whether the Checkout is ready and can be completed. Checkouts may have asynchronous operations that can take time to finish. If you want to complete a checkout or ensure all the fields are populated and up to date, polling is required until the value is true.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether the fulfillment requires shipping.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]! non-null: The discounts allocated to the shipping line by discount applications.
Anchor to shippingLineshippingLine •ShippingRate: The selected shipping rate, transitioned to a shipping_line object.
Anchor to subtotalPricesubtotalPrice •MoneyV2! non-null: The price at checkout before duties, shipping, and taxes.
Anchor to taxesIncludedtaxesIncluded •Boolean! non-null: Whether taxes are included in the line item and shipping line prices.
Anchor to taxExempttaxExempt •Boolean! non-null: Whether the checkout is tax exempt.
Anchor to totalDutiestotalDuties •MoneyV2: The sum of all the duties applied to the line items in the checkout.
Anchor to totalPricetotalPrice •MoneyV2! non-null: The sum of all the prices of all the items in the checkout, duties, taxes, and discounts included.
Anchor to totalTaxtotalTax •MoneyV2! non-null: The sum of all the taxes applied to the line items and shipping lines in the checkout.
Anchor to webUrlwebUrl •URL! non-null: The URL for the checkout, accessible from the web.

Anchor to CheckoutLineItem CheckoutLineItem

•OBJECT

A line item in the checkout, grouped by variant and attributes.

Anchor to customAttributescustomAttributes •[Attribute!]! non-null: An array of Key-Value pairs providing extra information about the line item.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to priceprice •MoneyV2: The price of the line item.
Anchor to quantityquantity •Int! non-null: The quantity of the line item.
Anchor to titletitle •String! non-null: The title of the line item. Defaults to the product's title.
Anchor to unitPriceunitPrice •MoneyV2: The unit price of the line item.
Anchor to variantTitlevariantTitle •String: The name of the variant.

Anchor to Company Company

•OBJECT

Represents a company's information.

Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of company draft orders.
Anchor to externalIdexternalId •String Pre-auth accessible: A unique externally-supplied ID for the company.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to locationslocations •CompanyLocationConnection! non-null: The list of locations that the business of the business contact belongs to.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The name of the company.
Anchor to ordersorders •OrderConnection! non-null: The list of customer orders under the company.

Anchor to CompanyAddress CompanyAddress

•OBJECT

The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to address1address1

•String!

non-null

The first line of the address. It is typically the street address or PO Box number.

Anchor to address2address2

•String

The second line of the address. It is typically the apartment, suite, or unit number.

Anchor to citycity

•String

The city, district, village, or town.

Anchor to companyNamecompanyName

•String!

non-null

The name of the company.

Anchor to countrycountry

•String

The name of the country of the address.

Anchor to countryCodecountryCode

•CountryCode!

non-null

The two-letter code for the country of the address, for example, US.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time (in ISO 8601 format) when the company address was created.

Anchor to firstNamefirstName

•String

The first name of the recipient.

Anchor to formattedAddressformattedAddress

•[String!]!

non-null

The formatted version of the address.

Anchor to withNamewithName •Boolean Default:false: Whether to include the name of the recipient in the formatted address.
Anchor to withCompanyNamewithCompanyName •Boolean Default:true: Whether to include the company name in the formatted address.

Anchor to formattedAreaformattedArea

•String

A comma-separated list of the city, province, and country values.

Anchor to idid

•ID!

non-nullPre-auth accessible

A globally-unique ID.

Anchor to lastNamelastName

•String

The last name of the recipient.

Anchor to phonephone

•String

The unique phone number of the customer, formatted using the E.164 standard, for example, +16135551111.

Anchor to provinceprovince

•String

The region of the address, such as the province, state, or district.

Anchor to recipientrecipient

•String

The identity of the recipient, for example, 'Receiving Department'.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time (in ISO 8601 format) when the company address was last updated.

Anchor to zipzip

•String

The zip or postal code of the address.

Anchor to zoneCodezoneCode

•String

The alphanumeric code for the region, for example, ON.

Anchor to CompanyContact CompanyContact

•OBJECT

Represents the customer's contact information.

Anchor to companycompany •Company: The information of the copmany contact's company.
Anchor to customercustomer •Customer! non-null: The customer associated to this contact.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of company contact's draft orders.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to locationslocations •CompanyLocationConnection! non-null: The list of locations that the company contact belongs to.
Anchor to ordersorders •OrderConnection! non-null: The list of company contact's orders.
Anchor to titletitle •String: The job title of the company contact.

Anchor to CompanyContactRole CompanyContactRole

•OBJECT

A role for a company contact. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to namename •String! non-null: The name of the role.
Anchor to resourcePermissionresourcePermission •[PermittedOperation!]! non-null: The permissions on a specified resource.
Anchor to resourcePermissionsresourcePermissions •[ResourcePermission!]! non-null: A list of permissions on all resources.

Anchor to CompanyContactRoleAssignment CompanyContactRoleAssignment

•OBJECT

Represents information about a company contact role assignment.

Anchor to contactcontact •CompanyContact! non-null: The company contact for whom this role is assigned.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to rolerole •CompanyContactRole! non-null: The role that's assigned.

Anchor to CompanyLocation CompanyLocation

•OBJECT

Represents a company's business location.

Anchor to billingAddressbillingAddress •CompanyAddress Pre-auth accessible: The billing address of the company location.
Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration •BuyerExperienceConfiguration Pre-auth accessible: The configuration of the buyer's B2B checkout.
Anchor to contactscontacts •CompanyContactConnection! non-null: The list of contacts under a particular business location.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of company draft orders.
Anchor to externalIdexternalId •String Pre-auth accessible: A unique externally-supplied ID for the location.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The name of the company location.
Anchor to ordersorders •OrderConnection! non-null: The list of customer orders under the company.
Anchor to roleAssignmentsroleAssignments •CompanyContactRoleAssignmentConnection! non-null: The list of roles assigned to this location.
Anchor to shippingAddressshippingAddress •CompanyAddress Pre-auth accessible: The shipping address of the company location.
Anchor to taxIdentifiertaxIdentifier •String: The tax id of the company location.
Anchor to marketmarket •Market! non-nullDeprecatedPre-auth accessible

Anchor to Customer Customer

•OBJECT

Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to addressesaddresses •CustomerAddressConnection! non-null: The addresses associated with the customer.
Anchor to companyContactscompanyContacts •CompanyContactConnection! non-null: The list of contacts the customer is associated with.
Anchor to creationDatecreationDate •DateTime! non-null: The date and time when the customer was created.
Anchor to defaultAddressdefaultAddress •CustomerAddress: The default address of the customer.
Anchor to displayNamedisplayName •String! non-null: The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The Draft Orders associated with the customer.
Anchor to emailAddressemailAddress •CustomerEmailAddress Pre-auth accessible: The email address of the customer.
Anchor to firstNamefirstName •String: The first name of the customer.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageUrlimageUrl •URL! non-null: The URL to the avatar image of the customer.
Anchor to lastIncompleteCheckoutlastIncompleteCheckout •Checkout: The customer's most recently updated, incomplete checkout.
Anchor to lastNamelastName •String: The last name of the customer.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to ordersorders •OrderConnection! non-null: The orders associated with the customer.
Anchor to phoneNumberphoneNumber •CustomerPhoneNumber Pre-auth accessible: The phone number of the customer.
Anchor to storeCreditAccountsstoreCreditAccounts •StoreCreditAccountConnection! non-nullPre-auth accessible: A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout.
Anchor to subscriptionContractsubscriptionContract •SubscriptionContract: A Subscription Contract resource identified by ID.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: The Subscription Contracts associated with the customer.
Anchor to tagstags •[String!]! non-null: A comma-separated list of tags that have been added to the customer.

Anchor to CustomerAddress CustomerAddress

•OBJECT

Represents a customer's mailing address. For example, a customer's default address and an order's billing address are both mailing addresses. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to address1address1

•String

Pre-auth accessible

The first line of the address. Typically the street address or PO Box number.

Anchor to address2address2

•String

Pre-auth accessible

The second line of the address. This is typically the apartment, suite, or unit number.

Anchor to citycity

•String

Pre-auth accessible

The name of the city, district, village, or town.

Anchor to companycompany

•String

Pre-auth accessible

The name of the customer's company or organization.

Anchor to countrycountry

•String

Pre-auth accessible

The name of the country.

Anchor to firstNamefirstName

•String

Pre-auth accessible

The first name of the customer.

Anchor to formattedformatted

•[String!]!

non-nullPre-auth accessible

A formatted version of the address, customized by the provided arguments.

Anchor to withNamewithName •Boolean Default:false: Determines whether to include the customer's name in the formatted address.
Anchor to withCompanywithCompany •Boolean Default:true: Determines whether to include the customer's company in the formatted address.

Anchor to formattedAreaformattedArea

•String

Pre-auth accessible

A comma-separated list of the values for city, province, and country.

Anchor to idid

•ID!

non-nullPre-auth accessible

A globally-unique ID.

Anchor to lastNamelastName

•String

Pre-auth accessible

The last name of the customer.

Anchor to namename

•String

Pre-auth accessible

The full name of the customer, based on firstName and lastName.

Anchor to phoneNumberphoneNumber

•String

Pre-auth accessible

The customer's unique phone number.

Formatted using E.164 standard. For example, +16135551111.

Anchor to provinceprovince

•String

Pre-auth accessible

The region of the address, such as the province, state, or district.

Anchor to territoryCodeterritoryCode

•CountryCode

Pre-auth accessible

The two-letter code for the country of the address.

For example, US.

Anchor to zipzip

•String

Pre-auth accessible

The zip or postal code of the address.

Anchor to zoneCodezoneCode

•String

Pre-auth accessible

The alphanumeric code for the region.

For example, ON.

Anchor to Domain Domain

•OBJECT

A unique string representing the address of a Shopify store on the Internet.

Anchor to hosthost •String! non-null: The host name of the domain (for example, example.com).
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to redirectHostredirectHost •String: The host of the primary domain that this domain redirects to (for example, example.com).
Anchor to urlurl •URL! non-null: The URL of the domain (for example, example.com).

Anchor to DraftOrder DraftOrder

•OBJECT

A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to amountDueLateramountDueLater •MoneyV2! 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 amountDueNowamountDueNow •MoneyV2! 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 billingAddressbillingAddress •CustomerAddress: The billing address of the customer.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the draft order was created in Shopify.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The three-letter code for the currency of the store at the time that the invoice is sent.
Anchor to customercustomer •Customer: The customer who placed the order.
Anchor to depositdeposit •DepositConfiguration: The portion required to be paid at checkout.
Anchor to discountInformationdiscountInformation •DraftOrderDiscountInformation! non-null: The discount information for the draft order.
Anchor to emailemail •String: The email address of the customer, which is used to send notifications to.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to inReviewinReview •Boolean! non-null: Whether the draft order is created from the online store and is open.
Anchor to invoiceUrlinvoiceUrl •URL: The link to the checkout, which is sent to the customer in the invoice email.
Anchor to lineItemslineItems •DraftOrderLineItemConnection! non-null: The list of the line items in the draft order.
Anchor to lineItemsSummarylineItemsSummary •DraftOrderLineItemsSummary: The summary of draft order line items quantity.
Anchor to namename •String! non-nullPre-auth accessible: The unique identifier for the draft order, which is unique within the store. For example, #D1223.
Anchor to orderorder •Order: The order that was created from this draft order.
Anchor to phonephone •String: The phone number assigned to the draft order.
Anchor to purchasingEntitypurchasingEntity •PurchasingEntity: The purchasing entity for the draft order.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether the draft order requires shipping or not.
Anchor to shippingAddressshippingAddress •CustomerAddress: The shipping address of the customer.
Anchor to statusstatus •DraftOrderStatus! non-null: The status of the draft order.
Anchor to subtotalPricesubtotalPrice •MoneyV2! non-null: The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes).
Anchor to taxesIncludedtaxesIncluded •Boolean! non-null: Whether the line item prices include taxes.
Anchor to taxExempttaxExempt •Boolean! non-null: Indicates whether the draft order is tax exempt.
Anchor to totalLineItemsPricetotalLineItemsPrice •MoneyV2! non-null: The total price of line items for this draft order.
Anchor to totalPricetotalPrice •MoneyV2! non-null: The total amount of the draft order (includes taxes, shipping charges, and discounts).
Anchor to totalShippingPricetotalShippingPrice •MoneyV2! non-null: The total shipping charge for the draft order.
Anchor to totalTaxtotalTax •MoneyV2! non-null: The total amount of taxes for the draft order.
Anchor to totalWeighttotalWeight •UnsignedInt64! non-null: The total weight (in grams) of the draft order.
Anchor to updatedAtupdatedAt •DateTime! 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 DraftOrderLineItem DraftOrderLineItem

•OBJECT

A line item included in a draft order.

Anchor to discountedTotaldiscountedTotal •MoneyV2! non-null: The total price of the line item after discounts have been applied.
Anchor to discountedUnitPricediscountedUnitPrice •MoneyV2! non-null: The discounted total divided by the quantity, resulting in the value of the discount per unit.
Anchor to discountInformationdiscountInformation •DraftOrderLineItemDiscountInformation! non-null: The discount information for the draft order line item.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageimage •Image: The image associated with the line item.
Anchor to namename •String! non-null: The name of the product.
Anchor to originalTotaloriginalTotal •MoneyV2! non-null: The total price of the line item, based on the original unit price of the variant multiplied by the quantity. This total doesn't include any discounts.
Anchor to originalUnitPriceoriginalUnitPrice •MoneyV2! non-null: The price of the variant without any discounts applied.
Anchor to quantityquantity •Int! non-null: The quantity of this variant item in the draft order.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether the variant requires physical shipping.
Anchor to skusku •String: The SKU number of the variant.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to titletitle •String! non-null: The title of the product or variant. This only applies to custom line items.
Anchor to variantTitlevariantTitle •String: The name of the product variant.
Anchor to vendorvendor •String: The name of the vendor of the variant.
Anchor to weightweight •Weight: The weight of the line item, including the unit and value.

Anchor to DutySale DutySale

•OBJECT

A sale that includes a duty charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to ExchangeLineItem ExchangeLineItem

•OBJECT

An item for exchange.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageimage •Image Pre-auth accessible: The image associated to the line item's variant.
Anchor to productHasOnlyDefaultVariantproductHasOnlyDefaultVariant •Boolean Pre-auth accessible: Whether the product has only a single variant with the default option and value.
Anchor to productIdproductId •ID Pre-auth accessible: The ID of the product at time of refund creation.
Anchor to quantityquantity •Int! non-nullPre-auth accessible: The number of variant items ordered.
Anchor to titletitle •String Pre-auth accessible: The title of the product at time of order creation.
Anchor to variantIdvariantId •ID Pre-auth accessible: The ID of the variant at time of refund creation.
Anchor to variantSkuvariantSku •String Pre-auth accessible: The variant SKU number.
Anchor to variantTitlevariantTitle •String Pre-auth accessible: The title of the variant at time of refund creation.

Anchor to FeeSale FeeSale

•OBJECT

A sale associated with a fee.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to Fulfillment Fulfillment

•OBJECT

Represents a single fulfillment in an order.

Anchor to createdAtcreatedAt •DateTime! non-nullPre-auth accessible: The date and time when the fulfillment was created.
Anchor to estimatedDeliveryAtestimatedDeliveryAt •DateTime Pre-auth accessible: The estimated delivery time of this fulfillment.
Anchor to eventsevents •FulfillmentEventConnection! non-nullPre-auth accessible: A collection of fulfillment events.
Anchor to fulfillmentLineItemsfulfillmentLineItems •FulfillmentLineItemConnection! non-nullPre-auth accessible: The line items in the fulfillment.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to isPickedUpisPickedUp •Boolean! non-nullPre-auth accessible: Whether the fulfillment is picked up locally.
Anchor to latestShipmentStatuslatestShipmentStatus •FulfillmentEventStatus: The latest shipment status for the fulfillment.
Anchor to requiresShippingrequiresShipping •Boolean! non-nullPre-auth accessible: Whether any line items in the fulfillment require shipping.
Anchor to statusstatus •FulfillmentStatus Pre-auth accessible: The status of the fulfillment.
Anchor to trackingInformationtrackingInformation •[TrackingInformation!]! non-nullPre-auth accessible: The tracking information associated with the fulfillment.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the fulfillment was updated.

Anchor to FulfillmentEvent FulfillmentEvent

•OBJECT

An event that occurred for a fulfillment.

Anchor to happenedAthappenedAt •DateTime! non-nullPre-auth accessible: The time when this fulfillment event occurred.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to statusstatus •FulfillmentEventStatus! non-nullPre-auth accessible: The status of the fulfillment event.

Anchor to FulfillmentLineItem FulfillmentLineItem

•OBJECT

Represents a line item from an order that's included in a fulfillment.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemlineItem •LineItem! non-nullPre-auth accessible: The line item associated with the order.
Anchor to quantityquantity •Int Pre-auth accessible: The number of line items in the fulfillment.

Anchor to GiftCardSale GiftCardSale

•OBJECT

A sale associated with a gift card.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item associated with the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to LineItem LineItem

•OBJECT

A single line item in an order.

Anchor to currentTotalPricecurrentTotalPrice •MoneyV2 Pre-auth accessible: The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.
Anchor to customAttributescustomAttributes •[Attribute!]! non-nullPre-auth accessible: The list of custom attributes associated with the line item.
Anchor to discountAllocationsdiscountAllocations •[DiscountAllocation!]! non-nullPre-auth accessible: The discounts that have been allocated onto the line item by discount applications.
Anchor to giftCardgiftCard •Boolean! non-nullPre-auth accessible: Whether the line item represents the purchase of a gift card.
Anchor to groupgroup •LineItemGroup Pre-auth accessible: The line item group associated to the line item.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageimage •Image Pre-auth accessible: The image object associated with the line item.
Anchor to namename •String! non-nullPre-auth accessible: The name of the product.
Anchor to presentmentTitlepresentmentTitle •String Pre-auth accessible: The title of the line item variant.
Anchor to priceprice •MoneyV2 Pre-auth accessible: The product variant price without any discounts applied, in presentment currencies.
Anchor to productIdproductId •ID Pre-auth accessible: The product's ID.
Anchor to productTypeproductType •String Pre-auth accessible: The product's type.
Anchor to quantityquantity •Int! non-nullPre-auth accessible: The number of variant items ordered.
Anchor to refundableQuantityrefundableQuantity •Int! non-nullPre-auth accessible: The quantity of the line item, minus the refunded quantity.
Anchor to requiresShippingrequiresShipping •Boolean! non-nullPre-auth accessible: Whether physical shipping is required for the variant.
Anchor to skusku •String Pre-auth accessible: The SKU number of the variant.
Anchor to titletitle •String! non-nullPre-auth accessible: The title of the product or variant. This field only applies to custom line items.
Anchor to totalDiscounttotalDiscount •MoneyV2! non-nullPre-auth accessible: The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item.
Anchor to totalPricetotalPrice •MoneyV2 Pre-auth accessible: The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies.
Anchor to unitPriceunitPrice •UnitPrice Pre-auth accessible: The unit price of the line item in presentment currencies.
Anchor to variantIdvariantId •ID Pre-auth accessible: The ID of the variant.
Anchor to variantOptionsvariantOptions •[LineItemVariantOption!] Pre-auth accessible: The options of the product variant.
Anchor to variantTitlevariantTitle •String Pre-auth accessible: The name of the variant.
Anchor to vendorvendor •String Pre-auth accessible: The product's vendor.

Anchor to LineItemGroup LineItemGroup

•OBJECT

A line item group to which a line item belongs to.

Anchor to currentTotalPricecurrentTotalPrice •MoneyV2 Pre-auth accessible: The total price of the line item group, calculated by aggregating the current total price of its line item components.
Anchor to discountInformationdiscountInformation •[LineItemDiscountInformation!] Pre-auth accessible: The discount information for the line item group.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to imageimage •Image Pre-auth accessible: The image of the line item group variant or the product image if the variant has no image.
Anchor to quantityquantity •Int! non-nullPre-auth accessible: The number of line item groups ordered.
Anchor to titletitle •String! non-nullPre-auth accessible: The title of the line item group.
Anchor to totalPriceBeforeDiscountstotalPriceBeforeDiscounts •MoneyV2 Pre-auth accessible: The total price of the line item group, calculated by aggregating the total price before discounts of its line item components.

Anchor to Market Market

•OBJECT

A market, which is a group of one or more regions targeted for international sales. A market allows configuration of a distinct, localized shopping experience for customers from a specific area of the world.

Anchor to handlehandle •String! non-nullPre-auth accessible: The short, human-readable unique identifier for the market.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to webPresencewebPresence •MarketWebPresence Pre-auth accessible: The web presence of the market, defining its SEO strategy. This can be a different domain, subdomain, or subfolders of the primary domain. Each web presence comprises one or more language variants. If a market doesn't have its own web presence, an inherited web presence will be returned.

Anchor to MarketWebPresence MarketWebPresence

•OBJECT

The web presence of the market, defining its SEO strategy. This can be a different domain (e.g. example.ca), subdomain (e.g. ca.example.com), or subfolders of the primary domain (e.g. example.com/en-ca). Each web presence comprises one or more language variants. If a market does not have its own web presence, it is accessible on the shop’s primary domain via country selectors.

Note: while the domain/subfolders defined by a market’s web presence are not applicable to custom storefronts, which must manage their own domains and routing, the languages chosen here do govern the languages available on the Storefront API for the countries in this market.

Anchor to domaindomain •Domain Pre-auth accessible: The domain of the web presence. This field will be null if subfolderSuffix isn't null.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique identifier.
Anchor to rootUrlsrootUrls •[MarketWebPresenceRootUrl!]! non-nullPre-auth accessible: The list of root URLs for each of the web presence’s locales.
Anchor to subfolderSuffixsubfolderSuffix •String Pre-auth accessible: The market-specific suffix of the subfolders defined by the web presence. Example: in /en-us the subfolder suffix is us. This field will be null if domain isn't null.

Anchor to Metafield Metafield

•OBJECT

The custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

Anchor to compareDigestcompareDigest •String! non-null: The data stored in the resource, represented as a digest.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the metafield was created.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to jsonValuejsonValue •JSON! non-null: The data stored in the metafield in JSON format.
Anchor to keykey •String! non-nullPre-auth accessible: The key name for a metafield.
Anchor to namespacenamespace •String! non-nullPre-auth accessible: The namespace for a metafield.
Anchor to typetype •String! non-nullPre-auth accessible: The type name of the metafield. See the list of supported types.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the metafield was updated.
Anchor to valuevalue •String! non-nullPre-auth accessible: The value of a metafield.
Anchor to descriptiondescription •String Deprecated

Anchor to Order Order

•OBJECT

A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to agreementsagreements •SalesAgreementConnection! non-nullPre-auth accessible: A list of sales agreements associated with the order.
Anchor to billingAddressbillingAddress •CustomerAddress Pre-auth accessible: The mailing address provided by the customer. Not all orders have a mailing address.
Anchor to cancelledAtcancelledAt •DateTime Pre-auth accessible: The date and time when the order was canceled. Returns null if the order wasn't canceled.
Anchor to cancelReasoncancelReason •OrderCancelReason Pre-auth accessible: The reason for the cancellation of the order. Returns null if the order wasn't canceled.
Anchor to confirmationNumberconfirmationNumber •String Pre-auth accessible: A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". This value isn't guaranteed to be unique.
Anchor to createdAtcreatedAt •DateTime! non-nullPre-auth accessible: The date and time when the order was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-nullPre-auth accessible: The shop currency when the order was placed.
Anchor to customercustomer •Customer Pre-auth accessible: The customer who placed the order.
Anchor to customerLocalecustomerLocale •String Pre-auth accessible: The locale code representing the region where this specific order was placed.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection! non-nullPre-auth accessible: The discounts that have been applied to the order.
Anchor to draftOrderdraftOrder •DraftOrder Pre-auth accessible: The draft order associated with the order.
Anchor to dutiesIncludeddutiesIncluded •Boolean! non-nullPre-auth accessible: Whether the order includes duties.
Anchor to editededited •Boolean! non-nullPre-auth accessible: Whether the order has been edited or not.
Anchor to emailemail •String Pre-auth accessible: The email address of the customer.
Anchor to financialStatusfinancialStatus •OrderFinancialStatus Pre-auth accessible: The financial status of the order.
Anchor to fulfillmentsfulfillments •FulfillmentConnection! non-nullPre-auth accessible: The fulfillments associated with the order.
Anchor to fulfillmentStatusfulfillmentStatus •OrderFulfillmentStatus! non-nullPre-auth accessible: The fulfillment status of the order.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemslineItems •LineItemConnection! non-nullPre-auth accessible: The list of line items of the order.
Anchor to locationNamelocationName •String Pre-auth accessible: The name of the fulfillment location assigned at the time of order creation.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-nullPre-auth accessible: The identifier for the order that appears on the order. For example, #1000 or _Store1001.
Anchor to notenote •String Pre-auth accessible: The order's notes.
Anchor to numbernumber •Int! non-nullPre-auth accessible: A unique numeric identifier for the order, used by both the shop owner and customer.
Anchor to paymentInformationpaymentInformation •OrderPaymentInformation Pre-auth accessible: The payment information for the order.
Anchor to phonephone •String: The phone number of the customer for SMS notifications.
Anchor to poNumberpoNumber •String Pre-auth accessible: The purchase order number of the order.
Anchor to processedAtprocessedAt •DateTime! non-nullPre-auth accessible: The date and time when the order was processed. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.
Anchor to purchasingEntitypurchasingEntity •PurchasingEntity Pre-auth accessible: The purchasing entity for the order.
Anchor to refundsrefunds •[Refund!]! non-nullPre-auth accessible: A list of refunds associated with the order.
Anchor to requiresShippingrequiresShipping •Boolean! non-nullPre-auth accessible: Whether the order requires shipping.
Anchor to returnInformationreturnInformation •OrderReturnInformation! non-nullPre-auth accessible: The return information for the order.
Anchor to returnsreturns •ReturnConnection! non-nullPre-auth accessible: The list of returns for the order with pagination.
Anchor to shippingAddressshippingAddress •CustomerAddress Pre-auth accessible: The mailing address to which the order items are shipped.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]! non-nullPre-auth accessible: The discounts that have been allocated onto the shipping line by discount applications.
Anchor to shippingLineshippingLine •ShippingLine Pre-auth accessible: A summary of all shipping costs on the order.
Anchor to statusPageUrlstatusPageUrl •URL! non-nullPre-auth accessible: The unique URL for the status page of the order.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection: The customer Subscription Contracts associated with the order.
Anchor to subtotalsubtotal •MoneyV2 Pre-auth accessible: The price of the order before duties, shipping, and taxes.
Anchor to taxesIncludedtaxesIncluded •Boolean! non-nullPre-auth accessible: Whether the order includes taxes.
Anchor to totalDutiestotalDuties •MoneyV2 Pre-auth accessible: The total amount of duties after returns.
Anchor to totalPricetotalPrice •MoneyV2! non-nullPre-auth accessible: The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.
Anchor to totalRefundedtotalRefunded •MoneyV2! non-nullPre-auth accessible: The total amount refunded.
Anchor to totalShippingtotalShipping •MoneyV2! non-nullPre-auth accessible: The total cost of shipping.
Anchor to totalTaxtotalTax •MoneyV2 Pre-auth accessible: The total cost of taxes.
Anchor to totalTiptotalTip •MoneyV2 Pre-auth accessible: The total value of tips.
Anchor to transactionstransactions •[OrderTransaction!]! non-nullPre-auth accessible: A list of transactions associated with the order.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the order was last updated.

Anchor to OrderAgreement OrderAgreement

•OBJECT

An agreement associated with an order placement.

Anchor to happenedAthappenedAt •DateTime! non-null: The date and time when the agreement occurred.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to orderorder •Order! non-null: The order associated with the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agreement was created.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.

Anchor to OrderEditAgreement OrderEditAgreement

•OBJECT

An agreement related to an edit of the order.

Anchor to happenedAthappenedAt •DateTime! non-null: The date and time when the agreement occurred.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agreement was created.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.

Anchor to OrderTransaction OrderTransaction

•OBJECT

A payment transaction within an order context.

Anchor to createdAtcreatedAt •DateTime! non-nullPre-auth accessible: The date and time when the transaction was created.
Anchor to giftCardDetailsgiftCardDetails •GiftCardDetails Pre-auth accessible: The gift card details for the transaction.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to kindkind •OrderTransactionKind Pre-auth accessible: The kind of the transaction.
Anchor to orderorder •Order Pre-auth accessible: The associated order for the transaction.
Anchor to paymentDetailspaymentDetails •PaymentDetails Pre-auth accessible: The payment details for the transaction.
Anchor to paymentIconpaymentIcon •PaymentIconImage Pre-auth accessible: The payment icon to display for the transaction.
Anchor to processedAtprocessedAt •DateTime Pre-auth accessible: The date and time when the transaction was processed.
Anchor to statusstatus •OrderTransactionStatus Pre-auth accessible: The status of the transaction.
Anchor to transactionAmounttransactionAmount •MoneyBag! non-nullPre-auth accessible: The amount and currency of the transaction in shop and presentment currencies.
Anchor to transactionParentIdtransactionParentId •String Pre-auth accessible: The ID of the parent transaction.
Anchor to typetype •OrderTransactionType! non-nullPre-auth accessible: The type of the transaction.
Anchor to typeDetailstypeDetails •TransactionTypeDetails Pre-auth accessible: The details of the transaction type.

Anchor to PaymentIconImage PaymentIconImage

•OBJECT

Represents an image resource.

Anchor to altTextaltText

•String

Pre-auth accessible

A word or phrase to share the nature or contents of an image.

Anchor to heightheight

•Int

Pre-auth accessible

The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.

Anchor to idid

•ID!

non-nullPre-auth accessible

A unique non-nullable ID for the image.

Anchor to thumbhashthumbhash

•String

Pre-auth accessible

The ThumbHash of the image.

Useful to display placeholder images while the original image is loading.

Anchor to urlurl

•URL!

non-nullPre-auth accessible

The location of the image as a URL.

If no transform options are specified, then the original image will be preserved including any pre-applied transforms.

All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.

If you need multiple variations of the same image, then you can use GraphQL aliases.

Anchor to transformtransform •ImageTransformInput: A set of options to transform the original image.

Anchor to widthwidth

•Int

Pre-auth accessible

The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.

Anchor to originalSrcoriginalSrc

•URL!

non-nullDeprecatedPre-auth accessible

Anchor to srcsrc

•URL!

non-nullDeprecatedPre-auth accessible

Anchor to transformedSrctransformedSrc

•URL!

non-nullDeprecatedPre-auth accessible

Anchor to maxWidthmaxWidth •Int: Image width in pixels between 1 and 5760.
Anchor to maxHeightmaxHeight •Int: Image height in pixels between 1 and 5760.
Anchor to cropcrop •CropRegion: Crops the image according to the specified region.
Anchor to scalescale •Int Default:1: Image size multiplier for high-resolution retina displays. Must be between 1 and 3.
Anchor to preferredContentTypepreferredContentType •ImageContentType: Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported).

Anchor to PaymentSchedule PaymentSchedule

•OBJECT

A single payment schedule defined in the payment terms.

Anchor to completedcompleted •Boolean! non-nullPre-auth accessible: Whether the payment has been completed.
Anchor to completedAtcompletedAt •DateTime: The date and time when the payment schedule was paid or fulfilled.
Anchor to dueAtdueAt •DateTime Pre-auth accessible: The date and time when the payment schedule is due.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to totalBalancetotalBalance •MoneyV2! non-nullPre-auth accessible: Remaining balance to be paid or authorized by the customer for this payment schedule.
Anchor to amountamount •MoneyV2! non-nullDeprecatedPre-auth accessible

Anchor to PaymentTerms PaymentTerms

•OBJECT

The payment terms associated with an order or draft order.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to nextDueAtnextDueAt •DateTime Pre-auth accessible: The next due date if this is the NET or FIXED type of payment terms.
Anchor to overdueoverdue •Boolean! non-nullPre-auth accessible: Whether the payment terms have overdue payment schedules.
Anchor to paymentSchedulespaymentSchedules •PaymentScheduleConnection! non-nullPre-auth accessible: The list of schedules associated with the payment terms.
Anchor to paymentTermsNamepaymentTermsName •String! non-null: The name of the payment terms template that was used to create the payment terms.
Anchor to translatedNametranslatedName •String! non-null: The payment terms name, translated into the shop admin's preferred language.

Anchor to ProductSale ProductSale

•OBJECT

A sale associated with a product.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item for the associated sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to Refund Refund

•OBJECT

The record of refunds issued to a customer.

Anchor to createdAtcreatedAt •DateTime Pre-auth accessible: The date and time when the refund was created.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to returnNamereturnName •String Pre-auth accessible: The name of the return, if the refund was issued from a return.
Anchor to totalRefundedtotalRefunded •MoneyV2! non-nullPre-auth accessible: The total amount refunded across all transactions, in presentment currencies.
Anchor to updatedAtupdatedAt •DateTime! non-nullPre-auth accessible: The date and time when the refund was last updated.

Anchor to RefundAgreement RefundAgreement

•OBJECT

An agreement for refunding all or a portion of the order between the merchant and the customer.

Anchor to happenedAthappenedAt •DateTime! non-null: The date and time when the agreement occurred.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agreement was created.
Anchor to refundrefund •Refund! non-null: The refund that's associated with the agreement.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.

Anchor to Return Return

•OBJECT

A product return.

Anchor to closedAtclosedAt •DateTime Pre-auth accessible: The date when the return was closed.
Anchor to createdAtcreatedAt •DateTime: The date when the return was created.
Anchor to exchangeLineItemsexchangeLineItems •ExchangeLineItemConnection! non-nullPre-auth accessible: The exchange line items attached to the return.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to namename •String! non-nullPre-auth accessible: The name assigned to the return.
Anchor to returnLineItemsreturnLineItems •ReturnLineItemTypeConnection! non-nullPre-auth accessible: The line items associated with the return.
Anchor to returnLineItemsCountreturnLineItemsCount •Count Pre-auth accessible: The number of line items associated with the return.
Anchor to reverseDeliveriesreverseDeliveries •ReverseDeliveryConnection! non-nullPre-auth accessible: The list of reverse deliveries associated with the return.
Anchor to statusstatus •ReturnStatus! non-nullPre-auth accessible: The current status of the Return.
Anchor to updatedAtupdatedAt •DateTime: The date when the return was last updated.

Anchor to ReturnAgreement ReturnAgreement

•OBJECT

An agreement between the merchant and customer for a return.

Anchor to happenedAthappenedAt •DateTime! non-null: The date and time when the agreement occurred.
Anchor to idid •ID! non-null: The unique ID for the agreement.
Anchor to reasonreason •OrderActionType! non-null: The reason the agreement was created.
Anchor to returnreturn •Return! non-null: The return associated with the agreement.
Anchor to salessales •SaleConnection! non-null: The sales associated with the agreement.

Anchor to ReturnLineItem ReturnLineItem

•OBJECT

A line item that has been returned.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemlineItem •LineItem! non-nullPre-auth accessible: The related line item that has been returned.
Anchor to quantityquantity •Int! non-nullPre-auth accessible: The line item quantity that has been returned.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason the line item quantity was returned.

Anchor to ReverseDelivery ReverseDelivery

•OBJECT

A reverse delivery represents a package being sent back by a buyer to a merchant post-fulfillment. This could occur when a buyer requests a return and the merchant provides a shipping label. The reverse delivery includes the context of the items being returned, the method of return (for example, a shipping label), and the current status of the delivery (tracking information).

Anchor to customerGeneratedLabelcustomerGeneratedLabel •Boolean! non-null: Whether the label was generated by the customer.
Anchor to deliverabledeliverable •ReverseDeliveryDeliverable Pre-auth accessible: The deliverable linked with the reverse delivery.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.

Anchor to SaleTax SaleTax

•OBJECT

The tax allocated to a sale from a single tax line.

Anchor to amountamount •MoneyV2! non-null: The portion of the total tax amount on the related sale that's from the associated tax line.
Anchor to idid •ID! non-null: The unique ID for the sale tax.
Anchor to taxLinetaxLine •TaxLine! non-null: The tax line associated with the sale.

Anchor to ShippingLineSale ShippingLineSale

•OBJECT

A sale associated with a shipping charge.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to Shop Shop

•OBJECT

A collection of the general information about the shop.

Anchor to emailemail •String! non-null: The email of the shop.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to metafieldmetafield •Metafield Pre-auth accessible: A metafield found by namespace and key.
Anchor to metafieldsmetafields •[Metafield]! non-nullPre-auth accessible: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to myshopifyDomainmyshopifyDomain •String! non-null: The shop's .myshopify.com domain name.
Anchor to namename •String! non-null: The name of the shop.
Anchor to shopPoliciesshopPolicies •[ShopPolicy!]! non-null: The list of all legal policies associated with the shop.
Anchor to urlurl •URL! non-null: The URL of the shop's online store.

Anchor to ShopPolicy ShopPolicy

•OBJECT

A policy that a merchant has configured for their store, such as their refund or privacy policy.

Anchor to bodybody •HTML! non-null: The text of the policy. The maximum size is 512kb.
Anchor to handlehandle •String! non-null: The handle of the policy.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to titletitle •String! non-null: The title of the policy.
Anchor to urlurl •URL! non-null: The public URL to the policy.

Anchor to StoreCreditAccount StoreCreditAccount

•OBJECT

A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. The account is held in the specified currency and has an owner that cannot be transferred.

The account balance is redeemable at checkout only when the owner is authenticated via new customer accounts authentication.

Anchor to balancebalance •MoneyV2! non-nullPre-auth accessible: The current balance of the store credit account.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to transactionstransactions •StoreCreditAccountTransactionConnection! non-nullPre-auth accessible: The transaction history of the store credit account.

Anchor to StoreCreditAccountCreditTransaction StoreCreditAccountCreditTransaction

•OBJECT

A credit transaction which increases the store credit account balance.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to expiresAtexpiresAt •DateTime: The time at which the transaction expires. Debit transactions will always spend the soonest expiring credit first.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.
Anchor to remainingAmountremainingAmount •MoneyV2! non-null: The remaining amount of the credit. The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted. In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred.

Anchor to StoreCreditAccountDebitRevertTransaction StoreCreditAccountDebitRevertTransaction

•OBJECT

A debit revert transaction which increases the store credit account balance. Debit revert transactions are created automatically when a store credit account debit transaction is reverted.

Store credit account debit transactions are reverted when an order is cancelled, refunded or in the event of a payment failure at checkout. The amount added to the balance is equal to the amount reverted on the original credit.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to debitTransactiondebitTransaction •StoreCreditAccountDebitTransaction! non-null: The reverted debit transaction.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

Anchor to StoreCreditAccountDebitTransaction StoreCreditAccountDebitTransaction

•OBJECT

A debit transaction which decreases the store credit account balance.

Anchor to accountaccount •StoreCreditAccount! non-null: The store credit account that the transaction belongs to.
Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to balanceAfterTransactionbalanceAfterTransaction •MoneyV2! non-null: The balance of the account after the transaction.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the transaction was created.
Anchor to eventevent •StoreCreditSystemEvent! non-null: The event that caused the store credit account transaction.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to originorigin •StoreCreditAccountTransactionOrigin: The origin of the store credit account transaction.

Anchor to SubscriptionContract SubscriptionContract

•OBJECT

A Subscription Contract.

Anchor to billingPolicybillingPolicy •SubscriptionBillingPolicy! non-null: The billing policy associated with the subscription contract.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the subscription contract was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The currency used for the subscription contract.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of custom attributes to be added to the generated orders.
Anchor to deliveryMethoddeliveryMethod •SubscriptionDeliveryMethod: The delivery method for each billing of the subscription contract.
Anchor to deliveryPolicydeliveryPolicy •SubscriptionDeliveryPolicy! non-null: The delivery policy associated with the subscription contract.
Anchor to deliveryPricedeliveryPrice •MoneyV2! non-null: The delivery price for each billing of the subscription contract.
Anchor to discountsdiscounts •SubscriptionDiscountConnection: The list of subscription discounts associated with the subscription contract.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lastBillingAttemptErrorTypelastBillingAttemptErrorType •SubscriptionContractLastBillingErrorType: The last billing error type of the contract.
Anchor to lastPaymentStatuslastPaymentStatus •SubscriptionContractLastPaymentStatus: The current status of the last payment.
Anchor to lineslines •SubscriptionLineConnection! non-null: A list of subscription lines associated with the subscription contract.
Anchor to linesCountlinesCount •Count: The number of lines associated with the subscription contract.
Anchor to nextBillingDatenextBillingDate •DateTime: The next billing date for the subscription contract.
Anchor to notenote •String: A note that will be applied to the generated orders.
Anchor to ordersorders •OrderConnection! non-null: A list of the subscription contract's orders.
Anchor to originOrderoriginOrder •Order: The order from which the contract originated.
Anchor to revisionIdrevisionId •UnsignedInt64! non-null: The revision ID of the contract.
Anchor to statusstatus •SubscriptionContractSubscriptionStatus! non-null: The current status of the subscription contract.
Anchor to upcomingBillingCyclesupcomingBillingCycles •SubscriptionBillingCycleConnection! non-null: The upcoming billing cycles on the subscription contract.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the subscription contract was updated.

Anchor to TaxLine TaxLine

•OBJECT

The details about a single tax applied to the associated line item.

Anchor to channelLiablechannelLiable •Boolean! non-null: Whether the channel that submitted the tax line is responsible for remitting it.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to priceSetpriceSet •MoneyV2! non-null: The tax amount in shop and presentment currencies, calculated after discounts and before returns.
Anchor to raterate •Float: The proportion of the line item price represented by the tax, expressed as a decimal.
Anchor to ratePercentageratePercentage •Float: The proportion of the line item price represented by the tax, expressed as a percentage.
Anchor to sourcesource •String: The origin of the tax.
Anchor to titletitle •String! non-null: The name of the applied tax.

Anchor to TipSale TipSale

•OBJECT

A sale that is associated with a tip.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineItemlineItem •LineItem! non-null: The line item associated with the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The type of line associated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to UnknownSale UnknownSale

•OBJECT

This represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale.

Anchor to actionTypeactionType •SaleActionType! non-null: The type of order action represented by the sale.
Anchor to idid •ID! non-null: The unique ID of the sale.
Anchor to lineTypelineType •SaleLineType! non-null: The line type assocated with the sale.
Anchor to quantityquantity •Int: The number of units ordered or intended to be returned.
Anchor to taxestaxes •[SaleTax!]! non-null: The individual taxes associated with the sale.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The total sale amount after taxes and discounts.
Anchor to totalDiscountAmountAfterTaxestotalDiscountAmountAfterTaxes •MoneyV2! non-null: The total amount of discounts allocated to the sale after taxes.
Anchor to totalDiscountAmountBeforeTaxestotalDiscountAmountBeforeTaxes •MoneyV2! non-null: The total discounts allocated to the sale before taxes.
Anchor to totalTaxAmounttotalTaxAmount •MoneyV2! non-null: The total tax amount for the sale.

Anchor to UnverifiedReturnLineItem UnverifiedReturnLineItem

•OBJECT

An unverified return line item.

Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemlineItem •LineItem! non-nullPre-auth accessible: The specific line item that's being returned.
Anchor to quantityquantity •Int! non-nullPre-auth accessible: The quantity of the line item that's been returned.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason for returning the line item.

Was this section helpful?

Node

Anchor to FieldsFields

Anchor to Types implemented inTypes implemented in

Arguments

Arguments

Arguments

Arguments