Skip to main content
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.

•ID!
non-null

A globally-unique ID.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

A sale that includes an additional fee charge.

•OBJECT

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

•OBJECT

The details about the gift card used on the 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.

•OBJECT

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

•OBJECT

Represents a company's information.

•OBJECT

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

•OBJECT

Represents the customer's contact information.

•OBJECT

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

•OBJECT

Represents information about a company contact role assignment.

•OBJECT

Represents a company's business location.

•OBJECT

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

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

•OBJECT

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

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

•OBJECT

A line item included in a draft order.

•OBJECT

A sale that includes a duty charge.

•OBJECT

An item for exchange.

•OBJECT

A sale associated with a fee.

•OBJECT

Represents a single fulfillment in an order.

•OBJECT

An event that occurred for a fulfillment.

•OBJECT

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

•OBJECT

A sale associated with a gift card.

•OBJECT

A single line item in an order.

•OBJECT

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

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

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

•OBJECT

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

•OBJECT

An instance of a user-defined model based on a MetaobjectDefinition.

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

•OBJECT

An agreement associated with an order placement.

•OBJECT

An agreement related to an edit of the order.

•OBJECT

A payment transaction within an order context.

•OBJECT

Represents an image resource.

•OBJECT

A single payment schedule defined in the payment terms.

•OBJECT

The payment terms associated with an order or draft order.

•OBJECT

A sale associated with a product.

•OBJECT

The record of refunds issued to a customer.

•OBJECT

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

•OBJECT

A product return.

•OBJECT

An agreement between the merchant and customer for a return.

•OBJECT

A line item that has been returned.

•OBJECT

A standardized reason for returning an item.

  • Shopify offers an expanded library of return reasons available to all merchants
  • For each product, Shopify suggests a curated subset of reasons based on the product's category.
•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).

•OBJECT

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

•OBJECT

A sale associated with a shipping charge.

•OBJECT

A collection of the general information about the shop.

•OBJECT

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

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

•OBJECT

A credit transaction which increases the store credit account balance.

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

•OBJECT

A debit transaction which decreases the store credit account balance.

•OBJECT

A Subscription Contract.

•OBJECT

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

•OBJECT

A sale that is associated with a tip.

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

•OBJECT

An unverified return line item.


Was this section helpful?