Node

non-null

The list of collection publications. Each record represents information about the publication of a collection.

Anchor to collectionscollections

•CollectionConnection!

non-null

The list of collections published to the channel.

Anchor to handlehandle

non-null

The unique identifier for the channel.

Anchor to hasCollectionhasCollection

non-null

Whether the collection is available to the channel.

Anchor to idid •ID! required: The collection ID to check.

•ID!

non-null

A globally-unique ID.

non-null

The name of the channel.

Anchor to productPublicationsV3productPublicationsV3

non-null

The list of product publication records for products published to this channel.

Anchor to productsproducts

non-null

The list of products published to the channel.

Anchor to productsCountproductsCount

•Count

Retrieves the total count of products that are currently published to a specific sales channel. This provides a quick way to understand channel inventory without fetching the full product list.

For example, when building channel management dashboards, you can display how many products are available in each channel like "150 products in Online Store" or "75 products in Facebook Shop."

Use ChannelProductsCount to:

Display inventory summaries in channel management interfaces
Monitor product distribution across sales channels
Validate channel setup and product availability

The count reflects only published products and updates as merchants add or remove products from channels.

Learn more about sales channels. Limited to a maximum of 10000 by default.

Anchor to supportsFuturePublishingsupportsFuturePublishing

•ProductPublicationConnection!

non-null

Whether the channel supports future publishing.

Anchor to navigationItemsnavigationItems

•[NavigationItem!]!

non-nullDeprecated

Anchor to overviewPathoverviewPath

•URL

Deprecated

Anchor to productPublicationsproductPublications

non-nullDeprecated

Anchor to ChannelDefinition ChannelDefinition

•OBJECT

A channel definition represents channels surfaces on the platform. A channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat.

Anchor to channelNamechannelName •String! non-null: Name of the channel that this sub channel belongs to.
Anchor to handlehandle •String! non-null: Unique string used as a public identifier for the channel definition.
Anchor to idid •ID! non-null: The unique ID for the channel definition.
Anchor to isMarketplaceisMarketplace •Boolean! non-null: Whether this channel definition represents a marketplace.
Anchor to subChannelNamesubChannelName •String! non-null: Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).
Anchor to svgIconsvgIcon •String Deprecated

Anchor to ChannelInformation ChannelInformation

•OBJECT

Contains the information for a given sales channel.

Anchor to appapp •App! non-null: The app associated with the channel.
Anchor to channelDefinitionchannelDefinition •ChannelDefinition: The channel definition associated with the channel.
Anchor to channelIdchannelId •ID! non-null: The unique ID for the channel.
Anchor to idid •ID! non-null: A globally-unique ID.

Anchor to CheckoutProfile CheckoutProfile

•OBJECT

A checkout profile defines the branding settings and the UI extensions for a store's checkout. A checkout profile could be published or draft. A store might have at most one published checkout profile, which is used to render their live checkout. The store could also have multiple draft profiles that were created, previewed, and published using the admin checkout editor.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the checkout profile was created.
Anchor to editedAteditedAt •DateTime! non-null: The date and time when the checkout profile was last edited.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to isPublishedisPublished •Boolean! non-null: Whether the checkout profile is published or not.
Anchor to namename •String! non-null: The profile name.
Anchor to typOspPagesActivetypOspPagesActive •Boolean! non-null: Whether the checkout profile Thank You Page and Order Status Page are actively using extensibility or not.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the checkout profile was last updated.

Anchor to Collection Collection

•OBJECT

The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.

There are two types of collections:

Custom (manual) collections: You specify the products to include in a collection.
Smart (automated) collections: You define rules, and products matching those rules are automatically included in the collection.

The Collection object provides information to:

Organize products by category, season, or promotion.
Automate product grouping using rules (for example, by tag, type, or price).
Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).
Manage collection visibility and publication across sales channels.
Add rich descriptions, images, and metadata to enhance discovery.

Note

Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.

Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.

Learn about using metafields with smart collections.

Anchor to availablePublicationsCountavailablePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

Anchor to descriptiondescription

non-null

A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

•HTML!

non-null

The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Anchor to feedbackfeedback

•ResourceFeedback

Information about the collection that's provided through resource feedback.

Anchor to handlehandle

non-null

A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title Summer Catalog 2022 might have the handle summer-catalog-2022.

If the title is changed, the handle doesn't automatically change.

The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.

Anchor to hasProducthasProduct

non-null

Whether the collection includes the specified product.

Anchor to idid •ID! required: The ID of the product to check.

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image

The image associated with the collection.

Anchor to legacyResourceIdlegacyResourceId

•UnsignedInt64!

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to productsproducts

non-null

The products that are included in the collection.

Anchor to productsCountproductsCount

•Count

The number of products in the collection.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

non-null

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

Anchor to publishedOnPublicationpublishedOnPublication

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

Anchor to resourcePublicationsresourcePublications

•ResourcePublicationV2Connection!

non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

Anchor to resourcePublicationsV2resourcePublicationsV2

non-null

The list of resources that are either published or staged to be published to a publication.

Anchor to ruleSetruleSet

•CollectionRuleSet

For a smart (automated) collection, specifies the rules that determine whether a product is included.

Anchor to seoseo

•SEO!

non-null

If the default SEO fields for page title and description have been modified, contains the modified information.

Anchor to sortOrdersortOrder

•CollectionSortOrder!

non-null

The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

Anchor to templateSuffixtemplateSuffix

•String

The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid template.

Anchor to titletitle

non-null

The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications

•PublicationConnection!

non-null

The list of publications that the resource isn't published to.

Anchor to updatedAtupdatedAt

•MetafieldDefinitionConnection!

non-null

The date and time (ISO 8601 format) when the collection was last modified.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Anchor to privateMetafieldprivateMetafield

•PrivateMetafield

Deprecated

Anchor to privateMetafieldsprivateMetafields

•PrivateMetafieldConnection!

non-nullDeprecated

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to publicationspublications

•CollectionPublicationConnection!

non-nullDeprecated

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

Anchor to Comment Comment

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to unpublishedChannelsunpublishedChannels

•ChannelConnection!

non-nullDeprecated

•OBJECT

A comment on an article.

Anchor to articlearticle •Article: The article associated with the comment.
Anchor to authorauthor •CommentAuthor! non-null: The comment’s author.
Anchor to bodybody •String! non-null: The content of the comment.
Anchor to bodyHtmlbodyHtml •HTML! non-null: The content of the comment, complete with HTML formatting.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the comment was created.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to ipip •String: The IP address of the commenter.
Anchor to isPublishedisPublished •Boolean! non-null: Whether or not the comment is published.
Anchor to publishedAtpublishedAt •DateTime: The date and time when the comment was published.
Anchor to statusstatus •CommentStatus! non-null: The status of the comment.
Anchor to updatedAtupdatedAt •DateTime: The date and time when the comment was last updated.
Anchor to userAgentuserAgent •String: The user agent of the commenter.

Anchor to CommentEvent CommentEvent

•OBJECT

Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.

Anchor to actionaction •String! non-null: The action that occured.
Anchor to appTitleappTitle •String: The name of the app that created the event.
Anchor to attachmentsattachments •[CommentEventAttachment!]! non-null: The attachments associated with the comment event.
Anchor to attributeToAppattributeToApp •Boolean! non-null: Whether the event was created by an app.
Anchor to attributeToUserattributeToUser •Boolean! non-null: Whether the event was caused by an admin user.
Anchor to authorauthor •StaffMember! non-null: The name of the user that authored the comment event.
Anchor to canDeletecanDelete •Boolean! non-null: Whether the comment event can be deleted. If true, then the comment event can be deleted.
Anchor to canEditcanEdit •Boolean! non-null: Whether the comment event can be edited. If true, then the comment event can be edited.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the event was created.
Anchor to criticalAlertcriticalAlert •Boolean! non-null: Whether the event is critical.
Anchor to editededited •Boolean! non-null: Whether the comment event has been edited. If true, then the comment event has been edited.
Anchor to embedembed •CommentEventEmbed: The object reference associated with the comment event. For example, a product or discount).
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to messagemessage •FormattedString! non-null: Human readable text that describes the event.
Anchor to rawMessagerawMessage •String! non-null: The raw body of the comment event.
Anchor to subjectsubject •CommentEventSubject: The parent subject to which the comment event belongs.

Anchor to Company Company

•OBJECT

Represents information about a company which is also a customer of the shop.

Anchor to contactRolescontactRoles •CompanyContactRoleConnection! non-null: The list of roles for the company contacts.
Anchor to contactscontacts •CompanyContactConnection! non-null: The list of contacts in the company.
Anchor to contactsCountcontactsCount •Count: The number of contacts that belong to the company.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) at which the company was created in Shopify.
Anchor to customerSincecustomerSince •DateTime! non-null: The date and time (ISO 8601 format) at which the company became the customer.
Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to defaultRoledefaultRole •CompanyContactRole: The role proposed by default for a contact at the company.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of the company's draft orders.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to externalIdexternalId •String: A unique externally-supplied ID for the company.
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether the merchant added a timeline comment to the company.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lifetimeDurationlifetimeDuration •String! non-null: The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.
Anchor to locationslocations •CompanyLocationConnection! non-null: The list of locations in the company.
Anchor to locationsCountlocationsCount •Count: The number of locations that belong to the company.
Anchor to mainContactmainContact •CompanyContact: The main contact for the company.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String! non-null: The name of the company.
Anchor to notenote •String: A note about the company.
Anchor to ordersorders •OrderConnection! non-null: The list of the company's orders.
Anchor to ordersCountordersCount •Count: The total number of orders placed for this company, across all its locations.
Anchor to totalSpenttotalSpent •MoneyV2! non-null: The total amount spent by this company, across all its locations.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) at which the company was last modified.
Anchor to contactCountcontactCount •Int! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to CompanyAddress CompanyAddress

•OBJECT

Represents a billing or shipping address for a company location.

Anchor to address1address1

non-null

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

Anchor to address2address2

•String

The second line of the address. Typically the number of the apartment, suite, or unit.

Anchor to citycity

•String

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

Anchor to companyNamecompanyName

non-null

The name of the company.

Anchor to countrycountry

•String

The name of the country.

Anchor to countryCodecountryCode

•CountryCode!

non-null

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

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) at which the company address was created.

Anchor to firstNamefirstName

•String

The first name of the recipient.

Anchor to formattedAddressformattedAddress

non-null

The formatted version of the address.

Anchor to withNamewithName •Boolean Default:false: Whether to include the recipient's name 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 values for city, province, and country.

•ID!

non-null

A globally-unique ID.

Anchor to lastNamelastName

•String

The last name of the recipient.

•String

A unique phone number for the customer. Formatted using 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 e.g. 'Receiving Department'.

Anchor to updatedAtupdatedAt

Anchor to CompanyContact CompanyContact

non-null

The date and time (ISO 8601 format) at which 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.

•OBJECT

A person that acts on behalf of company associated to a customer.

Anchor to companycompany •Company! non-null: The company to which the contact belongs.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) at which the company contact was created at Shopify.
Anchor to customercustomer •Customer! non-null: The customer associated to this contact.
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-null: The list of draft orders for the company contact.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to isMainContactisMainContact •Boolean! non-null: Whether the contact is the main contact of the company.
Anchor to lifetimeDurationlifetimeDuration •String! non-null: The lifetime duration of the company contact, since its creation date on Shopify. Examples: 1 year, 2 months, 3 days.
Anchor to localelocale •String: The company contact's locale (language).
Anchor to ordersorders •OrderConnection! non-null: The list of orders for the company contact.
Anchor to roleAssignmentsroleAssignments •CompanyContactRoleAssignmentConnection! non-null: The list of roles assigned to this company contact.
Anchor to titletitle •String: The company contact's job title.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) at which the company contact was last updated.

Anchor to CompanyContactRole CompanyContactRole

•OBJECT

The role for a company contact.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of a role. For example, admin or buyer.
Anchor to notenote •String: A note for the role.

Anchor to CompanyContactRoleAssignment CompanyContactRoleAssignment

•OBJECT

The CompanyContactRoleAssignment describes the company and location associated to a company contact's role.

Anchor to companycompany •Company! non-null: The company this role assignment belongs to.
Anchor to companyContactcompanyContact •CompanyContact! non-null: The company contact for whom this role is assigned.
Anchor to companyLocationcompanyLocation •CompanyLocation! non-null: The company location to which the role is assigned.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the assignment record was created.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to rolerole •CompanyContactRole! non-null: The role that's assigned to the company contact.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the assignment record was last updated.

Anchor to CompanyLocation CompanyLocation

•OBJECT

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Anchor to billingAddressbillingAddress

•CompanyAddress

The address used as billing address for the location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

Anchor to catalogscatalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

Anchor to catalogsCountcatalogsCount

•Count

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

Anchor to companycompany

•Company!

non-null

The company that the company location belongs to.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) at which the company location was created in Shopify.

Anchor to currencycurrency

•CurrencyCode!

non-null

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company location.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant added a timeline comment to the company location.

•ID!

non-null

A globally-unique ID.

Anchor to inCataloginCatalog

non-null

Whether the company location is assigned a specific catalog.

Anchor to catalogIdcatalogId •ID! required: The ID of the catalog.

Anchor to localelocale

•String

The preferred locale of the company location.

Anchor to marketmarket

•Market!

non-null

The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

non-null

The name of the company location.

Anchor to notenote

•String

A note about the company location.

Anchor to ordersorders

•OrderConnection!

non-null

The list of orders for the company location.

Anchor to ordersCountordersCount

•Count

The total number of orders placed for the location.

•CompanyContactRoleAssignmentConnection!

•String

The phone number of the company location.

Anchor to roleAssignmentsroleAssignments

non-null

The list of roles assigned to the company location.

Anchor to shippingAddressshippingAddress

•CompanyAddress

The address used as shipping address for the location.

Anchor to staffMemberAssignmentsstaffMemberAssignments

•CompanyLocationStaffMemberAssignmentConnection!

non-null

The list of staff members assigned to the company location.

Anchor to totalSpenttotalSpent

•MoneyV2!

non-null

The total amount spent by the location.

Anchor to updatedAtupdatedAt

•MetafieldDefinitionConnection!

non-null

The date and time (ISO 8601 format) at which the company location was last modified.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Anchor to orderCountorderCount

•Int!

non-nullDeprecated

Anchor to privateMetafieldprivateMetafield

•PrivateMetafield

Deprecated

Anchor to privateMetafieldsprivateMetafields

•PrivateMetafieldConnection!

non-nullDeprecated

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-nullDeprecated

Anchor to taxRegistrationIdtaxRegistrationId

•String

Deprecated

Anchor to CompanyLocationCatalog CompanyLocationCatalog

•OBJECT

A list of products with publishing and pricing information associated with company locations.

Anchor to companyLocationscompanyLocations •CompanyLocationConnection! non-null: The company locations associated with the catalog.
Anchor to companyLocationsCountcompanyLocationsCount •Count: The number of company locations associated with the catalog.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to operationsoperations •[ResourceOperation!]! non-null: Most recent catalog operations.
Anchor to priceListpriceList •PriceList: The price list associated with the catalog.
Anchor to publicationpublication •Publication: A group of products and collections that's published to a catalog.
Anchor to statusstatus •CatalogStatus! non-null: The status of the catalog.
Anchor to titletitle •String! non-null: The name of the catalog.

Anchor to CompanyLocationStaffMemberAssignment CompanyLocationStaffMemberAssignment

•OBJECT

A representation of store's staff member who is assigned to a company location of the shop. The staff member's actions will be limited to objects associated with the assigned company location.

Anchor to companyLocationcompanyLocation •CompanyLocation! non-null: The company location the staff member is assigned to.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to staffMemberstaffMember •StaffMember! non-null: Represents the data of a staff member who's assigned to a company location.

Anchor to Customer Customer

•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 •[MailingAddress!]! non-null: A list of addresses associated with the customer.
Anchor to addressesV2addressesV2 •MailingAddressConnection! non-null: The addresses associated with the customer.
Anchor to amountSpentamountSpent •MoneyV2! non-null: The total amount that the customer has spent on orders in their lifetime.
Anchor to canDeletecanDelete •Boolean! 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 companyContactProfilescompanyContactProfiles •[CompanyContact!]! non-null: A list of the customer's company contact profiles.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the customer was added to the store.
Anchor to dataSaleOptOutdataSaleOptOut •Boolean! non-null: Whether the customer has opted out of having their data sold.
Anchor to defaultAddressdefaultAddress •MailingAddress: The default address associated with the customer.
Anchor to displayNamedisplayName •String! 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 •EventConnection! non-null: A list of events associated with the customer.
Anchor to firstNamefirstName •String: The customer's first name.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image! non-null: The image associated with the customer.
Anchor to lastNamelastName •String: The customer's last name.
Anchor to lastOrderlastOrder •Order: The customer's last order.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lifetimeDurationlifetimeDuration •String! 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 marketmarket •Market: The market that includes the customer’s default address.
Anchor to mergeablemergeable •CustomerMergeable! non-null: Whether the customer can be merged with another customer.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to multipassIdentifiermultipassIdentifier •String: A unique identifier for the customer that's used with Multipass login.
Anchor to notenote •String: A note about the customer.
Anchor to numberOfOrdersnumberOfOrders •UnsignedInt64! non-null: The number of orders that the customer has made at the store in their lifetime.
Anchor to ordersorders •OrderConnection! non-null: A list of the customer's orders.
Anchor to paymentMethodspaymentMethods •CustomerPaymentMethodConnection! non-null: A list of the customer's payment methods.
Anchor to productSubscriberStatusproductSubscriberStatus •CustomerProductSubscriberStatus! non-null: Possible subscriber states of a customer defined by their subscription contracts.
Anchor to statestate •CustomerState! 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 •CustomerStatistics! non-null: The statistics for a given customer.
Anchor to storeCreditAccountsstoreCreditAccounts •StoreCreditAccountConnection! 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 subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: A list of the customer's subscription contracts.
Anchor to tagstags •[String!]! non-null: A comma separated list of tags that have been added to the customer.
Anchor to taxExempttaxExempt •Boolean! non-null: Whether the customer is exempt from being charged taxes on their orders.
Anchor to taxExemptionstaxExemptions •[TaxExemption!]! non-null: The list of tax exemptions applied to the customer.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the customer was last updated.
Anchor to verifiedEmailverifiedEmail •Boolean! 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 •String Deprecated
Anchor to emailMarketingConsentemailMarketingConsent •CustomerEmailMarketingConsentState Deprecated
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to phonephone •String Deprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to smsMarketingConsentsmsMarketingConsent •CustomerSmsMarketingConsentState Deprecated
Anchor to unsubscribeUrlunsubscribeUrl •URL! non-nullDeprecated
Anchor to validEmailAddressvalidEmailAddress •Boolean! non-nullDeprecated

Anchor to CustomerAccountAppExtensionPage CustomerAccountAppExtensionPage

•OBJECT

An app extension page for the customer account navigation menu.

Anchor to appExtensionUuidappExtensionUuid •String: The UUID of the app extension.
Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to handlehandle •String! non-null: A unique, human-friendly string for the customer account page.
Anchor to idid •ID! non-null: The unique ID for the customer account page.
Anchor to titletitle •String! non-null: The title of the customer account page.

Anchor to CustomerAccountNativePage CustomerAccountNativePage

•OBJECT

A native page for the customer account navigation menu.

Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to handlehandle •String! non-null: A unique, human-friendly string for the customer account page.
Anchor to idid •ID! non-null: The unique ID for the customer account page.
Anchor to pageTypepageType •CustomerAccountNativePagePageType! non-null: The type of customer account native page.
Anchor to titletitle •String! non-null: The title of the customer account page.

Anchor to CustomerPaymentMethod CustomerPaymentMethod

•OBJECT

A customer's payment method.

Anchor to customercustomer •Customer: The customer to whom the payment method belongs.
Anchor to idid •ID! non-null: The ID of this payment method.
Anchor to instrumentinstrument •CustomerPaymentInstrument: The instrument for this payment method.
Anchor to revokedAtrevokedAt •DateTime: The time that the payment method was revoked.
Anchor to revokedReasonrevokedReason •CustomerPaymentMethodRevocationReason: The revocation reason for this payment method.
Anchor to subscriptionContractssubscriptionContracts •SubscriptionContractConnection! non-null: List Subscription Contracts.

Anchor to CustomerSegmentMembersQuery CustomerSegmentMembersQuery

•OBJECT

A job to determine a list of members, such as customers, that are associated with an individual segment.

Anchor to currentCountcurrentCount •Int! non-null: The current total number of members in a given segment.
Anchor to donedone •Boolean! non-null: This indicates if the job is still queued or has been run.
Anchor to idid •ID! non-null: A globally-unique ID that's returned when running an asynchronous mutation.

Anchor to CustomerVisit CustomerVisit

•OBJECT

Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to landingPagelandingPage •URL: URL of the first page the customer landed on for the session.
Anchor to landingPageHtmllandingPageHtml •HTML: Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.
Anchor to marketingEventmarketingEvent •MarketingEvent: Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts.
Anchor to occurredAtoccurredAt •DateTime! non-null: The date and time when the customer's session occurred.
Anchor to referralCodereferralCode •String: Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.
Anchor to referralInfoHtmlreferralInfoHtml •FormattedString! non-null: Referral information with URLs linked in HTML.
Anchor to referrerUrlreferrerUrl •URL: Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.
Anchor to sourcesource •String! non-null: Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.
Anchor to sourceDescriptionsourceDescription •String: Describes the source explicitly for first or last session.
Anchor to sourceTypesourceType •MarketingTactic: Type of marketing tactic.
Anchor to utmParametersutmParameters •UTMParameters: A set of UTM parameters gathered from the URL parameters of the referrer.

Anchor to DeliveryCarrierService DeliveryCarrierService

•OBJECT

A carrier service (also known as a carrier calculated service or shipping service) provides real-time shipping rates to Shopify. Some common carrier services include Canada Post, FedEx, UPS, and USPS. The term carrier is often used interchangeably with the terms shipping company and rate provider.

Using the CarrierService resource, you can add a carrier service to a shop and then provide a list of applicable shipping rates at checkout. You can even use the cart data to adjust shipping rates and offer shipping discounts based on what is in the customer's cart.

Requirements for accessing the CarrierService resource

To access the CarrierService resource, add the write_shipping permission to your app's requested scopes. For more information, see API access scopes.

Your app's request to create a carrier service will fail unless the store installing your carrier service meets one of the following requirements:

It's on the Advanced Shopify plan or higher.
It's on the Shopify plan with yearly billing, or the carrier service feature has been added to the store for a monthly fee. For more information, contact Shopify Support.
It's a development store.

Note

If a store changes its Shopify plan, then the store's association with a carrier service is deactivated if the store no long meets one of the requirements above.

Providing shipping rates to Shopify

When adding a carrier service to a store, you need to provide a POST endpoint rooted in the callbackUrl property where Shopify can retrieve applicable shipping rates. The callback URL should be a public endpoint that expects these requests from Shopify.

Example shipping rate request sent to a carrier service

{

"rate": {

"origin": {

"country": "CA",

"postal_code": "K2P1L4",

"province": "ON",

"city": "Ottawa",

"name": null,

"address1": "150 Elgin St.",

"address2": "",

"address3": null,

"phone": null,

"fax": null,

"email": null,

"address_type": null,

"company_name": "Jamie D's Emporium"

"destination": {

"country": "CA",

"postal_code": "K1M1M4",

"province": "ON",

"city": "Ottawa",

"name": "Bob Norman",

"address1": "24 Sussex Dr.",

"address2": "",

"address3": null,

"phone": null,

"fax": null,

"email": null,

"address_type": null,

"company_name": null

"items": [{

"name": "Short Sleeve T-Shirt",

"sku": "",

"quantity": 1,

"grams": 1000,

"price": 1999,

"vendor": "Jamie D's Emporium",

"requires_shipping": true,

"taxable": true,

"fulfillment_service": "manual",

"properties": null,

"product_id": 48447225880,

"variant_id": 258644705304

}],

"currency": "USD",

"locale": "en"

}

Example response

{

"rates": [

{

"service_name": "canadapost-overnight",

"service_code": "ON",

"total_price": "1295",

"description": "This is the fastest option by far",

"currency": "CAD",

"min_delivery_date": "2013-04-12 14:48:45 -0400",

"max_delivery_date": "2013-04-12 14:48:45 -0400"

{

"service_name": "fedex-2dayground",

"service_code": "2D",

"total_price": "2934",

"currency": "USD",

"min_delivery_date": "2013-04-12 14:48:45 -0400",

"max_delivery_date": "2013-04-12 14:48:45 -0400"

{

"service_name": "fedex-priorityovernight",

"service_code": "1D",

"total_price": "3587",

"currency": "USD",

"min_delivery_date": "2013-04-12 14:48:45 -0400",

"max_delivery_date": "2013-04-12 14:48:45 -0400"

}

]

}

The address3, fax, address_type, and company_name fields are returned by specific ActiveShipping providers. For API-created carrier services, you should use only the following shipping address fields:

address1
address2
city
zip
province
country

Other values remain as null and are not sent to the callback URL.

Response fields

When Shopify requests shipping rates using your callback URL, the response object rates must be a JSON array of objects with the following fields. Required fields must be included in the response for the carrier service integration to work properly.

Field	Required	Description
`service_name`	Yes	The name of the rate, which customers see at checkout. For example: `Expedited Mail`.
`description`	Yes	A description of the rate, which customers see at checkout. For example: `Includes tracking and insurance`.
`service_code`	Yes	A unique code associated with the rate. For example: `expedited_mail`.
`currency`	Yes	The currency of the shipping rate.
`total_price`	Yes	The total price expressed in subunits. If the currency doesn't use subunits, then the value must be multiplied by 100. For example: `"total_price": 500` for 5.00 CAD, `"total_price": 100000` for 1000 JPY.
`phone_required`	No	Whether the customer must provide a phone number at checkout.
`min_delivery_date`	No	The earliest delivery date for the displayed rate.
`max_delivery_date`	No	The latest delivery date for the displayed rate to still be valid.

Special conditions

To indicate that this carrier service cannot handle this shipping request, return an empty array and any successful (20x) HTTP code.
To force backup rates instead, return a 40x or 50x HTTP code with any content. A good choice is the regular 404 Not Found code.
Redirects (30x codes) will only be followed for the same domain as the original callback URL. Attempting to redirect to a different domain will trigger backup rates.
There is no retry mechanism. The response must be successful on the first try, within the time budget listed below. Timeouts or errors will trigger backup rates.

Response Timeouts

The read timeout for rate requests are dynamic, based on the number of requests per minute (RPM). These limits are applied to each shop-app pair. The timeout values are as follows.

RPM Range	Timeout
Under 1500	10s
1500 to 3000	5s
Over 3000	3s

Note

These values are upper limits and should not be interpretted as a goal to develop towards. Shopify is constantly evaluating the performance of the platform and working towards improving resilience as well as app capabilities. As such, these numbers may be adjusted outside of our normal versioning timelines.

Server-side caching of requests

Shopify provides server-side caching to reduce the number of requests it makes. Any shipping rate request that identically matches the following fields will be retrieved from Shopify's cache of the initial response:

variant IDs
default shipping box weight and dimensions
variant quantities
carrier service ID
origin address
destination address
item weights and signatures

If any of these fields differ, or if the cache has expired since the original request, then new shipping rates are requested. The cache expires 15 minutes after rates are successfully returned. If an error occurs, then the cache expires after 30 seconds.

Anchor to activeactive •Boolean! non-null: Whether the carrier service is active.
Anchor to availableServicesForCountriesavailableServicesForCountries •[DeliveryAvailableService!]! non-null: The list of services offered for given destinations.
Anchor to callbackUrlcallbackUrl •URL: The URL endpoint that Shopify needs to retrieve shipping rates.
Anchor to formattedNameformattedName •String: The properly formatted name of the shipping service provider, ready to display.
Anchor to iconicon •Image! non-null: The logo of the service provider.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String: The name of the shipping service provider.
Anchor to supportsServiceDiscoverysupportsServiceDiscovery •Boolean! non-null: Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples.

Anchor to DeliveryCondition DeliveryCondition

•OBJECT

A condition that must pass for a delivery method definition to be applied to an order.

Anchor to conditionCriteriaconditionCriteria •DeliveryConditionCriteria! non-null: The value (weight or price) that the condition field is compared to.
Anchor to fieldfield •DeliveryConditionField! non-null: The field to compare the criterion value against, using the operator.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to operatoroperator •DeliveryConditionOperator! non-null: The operator to compare the field and criterion value.

Anchor to DeliveryCountry DeliveryCountry

•OBJECT

A country that is used to define a shipping zone.

Anchor to codecode •DeliveryCountryCodeOrRestOfWorld! non-null: A two-letter country code in ISO 3166-1 alpha-2 standard. It also includes a flag indicating whether the country should be a part of the 'Rest Of World' shipping zone.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The full name of the country.
Anchor to provincesprovinces •[DeliveryProvince!]! non-null: The list of regions associated with this country.
Anchor to translatedNametranslatedName •String! non-null: The translated name of the country. The translation returned is based on the system's locale.

Anchor to DeliveryCustomization DeliveryCustomization

•OBJECT

A delivery customization.

Anchor to enabledenabled •Boolean! non-null: The enabled status of the delivery customization.
Anchor to errorHistoryerrorHistory •FunctionsErrorHistory: The error history on the most recent version of the delivery customization.
Anchor to functionIdfunctionId •String! non-null: The ID of the Shopify Function implementing the delivery customization.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to shopifyFunctionshopifyFunction •ShopifyFunction! non-null: The Shopify Function implementing the delivery customization.
Anchor to titletitle •String! non-null: The title of the delivery customization.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to DeliveryLocationGroup DeliveryLocationGroup

•OBJECT

A location group is a collection of locations. They share zones and delivery methods across delivery profiles.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to locationslocations •LocationConnection! non-null: A list of all locations that are part of this location group.
Anchor to locationsCountlocationsCount •Count: A count of all locations that are part of this location group.

Anchor to DeliveryMethod DeliveryMethod

•OBJECT

The delivery method used by a fulfillment order.

Anchor to additionalInformationadditionalInformation •DeliveryMethodAdditionalInformation: The Additional information to consider when performing the delivery.
Anchor to brandedPromisebrandedPromise •DeliveryBrandedPromise: The branded promise that was presented to the buyer during checkout. For example: Shop Promise.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to maxDeliveryDateTimemaxDeliveryDateTime •DateTime: The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
Anchor to methodTypemethodType •DeliveryMethodType! non-null: The type of the delivery method.
Anchor to minDeliveryDateTimeminDeliveryDateTime •DateTime: The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
Anchor to presentedNamepresentedName •String: The name of the delivery option that was presented to the buyer during checkout.
Anchor to serviceCodeserviceCode •String: A reference to the shipping method.
Anchor to sourceReferencesourceReference •String: Source reference is promise provider specific data associated with delivery promise.

Anchor to DeliveryMethodDefinition DeliveryMethodDefinition

•OBJECT

A method definition contains the delivery rate and the conditions that must be met for the method to be applied.

Anchor to activeactive •Boolean! non-null: Whether this method definition is active.
Anchor to descriptiondescription •String: The description of the method definition. Only available on shipping rates that are custom.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to methodConditionsmethodConditions •[DeliveryCondition!]! non-null: The method conditions that must pass for this method definition to be applied to an order.
Anchor to namename •String! non-null: The name of the method definition.
Anchor to rateProviderrateProvider •DeliveryRateProvider! non-null: The provided rate for this method definition, from a rate definition or participant.

Anchor to DeliveryParticipant DeliveryParticipant

•OBJECT

A participant defines carrier-calculated rates for shipping services with a possible merchant-defined fixed fee or a percentage-of-rate fee.

Anchor to adaptToNewServicesFlagadaptToNewServicesFlag •Boolean! non-null: Whether to display new shipping services automatically to the customer when the service becomes available.
Anchor to carrierServicecarrierService •DeliveryCarrierService! non-null: The carrier used for this participant.
Anchor to fixedFeefixedFee •MoneyV2: The merchant-defined fixed fee for this participant.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to participantServicesparticipantServices •[DeliveryParticipantService!]! non-null: The carrier-specific services offered by the participant, and whether each service is active.
Anchor to percentageOfRateFeepercentageOfRateFee •Float! non-null: The merchant-defined percentage-of-rate fee for this participant.

Anchor to DeliveryProfile DeliveryProfile

•OBJECT

A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. Learn more about building with delivery profiles.

Anchor to activeMethodDefinitionsCountactiveMethodDefinitionsCount •Int! non-null: The number of active shipping rates for the profile.
Anchor to defaultdefault •Boolean! non-null: Whether this is the default profile.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyModelegacyMode •Boolean! non-null: Whether this shop has enabled legacy compatibility mode for delivery profiles.
Anchor to locationsWithoutRatesCountlocationsWithoutRatesCount •Int! non-null: The number of locations without rates defined.
Anchor to namename •String! non-null: The name of the delivery profile.
Anchor to originLocationCountoriginLocationCount •Int! non-null: The number of active origin locations for the profile.
Anchor to productVariantsCountproductVariantsCount •Count: How many product variants are in this profile.
Anchor to profileItemsprofileItems •DeliveryProfileItemConnection! non-null: The products and variants associated with this profile.
Anchor to profileLocationGroupsprofileLocationGroups •[DeliveryProfileLocationGroup!]! non-null: The location groups and associated zones using this profile.
Anchor to sellingPlanGroupssellingPlanGroups •SellingPlanGroupConnection! non-null: Selling plan groups associated with the specified delivery profile.
Anchor to unassignedLocationsunassignedLocations •[Location!]! non-null: List of locations that haven't been assigned to a location group for this profile.
Anchor to unassignedLocationsPaginatedunassignedLocationsPaginated •LocationConnection! non-null: List of locations that have not been assigned to a location group for this profile.
Anchor to zoneCountryCountzoneCountryCount •Int! non-null: The number of countries with active rates to deliver to.
Anchor to productVariantsCountV2productVariantsCountV2 •DeliveryProductVariantsCount! non-nullDeprecated

Anchor to DeliveryProfileItem DeliveryProfileItem

•OBJECT

A product and the subset of associated variants that are part of this delivery profile.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to productproduct •Product! non-null: A product associated with this profile.
Anchor to variantsvariants •ProductVariantConnection! non-null: The product variants associated with this delivery profile.

Anchor to DeliveryPromiseProvider DeliveryPromiseProvider

•OBJECT

A delivery promise provider. Currently restricted to select approved delivery promise partners.

Anchor to activeactive •Boolean! non-null: Whether the delivery promise provider is active. Defaults to true when creating a provider.
Anchor to fulfillmentDelayfulfillmentDelay •Int: The number of seconds to add to the current time as a buffer when looking up delivery promises. Represents how long the shop requires before releasing an order to the fulfillment provider.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to locationlocation •Location! non-null: The location associated with this delivery promise provider.
Anchor to timeZonetimeZone •String! non-null: The time zone to be used for interpreting day of week and cutoff times in delivery schedules when looking up delivery promises.

Anchor to DeliveryProvince DeliveryProvince

•OBJECT

A region that is used to define a shipping zone.

Anchor to codecode •String! non-null: The code of the region.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The full name of the region.
Anchor to translatedNametranslatedName •String! non-null: The translated name of the region. The translation returned is based on the system's locale.

Anchor to DeliveryRateDefinition DeliveryRateDefinition

•OBJECT

The merchant-defined rate of the DeliveryMethodDefinition.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to priceprice •MoneyV2! non-null: The price of this rate.

Anchor to DeliveryZone DeliveryZone

•OBJECT

A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones.

Anchor to countriescountries •[DeliveryCountry!]! non-null: The list of countries within the zone.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the zone.

Anchor to DiscountAutomaticBxgy DiscountAutomaticBxgy

•OBJECT

The DiscountAutomaticBxgy object lets you manage buy X get Y discounts (BXGY) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.

The DiscountAutomaticBxgy object stores information about automatic BXGY discounts that apply to specific products and variants, collections, or all items in a cart.

Learn more about working with Shopify's discount model, including limitations and considerations.

Note

The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.

API versions prior to 2025-10 only return automatic discounts with context set to all, discounts with other values are filtered out.

Anchor to asyncUsageCountasyncUsageCount •Int! non-null: The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
Anchor to combinesWithcombinesWith •DiscountCombinesWith! non-null: The discount classes that you can use in combination with Shopify discount types.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the discount was created.
Anchor to customerBuyscustomerBuys •DiscountCustomerBuys! non-null: The items eligible for the discount and the required quantity of each to receive the discount.
Anchor to customerGetscustomerGets •DiscountCustomerGets! non-null: The items in the order that qualify for the discount, their quantities, and the total value of the discount.
Anchor to endsAtendsAt •DateTime: The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify null.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to startsAtstartsAt •DateTime! non-null: The date and time when the discount becomes active and is available to customers.
Anchor to statusstatus •DiscountStatus! non-null: The status of the discount that describes its availability, expiration, or pending activation.
Anchor to summarysummary •String! non-null: A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.
Anchor to titletitle •String! non-null: The discount's name that displays to merchants in the Shopify admin and to customers.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the discount was updated.
Anchor to usesPerOrderLimitusesPerOrderLimit •Int: The maximum number of times that the discount can be applied to an order.
Anchor to discountClassdiscountClass •MerchandiseDiscountClass! non-nullDeprecated
Anchor to idid •ID! non-nullDeprecated
Anchor to usageCountusageCount •Int! non-nullDeprecated

Anchor to DiscountAutomaticNode DiscountAutomaticNode

•OBJECT

The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

Anchor to automaticDiscountautomaticDiscount •DiscountAutomatic! non-null: A discount that's applied automatically when an order meets specific criteria. Learn more about automatic discounts.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to DiscountCodeNode DiscountCodeNode

•OBJECT

The DiscountCodeNode object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

Anchor to codeDiscountcodeDiscount •DiscountCode! non-null: The underlying code discount object.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to DiscountNode DiscountNode

•OBJECT

The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to orders, products, or shipping, and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store.

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.

Anchor to discountdiscount •Discount! non-null: A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to DiscountRedeemCodeBulkCreation DiscountRedeemCodeBulkCreation

•OBJECT

The properties and status of a bulk discount redeem code creation operation.

Anchor to codescodes •DiscountRedeemCodeBulkCreationCodeConnection! non-null: The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation.
Anchor to codesCountcodesCount •Int! non-null: The number of codes to create.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the bulk creation was created.
Anchor to discountCodediscountCode •DiscountCodeNode: The code discount associated with the created codes.
Anchor to donedone •Boolean! non-null: Whether the bulk creation is still queued (false) or has been run (true).
Anchor to failedCountfailedCount •Int! non-null: The number of codes that weren't created successfully.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to importedCountimportedCount •Int! non-null: The number of codes created successfully.

Anchor to Domain Domain

•OBJECT

A unique string that represents 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-null: A globally-unique ID.
Anchor to localizationlocalization •DomainLocalization: The localization of the domain, if the domain doesn't redirect.
Anchor to marketWebPresencemarketWebPresence •MarketWebPresence: The web presence of the domain.
Anchor to sslEnabledsslEnabled •Boolean! non-null: Whether SSL is enabled.
Anchor to urlurl •URL! non-null: The URL of the domain (for example, https://example.com).

Anchor to DraftOrder DraftOrder

•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 presentment_money is the source of truth for what a customer is going to be charged and shop_money 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 acceptAutomaticDiscountsacceptAutomaticDiscounts •Boolean: Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see appliedDiscount) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.
Anchor to allowDiscountCodesInCheckoutallowDiscountCodesInCheckout •Boolean! non-null: Whether discount codes are allowed during checkout of this draft order.
Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom order-level discount applied.
Anchor to billingAddressbillingAddress •MailingAddress: The billing address of the customer.
Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress •Boolean! non-null: Whether the billing address matches the shipping address.
Anchor to completedAtcompletedAt •DateTime: The date and time when the draft order was converted to a new order, and had it's status changed to Completed.
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 shop currency used for calculation.
Anchor to customAttributescustomAttributes •[Attribute!]! 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 defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to discountCodesdiscountCodes •[String!]! 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 •EventConnection! non-null: The list of events associated with the draft order.
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether the merchant has added timeline comments to the draft order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to invoiceEmailTemplateSubjectinvoiceEmailTemplateSubject •String! non-null: The subject defined for the draft invoice email template.
Anchor to invoiceSentAtinvoiceSentAt •DateTime: The date and time when the invoice was last emailed to the customer.
Anchor to invoiceUrlinvoiceUrl •URL: The link to the checkout, which is sent to the customer in the invoice email.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lineItemslineItems •DraftOrderLineItemConnection! non-null: The list of the line items in the draft order.
Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice •MoneyBag! non-null: A subtotal of the line items and corresponding discounts, excluding shipping charges, shipping discounts, taxes, or order discounts.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
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 paymentTermspaymentTerms •PaymentTerms: The associated payment terms for this draft order.
Anchor to phonephone •String: The assigned phone number.
Anchor to platformDiscountsplatformDiscounts •[DraftOrderPlatformDiscount!]! non-null: The list of platform discounts applied.
Anchor to poNumberpoNumber •String: The purchase order number.
Anchor to presentmentCurrencyCodepresentmentCurrencyCode •CurrencyCode! non-null: The payment currency used for calculation.
Anchor to purchasingEntitypurchasingEntity •PurchasingEntity: 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 reserveInventoryUntilreserveInventoryUntil •DateTime: The time after which inventory will automatically be restocked.
Anchor to shippingAddressshippingAddress •MailingAddress: The shipping address of the customer.
Anchor to shippingLineshippingLine •ShippingLine: The line item containing the shipping information and costs.
Anchor to statusstatus •DraftOrderStatus! non-null: The status of the draft order.
Anchor to subtotalPriceSetsubtotalPriceSet •MoneyBag! non-null: The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
Anchor to tagstags •[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 taxesIncludedtaxesIncluded •Boolean! non-null: Whether the line item prices include taxes.
Anchor to taxExempttaxExempt •Boolean! non-null: Whether the draft order is tax exempt.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: The list of of taxes lines charged for each line item and shipping line.
Anchor to totalDiscountsSettotalDiscountsSet •MoneyBag! non-null: Total discounts.
Anchor to totalLineItemsPriceSettotalLineItemsPriceSet •MoneyBag! non-null: Total price of line items, excluding discounts.
Anchor to totalPriceSettotalPriceSet •MoneyBag! non-null: The total price, includes taxes, shipping charges, and discounts.
Anchor to totalQuantityOfLineItemstotalQuantityOfLineItems •Int! 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 totalShippingPriceSettotalShippingPriceSet •MoneyBag! non-null: The total shipping price.
Anchor to totalTaxSettotalTaxSet •MoneyBag! non-null: The total tax.
Anchor to totalWeighttotalWeight •UnsignedInt64! non-null: The total weight in grams of the draft order.
Anchor to transformerFingerprinttransformerFingerprint •String: 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 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 visibleToCustomervisibleToCustomer •Boolean! non-null: Whether the draft order will be visible to the customer on the self-serve portal.
Anchor to warningswarnings •[DraftOrderWarning!]! non-null: The list of warnings raised while calculating.
Anchor to localizationExtensionslocalizationExtensions •LocalizationExtensionConnection! non-nullDeprecated
Anchor to marketNamemarketName •String! non-nullDeprecated
Anchor to marketRegionCountryCodemarketRegionCountryCode •CountryCode! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to subtotalPricesubtotalPrice •Money! non-nullDeprecated
Anchor to totalPricetotalPrice •Money! non-nullDeprecated
Anchor to totalShippingPricetotalShippingPrice •Money! non-nullDeprecated
Anchor to totalTaxtotalTax •Money! non-nullDeprecated

Anchor to DraftOrderLineItem DraftOrderLineItem

•OBJECT

The line item for a draft order.

Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom applied discount.
Anchor to approximateDiscountedUnitPriceSetapproximateDiscountedUnitPriceSet •MoneyBag! non-null: The discountedTotal divided by quantity, equal to the average value of the line item price per unit after discounts are applied. This value doesn't include discounts applied to the entire draft order.
Anchor to bundleComponentsbundleComponents •[DraftOrderLineItem!]! non-null: The list of bundle components if applicable.
Anchor to customcustom •Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to customAttributesV2customAttributesV2 •[TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total price with discounts applied.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: Name of the service provider who fulfilled the order.

Valid values are either manual or the name of the provider. For example, amazon, shipwire.

Deleted fulfillment services will return null.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image of the product variant.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to namename •String! non-null: The name of the product.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: The price without any discounts applied.
Anchor to originalUnitPriceWithCurrencyoriginalUnitPriceWithCurrency •MoneyV2: The original custom line item input price.
Anchor to productproduct •Product: The product for the line item.
Anchor to quantityquantity •Int! non-null: The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to skusku •String: The SKU number of the product variant.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: A list of tax lines.
Anchor to titletitle •String! non-null: The title of the product or variant. This field only applies to custom line items.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total discount amount.
Anchor to uuiduuid •String! non-null: The UUID of the draft order line item. Must be unique and consistent across requests. This field is mandatory in order to manipulate drafts with bundles.
Anchor to variantvariant •ProductVariant: The product variant for the line item.
Anchor to variantTitlevariantTitle •String: The name of the variant.
Anchor to vendorvendor •String: The name of the vendor who created the product variant.
Anchor to weightweight •Weight: The weight unit and value.
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •Money! non-nullDeprecated
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-nullDeprecated
Anchor to gramsgrams •Int Deprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated
Anchor to originalUnitPriceoriginalUnitPrice •Money! non-nullDeprecated
Anchor to totalDiscounttotalDiscount •Money! non-nullDeprecated

Anchor to DraftOrderTag DraftOrderTag

•OBJECT

Represents a draft order tag.

Anchor to handlehandle •String! non-null: Handle of draft order tag.
Anchor to idid •ID! non-null: ID of draft order tag.
Anchor to titletitle •String! non-null: Title of draft order tag.

Anchor to Duty Duty

•OBJECT

The duty details for a line item.

Anchor to countryCodeOfOrigincountryCodeOfOrigin •CountryCode: The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
Anchor to harmonizedSystemCodeharmonizedSystemCode •String: The harmonized system code of the item used in calculating the duty.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to priceprice •MoneyBag! non-null: The amount of the duty.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: A list of taxes charged on the duty.

Anchor to ExchangeLineItem ExchangeLineItem

•OBJECT

An item for exchange.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lineItemlineItem •LineItem Deprecated

Anchor to ExternalVideo ExternalVideo

•OBJECT

Represents a video hosted outside of Shopify.

Anchor to altalt •String: A word or phrase to describe the contents or the function of a file.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to embedUrlembedUrl •URL! non-null: The embed URL of the video for the respective host.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
Anchor to hosthost •MediaHost! non-null: The host of the external video.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to mediaContentTypemediaContentType •MediaContentType! non-null: The media content type.
Anchor to mediaErrorsmediaErrors •[MediaError!]! non-null: Any errors which have occurred on the media.
Anchor to mediaWarningsmediaWarnings •[MediaWarning!]! non-null: The warnings attached to the media.
Anchor to originUrloriginUrl •URL! non-null: The origin URL of the video on the respective host.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to statusstatus •MediaStatus! non-null: Current status of the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.
Anchor to embeddedUrlembeddedUrl •URL! non-nullDeprecated

Anchor to Fulfillment Fulfillment

•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 createdAtcreatedAt •DateTime! non-null: The date and time when the fulfillment was created.
Anchor to deliveredAtdeliveredAt •DateTime: The date that this fulfillment was delivered.
Anchor to displayStatusdisplayStatus •FulfillmentDisplayStatus: Human readable display status for this fulfillment.
Anchor to estimatedDeliveryAtestimatedDeliveryAt •DateTime: The estimated date that this fulfillment will arrive.
Anchor to eventsevents •FulfillmentEventConnection! non-null: The history of events associated with this fulfillment.
Anchor to fulfillmentLineItemsfulfillmentLineItems •FulfillmentLineItemConnection! non-null: List of the fulfillment's line items.
Anchor to fulfillmentOrdersfulfillmentOrders •FulfillmentOrderConnection! non-null: A paginated list of fulfillment orders for the fulfillment.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inTransitAtinTransitAt •DateTime: The date and time when the fulfillment went into transit.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! 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 originAddressoriginAddress •FulfillmentOriginAddress: 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 assignedLocation field on the FulfillmentOrder object instead.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether any of the line items in the fulfillment require shipping.
Anchor to serviceservice •FulfillmentService: Fulfillment service associated with the fulfillment.
Anchor to statusstatus •FulfillmentStatus! non-null: The status of the fulfillment.
Anchor to totalQuantitytotalQuantity •Int! non-null: Sum of all line item quantities for the fulfillment.
Anchor to trackingInfotrackingInfo •[FulfillmentTrackingInfo!]! non-null: Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the fulfillment was last modified.

Anchor to FulfillmentConstraintRule FulfillmentConstraintRule

•OBJECT

A fulfillment constraint rule.

Anchor to deliveryMethodTypesdeliveryMethodTypes •[DeliveryMethodType!]! non-null: Delivery method types that the function is associated with.
Anchor to functionfunction •ShopifyFunction! non-null: The ID for the fulfillment constraint function.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to FulfillmentEvent FulfillmentEvent

•OBJECT

The fulfillment event that describes the fulfilllment status at a particular time.

Anchor to address1address1 •String: The street address where this fulfillment event occurred.
Anchor to citycity •String: The city where this fulfillment event occurred.
Anchor to countrycountry •String: The country where this fulfillment event occurred.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the fulfillment event was created.
Anchor to estimatedDeliveryAtestimatedDeliveryAt •DateTime: The estimated delivery date and time of the fulfillment.
Anchor to happenedAthappenedAt •DateTime! non-null: The time at which this fulfillment event happened.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to latitudelatitude •Float: The latitude where this fulfillment event occurred.
Anchor to longitudelongitude •Float: The longitude where this fulfillment event occurred.
Anchor to messagemessage •String: A message associated with this fulfillment event.
Anchor to provinceprovince •String: The province where this fulfillment event occurred.
Anchor to statusstatus •FulfillmentEventStatus! non-null: The status of this fulfillment event.
Anchor to zipzip •String: The zip code of the location where this fulfillment event occurred.

Anchor to FulfillmentHold FulfillmentHold

•OBJECT

A fulfillment hold currently applied on a fulfillment order.

Anchor to displayReasondisplayReason •String! non-null: The localized reason for the fulfillment hold for display purposes.
Anchor to heldByRequestingAppheldByRequestingApp •Boolean! non-null: A boolean value that indicates whether the requesting app created the fulfillment hold.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to reasonreason •FulfillmentHoldReason! non-null: The reason for the fulfillment hold.
Anchor to reasonNotesreasonNotes •String: Additional information about the fulfillment hold reason.
Anchor to heldByheldBy •String Deprecated

Anchor to FulfillmentLineItem FulfillmentLineItem

•OBJECT

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

Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total price after discounts are applied in shop and presentment currencies. This value doesn't include order-level discounts.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lineItemlineItem •LineItem! non-null: The associated order's line item.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price before discounts are applied in shop and presentment currencies.
Anchor to quantityquantity •Int: Number of line items in the fulfillment.
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated

Anchor to FulfillmentOrder FulfillmentOrder

•OBJECT

The FulfillmentOrder object represents either an item or a group of items in an Order that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.

Fulfillment orders represent the work which is intended to be done in relation to an order. When fulfillment has started for one or more line items, a Fulfillment is created by a merchant or third party to represent the ongoing or completed work of fulfillment.

See below for more details on creating fulfillments.

Note

Shopify creates fulfillment orders automatically when an order is created. It is not possible to manually create fulfillment orders.

See below for more details on the lifecycle of a fulfillment order.

Retrieving fulfillment orders

Fulfillment orders from an order

All fulfillment orders related to a given order can be retrieved with the Order.fulfillmentOrders connection.

API access scopes govern which fulfillments orders are returned to clients. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders.

Fulfillment orders assigned to the app for fulfillment

Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the assignedFulfillmentOrders connection. Use the assignmentStatus argument to control whether all assigned fulfillment orders should be returned or only those where a merchant has sent a fulfillment request and it has yet to be responded to.

The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.

All fulfillment orders

Apps can retrieve all fulfillment orders with the fulfillmentOrders query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, which are accessible to the app according to the fulfillment order access scopes it was granted with.

The lifecycle of a fulfillment order

Fulfillment Order Creation

After an order is created, a background worker performs the order routing process which determines which locations will be responsible for fulfilling the purchased items. Once the order routing process is complete, one or more fulfillment orders will be created and assigned to these locations. It is not possible to manually create fulfillment orders.

Once a fulfillment order has been created, it will have one of two different lifecycles depending on the type of location which the fulfillment order is assigned to.

The lifecycle of a fulfillment order at a merchant managed location

Fulfillment orders are completed by creating fulfillments. Fulfillments represents the work done.

For digital products a merchant or an order management app would create a fulfilment once the digital asset has been provisioned. For example, in the case of a digital gift card, a merchant would to do this once the gift card has been activated - before the email has been shipped.

On the other hand, for a traditional shipped order, a merchant or an order management app would create a fulfillment after picking and packing the items relating to a fulfillment order, but before the courier has collected the goods.

Learn about managing fulfillment orders as an order management app.

The lifecycle of a fulfillment order at a location which is managed by a fulfillment service

For fulfillment orders which are assigned to a location that is managed by a fulfillment service, a merchant or an Order Management App can send a fulfillment request to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to accept or reject this fulfillment request.

Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant or order management app and instead a cancellation request must be submitted to the fulfillment service.

Once a fulfillment service accepts a fulfillment request, then after they are ready to pack items and send them for delivery, they create fulfillments with the fulfillmentCreate mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the fulfillmentTrackingInfoUpdate mutation.

Learn about managing fulfillment orders as a fulfillment service.

API access scopes

Fulfillment orders are governed by the following API access scopes:

The read_merchant_managed_fulfillment_orders and write_merchant_managed_fulfillment_orders access scopes grant access to fulfillment orders assigned to merchant-managed locations.
The read_assigned_fulfillment_orders and write_assigned_fulfillment_orders access scopes are intended for fulfillment services. These scopes grant access to fulfillment orders assigned to locations that are being managed by fulfillment services.
The read_third_party_fulfillment_orders and write_third_party_fulfillment_orders access scopes grant access to fulfillment orders assigned to locations managed by other fulfillment services.

Fulfillment service app access scopes

Usually, fulfillment services have the write_assigned_fulfillment_orders access scope and don't have the *_third_party_fulfillment_orders or *_merchant_managed_fulfillment_orders access scopes. The app will only have access to the fulfillment orders assigned to their location (or multiple locations if the app registers multiple fulfillment services on the shop). The app will not have access to fulfillment orders assigned to merchant-managed locations or locations owned by other fulfillment service apps.

Order management app access scopes

Order management apps will usually request write_merchant_managed_fulfillment_orders and write_third_party_fulfillment_orders access scopes. This will allow them to manage all fulfillment orders on behalf of a merchant.

If an app combines the functions of an order management app and a fulfillment service, then the app should request all access scopes to manage all assigned and all unassigned fulfillment orders.

Notifications about fulfillment orders

Fulfillment services are required to register a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified whenever a merchant submits a fulfillment or cancellation request.

Both merchants and apps can subscribe to the fulfillment order webhooks to be notified whenever fulfillment order related domain events occur.

Learn about fulfillment workflows.

Anchor to assignedLocationassignedLocation •FulfillmentOrderAssignedLocation! non-null: The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.

The fulfillment order's assigned location might change in the following cases:

The fulfillment order has been entirely moved to a new location. For example, the fulfillmentOrderMove mutation has been called, and you see the original fulfillment order in the movedFulfillmentOrder field within the mutation's response.

Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the OPEN, SCHEDULED, or ON_HOLD status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).
Anchor to channelIdchannelId •ID: ID of the channel that created the order.
Anchor to createdAtcreatedAt •DateTime! non-null: Date and time when the fulfillment order was created.
Anchor to deliveryMethoddeliveryMethod •DeliveryMethod: Delivery method of this fulfillment order.
Anchor to destinationdestination •FulfillmentOrderDestination: The destination where the items should be sent.
Anchor to fulfillAtfulfillAt •DateTime: The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the fulfill_at date for a subscription order might be the 1st of each month, a pre-order fulfill_at date would be nil, and a standard order fulfill_at date would be the order creation date.
Anchor to fulfillByfulfillBy •DateTime: The latest date and time by which all items in the fulfillment order need to be fulfilled.
Anchor to fulfillmentHoldsfulfillmentHolds •[FulfillmentHold!]! non-null: The fulfillment holds applied on the fulfillment order.
Anchor to fulfillmentOrdersForMergefulfillmentOrdersForMerge •FulfillmentOrderConnection! non-null: Fulfillment orders eligible for merging with the given fulfillment order.
Anchor to fulfillmentsfulfillments •FulfillmentConnection! non-null: A list of fulfillments for the fulfillment order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to internationalDutiesinternationalDuties •FulfillmentOrderInternationalDuties: The duties delivery method of this fulfillment order.
Anchor to lineItemslineItems •FulfillmentOrderLineItemConnection! non-null: A list of the fulfillment order's line items.
Anchor to locationsForMovelocationsForMove •FulfillmentOrderLocationForMoveConnection! non-null: A list of locations that the fulfillment order can potentially move to.
Anchor to merchantRequestsmerchantRequests •FulfillmentOrderMerchantRequestConnection! non-null: A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order.
Anchor to orderorder •Order! non-null: The order that's associated with the fulfillment order.
Anchor to orderIdorderId •ID! non-null: ID of the order that's associated with the fulfillment order.
Anchor to orderNameorderName •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.
Anchor to orderProcessedAtorderProcessedAt •DateTime! non-null: The date and time when the order was processed. This date and time might not match the date and time when the order was created.
Anchor to requestStatusrequestStatus •FulfillmentOrderRequestStatus! non-null: The request status of the fulfillment order.
Anchor to statusstatus •FulfillmentOrderStatus! non-null: The status of the fulfillment order.
Anchor to supportedActionssupportedActions •[FulfillmentOrderSupportedAction!]! non-null: The actions that can be performed on this fulfillment order.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the fulfillment order was last updated.

Anchor to FulfillmentOrderDestination FulfillmentOrderDestination

•OBJECT

Represents the destination where the items should be sent upon fulfillment.

Anchor to address1address1 •String: The first line of the address of the destination.
Anchor to address2address2 •String: The second line of the address of the destination.
Anchor to citycity •String: The city of the destination.
Anchor to companycompany •String: The company of the destination.
Anchor to countryCodecountryCode •CountryCode: The two-letter country code of the destination.
Anchor to emailemail •String: The email of the customer at the destination.
Anchor to firstNamefirstName •String: The first name of the customer at the destination.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lastNamelastName •String: The last name of the customer at the destination.
Anchor to locationlocation •Location: The location designated for the pick-up of the fulfillment order.
Anchor to phonephone •String: The phone number of the customer at the destination.
Anchor to provinceprovince •String: The province of the destination.
Anchor to zipzip •String: The ZIP code of the destination.

Anchor to FulfillmentOrderLineItem FulfillmentOrderLineItem

•OBJECT

Associates an order line item with quantities requiring fulfillment from the respective fulfillment order.

Anchor to financialSummariesfinancialSummaries •[FulfillmentOrderLineItemFinancialSummary!]! non-null: The financial summary for the Fulfillment Order's Line Items.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image associated to the line item's variant.
Anchor to inventoryItemIdinventoryItemId •ID: The ID of the inventory item.
Anchor to lineItemlineItem •LineItem! non-null: The associated order line item.
Anchor to productTitleproductTitle •String! non-null: The title of the product.
Anchor to remainingQuantityremainingQuantity •Int! non-null: The number of units remaining to be fulfilled.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to skusku •String: The variant SKU number.
Anchor to totalQuantitytotalQuantity •Int! non-null: The total number of units to be fulfilled.
Anchor to variantvariant •ProductVariant: The product variant associated to the fulfillment order line item.
Anchor to variantTitlevariantTitle •String: The name of the variant.
Anchor to vendorvendor •String: The name of the vendor who made the variant.
Anchor to warningswarnings •[FulfillmentOrderLineItemWarning!]! non-null: Warning messages for a fulfillment order line item.
Anchor to weightweight •Weight: The weight of a line item unit.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-nullDeprecated

Anchor to FulfillmentOrderMerchantRequest FulfillmentOrderMerchantRequest

•OBJECT

A request made by the merchant or an order management app to a fulfillment service for a fulfillment order.

Anchor to fulfillmentOrderfulfillmentOrder •FulfillmentOrder! non-null: The fulfillment order associated with the merchant request.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to kindkind •FulfillmentOrderMerchantRequestKind! non-null: The kind of request made.
Anchor to messagemessage •String: The optional message that the merchant included in the request.
Anchor to requestOptionsrequestOptions •JSON: Additional options requested by the merchant. These depend on the kind of the request. For example, for a FULFILLMENT_REQUEST, one option is notify_customer, which indicates whether the merchant intends to notify the customer upon fulfillment. The fulfillment service can then set notifyCustomer when making calls to FulfillmentCreate.
Anchor to responseDataresponseData •JSON: The response from the fulfillment service.
Anchor to sentAtsentAt •DateTime! non-null: The timestamp when the request was made.

Anchor to GenericFile GenericFile

•OBJECT

Represents any file other than HTML.

Anchor to altalt •String: A word or phrase to describe the contents or the function of a file.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to mimeTypemimeType •String: The generic file's MIME type.
Anchor to originalFileSizeoriginalFileSize •Int: The generic file's size in bytes.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.
Anchor to urlurl •URL: The generic file's URL.

Anchor to GiftCard GiftCard

•OBJECT

Represents an issued gift card.

Anchor to balancebalance •MoneyV2! non-null: The gift card's remaining balance.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time at which the gift card was created.
Anchor to customercustomer •Customer: The customer who will receive the gift card.
Anchor to deactivatedAtdeactivatedAt •DateTime: The date and time at which the gift card was deactivated.
Anchor to enabledenabled •Boolean! non-null: Whether the gift card is enabled.
Anchor to expiresOnexpiresOn •Date: The date at which the gift card will expire.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to initialValueinitialValue •MoneyV2! non-null: The initial value of the gift card.
Anchor to lastCharacterslastCharacters •String! non-null: The final four characters of the gift card code.
Anchor to maskedCodemaskedCode •String! non-null: The gift card code. Everything but the final four characters is masked.
Anchor to notenote •String: The note associated with the gift card, which isn't visible to the customer.
Anchor to orderorder •Order: The order associated with the gift card. This value is null if the gift card was issued manually.
Anchor to recipientAttributesrecipientAttributes •GiftCardRecipient: The recipient who will receive the gift card.
Anchor to templateSuffixtemplateSuffix •String: The theme template used to render the gift card online.
Anchor to transactionstransactions •GiftCardTransactionConnection: The transaction history of the gift card.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time at which the gift card was updated.

Anchor to GiftCardCreditTransaction GiftCardCreditTransaction

•OBJECT

A credit transaction which increases the gift card balance.

Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to giftCardgiftCard •GiftCard! non-null: The gift card that the transaction belongs to.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to notenote •String: A note about the transaction.
Anchor to processedAtprocessedAt •DateTime! non-null: The date and time when the transaction was processed.
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to GiftCardDebitTransaction GiftCardDebitTransaction

•OBJECT

A debit transaction which decreases the gift card balance.

Anchor to amountamount •MoneyV2! non-null: The amount of the transaction.
Anchor to giftCardgiftCard •GiftCard! non-null: The gift card that the transaction belongs to.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to notenote •String: A note about the transaction.
Anchor to processedAtprocessedAt •DateTime! non-null: The date and time when the transaction was processed.
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to InventoryAdjustmentGroup InventoryAdjustmentGroup

•OBJECT

Represents a group of adjustments made as part of the same operation.

Anchor to appapp •App: The app that triggered the inventory event, if one exists.
Anchor to changeschanges •[InventoryChange!]! non-null: The set of inventory quantity changes that occurred in the inventory event.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time the inventory adjustment group was created.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to reasonreason •String! non-null: The reason for the group of adjustments.
Anchor to referenceDocumentUrireferenceDocumentUri •String: A freeform URI that represents why the inventory change happened. This can be the entity adjusting inventory quantities or the Shopify resource that's associated with the inventory adjustment. For example, a unit in a draft order might have been previously reserved, and a merchant later creates an order from the draft order. In this case, the referenceDocumentUri for the inventory adjustment is a URI referencing the order ID.
Anchor to staffMemberstaffMember •StaffMember: The staff member associated with the inventory event.

Anchor to InventoryItem InventoryItem

•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 countryCodeOfOrigincountryCodeOfOrigin •CountryCode: The ISO 3166-1 alpha-2 country code of where the item originated from.
Anchor to countryHarmonizedSystemCodescountryHarmonizedSystemCodes •CountryHarmonizedSystemCodeConnection! non-null: A list of country specific harmonized system codes.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the inventory item was created.
Anchor to duplicateSkuCountduplicateSkuCount •Int! non-null: The number of inventory items that share the same SKU with this item.
Anchor to harmonizedSystemCodeharmonizedSystemCode •String: The harmonized system code of the item. This must be a number between 6 and 13 digits.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inventoryHistoryUrlinventoryHistoryUrl •URL: The URL that points to the inventory history for the item.
Anchor to inventoryLevelinventoryLevel •InventoryLevel: The inventory item's quantities at the specified location.
Anchor to inventoryLevelsinventoryLevels •InventoryLevelConnection! non-null: A list of the inventory item's quantities for each location that the inventory item can be stocked at.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to locationsCountlocationsCount •Count: The number of locations where this inventory item is stocked.
Anchor to measurementmeasurement •InventoryItemMeasurement! non-null: The packaging dimensions of the inventory item.
Anchor to provinceCodeOfOriginprovinceCodeOfOrigin •String: The ISO 3166-2 alpha-2 province code of where the item originated from.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether the inventory item requires shipping.
Anchor to skusku •String: Inventory item SKU. Case-sensitive string.
Anchor to trackedtracked •Boolean! non-null: Whether inventory levels are tracked for the item.
Anchor to trackedEditabletrackedEditable •EditableProperty! non-null: Whether the value of the tracked field for the inventory item can be changed.
Anchor to unitCostunitCost •MoneyV2: 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 updatedAtupdatedAt •DateTime! non-null: The date and time when the inventory item was updated.
Anchor to variantvariant •ProductVariant! non-null: The variant that owns this inventory item.

Anchor to InventoryItemMeasurement InventoryItemMeasurement

•OBJECT

Represents the packaged dimension for an inventory item.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to weightweight •Weight: The weight of the inventory item.

Anchor to InventoryLevel InventoryLevel

•OBJECT

The quantities of an inventory item that are related to a specific location. Learn more about the relationships between inventory objects.

Anchor to canDeactivatecanDeactivate •Boolean! non-null: Whether the inventory items associated with the inventory level can be deactivated.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the inventory level was created.
Anchor to deactivationAlertdeactivationAlert •String: Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to itemitem •InventoryItem! non-null: Inventory item associated with the inventory level.
Anchor to locationlocation •Location! non-null: The location associated with the inventory level.
Anchor to quantitiesquantities •[InventoryQuantity!]! non-null: The quantity of an inventory item at a specific location, for a quantity name.
Anchor to scheduledChangesscheduledChanges •InventoryScheduledChangeConnection! non-null: Scheduled changes for the requested quantity names.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the inventory level was updated.

Anchor to InventoryQuantity InventoryQuantity

•OBJECT

The InventoryQuantity object lets you manage and track inventory quantities for specific states. Inventory quantities represent different states of items such as available for purchase, committed to orders, reserved for drafts, incoming from suppliers, or set aside for quality control or safety stock.

You can use inventory levels to manage where inventory items are stocked. You can also make inventory adjustments to apply changes to inventory quantities.

Inventory quantities can be managed by a merchant or by fulfillment services that handle inventory tracking. Learn more about working with Shopify's inventory management system.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The inventory state name that identifies the inventory quantity.
Anchor to quantityquantity •Int! non-null: The quantity of an inventory item at a specific location, for a quantity name.
Anchor to updatedAtupdatedAt •DateTime: When the inventory quantity was last updated.

Anchor to LineItem LineItem

•OBJECT

The LineItem object represents a single product or service that a customer purchased in an order. Each line item is associated with a product variant and can have multiple discount allocations. Line items contain details about what was purchased, including the product variant, quantity, pricing, and fulfillment status.

Use the LineItem object to manage the following processes:

Track the quantity of items ordered, fulfilled, and unfulfilled.
Calculate prices, including discounts and taxes.
Manage fulfillment through fulfillment services.
Manage returns and exchanges.
Handle subscriptions and recurring orders.

Line items can also include custom attributes and properties, allowing merchants to add specific details about each item in an order. Learn more about managing orders and fulfillment.

Anchor to contractcontract •SubscriptionContract: The subscription contract associated with this line item.
Anchor to currentQuantitycurrentQuantity •Int! non-null: The number of units ordered, excluding refunded and removed units.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to discountAllocationsdiscountAllocations •[DiscountAllocation!]! non-null: The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total discounted price of the line item in shop and presentment currencies, including refunded and removed quantities. This value doesn't include order-level discounts. Code-based discounts aren't included by default.
Anchor to discountedUnitPriceAfterAllDiscountsSetdiscountedUnitPriceAfterAllDiscountsSet •MoneyBag! non-null: The approximate unit price of the line item in shop and presentment currencies. This value includes discounts applied to refunded and removed quantities.
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-null: The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts.
Anchor to dutiesduties •[Duty!]! non-null: The duties associated with the line item.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image associated to the line item's variant.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to lineItemGrouplineItemGroup •LineItemGroup: The line item group associated to the line item.
Anchor to merchantEditablemerchantEditable •Boolean! non-null: Whether the line item can be edited or not.
Anchor to namename •String! non-null: The title of the product, optionally appended with the title of the variant (if applicable).
Anchor to nonFulfillableQuantitynonFulfillableQuantity •Int! non-null: The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the FulfillmentOrder object for more fulfillment details.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total price of the line item when the order was created. This value doesn't include discounts.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.
Anchor to productproduct •Product: The Product object associated with this line item's variant.
Anchor to quantityquantity •Int! non-null: The number of units ordered, including refunded and removed units.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The number of units ordered, excluding refunded units and removed units.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to restockablerestockable •Boolean! non-null: Whether the line item can be restocked.
Anchor to sellingPlansellingPlan •LineItemSellingPlan: The selling plan details associated with the line item.
Anchor to skusku •String: The variant SKU number.
Anchor to staffMemberstaffMember •StaffMember: Staff attributed to the line item.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: The taxes charged for the line item, including taxes charged for refunded and removed quantities.
Anchor to titletitle •String! non-null: The title of the product at time of order creation.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.
Anchor to unfulfilledDiscountedTotalSetunfulfilledDiscountedTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.
Anchor to unfulfilledOriginalTotalSetunfulfilledOriginalTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.
Anchor to unfulfilledQuantityunfulfilledQuantity •Int! non-null: The number of units not yet fulfilled.
Anchor to variantvariant •ProductVariant: The Variant object associated with this line item.
Anchor to variantTitlevariantTitle •String: The title of the variant at time of order creation.
Anchor to vendorvendor •String: The name of the vendor who made the variant.
Anchor to canRestockcanRestock •Boolean! non-nullDeprecated
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •Money! non-nullDeprecated
Anchor to fulfillableQuantityfulfillableQuantity •Int! non-nullDeprecated
Anchor to fulfillmentServicefulfillmentService •FulfillmentService Deprecated
Anchor to fulfillmentStatusfulfillmentStatus •String! non-nullDeprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated
Anchor to originalUnitPriceoriginalUnitPrice •Money! non-nullDeprecated
Anchor to totalDiscounttotalDiscount •Money! non-nullDeprecated
Anchor to unfulfilledDiscountedTotalunfulfilledDiscountedTotal •Money! non-nullDeprecated
Anchor to unfulfilledOriginalTotalunfulfilledOriginalTotal •Money! non-nullDeprecated

Anchor to LineItemGroup LineItemGroup

•OBJECT

A line item group (bundle) to which a line item belongs to.

Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to quantityquantity •Int! non-null: Quantity of the line item group on the order.
Anchor to titletitle •String! non-null: Title of the line item group.
Anchor to variantIdvariantId •ID: ID of the variant of the line item group.
Anchor to variantSkuvariantSku •String: SKU of the variant of the line item group.

Anchor to Location Location

•OBJECT

Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have fulfills_online_orders: true 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: Whether the location can be reactivated. If false, then trying to activate the location with the LocationActivate mutation will return an error that describes why the location can't be activated.
Anchor to addressaddress •LocationAddress! non-null: The address of this location.
Anchor to addressVerifiedaddressVerified •Boolean! non-null: Whether the location address has been verified.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) that the location was added to a shop.
Anchor to deactivatabledeactivatable •Boolean! non-null: Whether this location can be deactivated. If true, then the location can be deactivated by calling the LocationDeactivate mutation. If false, then calling the mutation to deactivate it will return an error that describes why the location can't be deactivated.
Anchor to deactivatedAtdeactivatedAt •String: 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 "2019-09-07T15:50:00Z".
Anchor to deletabledeletable •Boolean! non-null: Whether this location can be deleted.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: Name of the service provider that fulfills from this location.
Anchor to fulfillsOnlineOrdersfulfillsOnlineOrders •Boolean! non-null: Whether this location can fulfill online orders.
Anchor to hasActiveInventoryhasActiveInventory •Boolean! non-null: Whether this location has active inventory.
Anchor to hasUnfulfilledOrdershasUnfulfilledOrders •Boolean! non-null: Whether this location has orders that need to be fulfilled.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inventoryLevelinventoryLevel •InventoryLevel: The quantities of an inventory item at this location.
Anchor to inventoryLevelsinventoryLevels •InventoryLevelConnection! non-null: A list of the quantities of the inventory items that can be stocked at this location.
Anchor to isActiveisActive •Boolean! non-null: Whether the location is active. A deactivated location can be activated (change isActive: true) if it has activatable set to true by calling the locationActivate mutation.
Anchor to isFulfillmentServiceisFulfillmentService •Boolean! non-null: Whether this location is a fulfillment service.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to localPickupSettingsV2localPickupSettingsV2 •DeliveryLocalPickupSettings: Local pickup settings for the location.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String! non-null: The name of the location.
Anchor to shipsInventoryshipsInventory •Boolean! non-null: Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
Anchor to suggestedAddressessuggestedAddresses •[LocationSuggestedAddress!]! non-null: List of suggested addresses for this location (empty if none).
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the location was last updated.
Anchor to isPrimaryisPrimary •Boolean! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to MailingAddress MailingAddress

•OBJECT

Represents a customer mailing address.

For example, a customer's default address and an order's billing address are both mailling addresses.

Anchor to address1address1

•String

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

Anchor to address2address2

•String

The second line of the address. Typically the number of the apartment, suite, or unit.

Anchor to citycity

•String

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

Anchor to companycompany

•String

The name of the customer's company or organization.

Anchor to coordinatesValidatedcoordinatesValidated

non-null

Whether the address corresponds to recognized latitude and longitude values.

Anchor to countrycountry

•String

The name of the country.

Anchor to countryCodeV2countryCodeV2

•CountryCode

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

For example, US.

Anchor to firstNamefirstName

•String

The first name of the customer.

Anchor to formattedformatted

non-null

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

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

Anchor to formattedAreaformattedArea

•String

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

•ID!

non-null

A globally-unique ID.

Anchor to lastNamelastName

•String

The last name of the customer.

Anchor to latitudelatitude

•Float

The latitude coordinate of the customer address.

Anchor to longitudelongitude

•Float

The longitude coordinate of the customer address.

•String

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

•MailingAddressValidationResult

•String

A unique phone number for the customer.

Anchor to provinceprovince

•String

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

Anchor to provinceCodeprovinceCode

•String

The alphanumeric code for the region.

For example, ON.

Anchor to timeZonetimeZone

•String

The time zone of the address.

Anchor to validationResultSummaryvalidationResultSummary

The validation status that is leveraged by the address validation feature in the Shopify Admin. See "Validating addresses in your Shopify admin" for more details.

Anchor to zipzip

•String

The zip or postal code of the address.

Anchor to countryCodecountryCode

•String

Deprecated

Anchor to Market Market

•OBJECT

A market is a group of one or more regions that you want to target for international sales. By creating a market, you can configure a distinct, localized shopping experience for customers from a specific area of the world. For example, you can change currency, configure international pricing, or add market-specific domains or subfolders.

Anchor to catalogscatalogs •MarketCatalogConnection! non-null: The catalogs that belong to the market.
Anchor to catalogsCountcatalogsCount •Count: The number of catalogs that belong to the market.
Anchor to currencySettingscurrencySettings •MarketCurrencySettings! non-null: The market’s currency settings.
Anchor to handlehandle •String! non-null: A short, human-readable unique identifier for the market. This is changeable by the merchant.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String! non-null: The name of the market. Not shown to customers.
Anchor to webPresenceswebPresences •MarketWebPresenceConnection! non-null: The market’s web presences, which defines 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 any web presences, then the market is accessible on the primary market's domains using country selectors.
Anchor to enabledenabled •Boolean! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to priceListpriceList •PriceList Deprecated
Anchor to primaryprimary •Boolean! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to regionsregions •MarketRegionConnection! non-nullDeprecated
Anchor to webPresencewebPresence •MarketWebPresence Deprecated

Anchor to MarketCatalog MarketCatalog

•OBJECT

A list of products with publishing and pricing information associated with markets.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to marketsmarkets •MarketConnection! non-null: The markets associated with the catalog.
Anchor to operationsoperations •[ResourceOperation!]! non-null: Most recent catalog operations.
Anchor to priceListpriceList •PriceList: The price list associated with the catalog.
Anchor to publicationpublication •Publication: A group of products and collections that's published to a catalog.
Anchor to statusstatus •CatalogStatus! non-null: The status of the catalog.
Anchor to titletitle •String! non-null: The name of the catalog.

Anchor to MarketingActivity MarketingActivity

•OBJECT

The marketing activity resource represents marketing that a merchant created through an app.

Anchor to activityListUrlactivityListUrl •URL: The URL of the marketing activity listing page in the marketing section.
Anchor to adSpendadSpend •MoneyV2: The amount spent on the marketing activity.
Anchor to appapp •App! non-null: The app which created this marketing activity.
Anchor to appErrorsappErrors •MarketingActivityExtensionAppErrors: The errors generated when an app publishes the marketing activity.
Anchor to budgetbudget •MarketingBudget: The allocated budget for the marketing activity.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the marketing activity was created.
Anchor to formDataformData •String: The completed content in the marketing activity creation form.
Anchor to hierarchyLevelhierarchyLevel •MarketingActivityHierarchyLevel: The hierarchy level of the marketing activity.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inMainWorkflowVersioninMainWorkflowVersion •Boolean! non-null: Whether the marketing activity is in the main workflow version of the marketing automation.
Anchor to isExternalisExternal •Boolean! non-null: The marketing activity represents an external marketing activity.
Anchor to marketingChannelTypemarketingChannelType •MarketingChannel! non-null: The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
Anchor to marketingEventmarketingEvent •MarketingEvent: Associated marketing event of this marketing activity.
Anchor to parentActivityIdparentActivityId •ID: ID of the parent activity of this marketing activity.
Anchor to parentRemoteIdparentRemoteId •String: ID of the parent activity of this marketing activity.
Anchor to sourceAndMediumsourceAndMedium •String! non-null: A contextual description of the marketing activity based on the platform and tactic used.
Anchor to statusstatus •MarketingActivityStatus! non-null: The current state of the marketing activity.
Anchor to statusBadgeTypeV2statusBadgeTypeV2 •BadgeType: The severity of the marketing activity's status.
Anchor to statusLabelstatusLabel •String! non-null: The rendered status of the marketing activity.
Anchor to statusTransitionedAtstatusTransitionedAt •DateTime: The date and time when the activity's status last changed.
Anchor to tactictactic •MarketingTactic! non-null: The method of marketing used for this marketing activity.
Anchor to targetStatustargetStatus •MarketingActivityStatus: The status to which the marketing activity is currently transitioning.
Anchor to titletitle •String! non-null: The marketing activity's title, which is rendered on the marketing listing page.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the marketing activity was updated.
Anchor to urlParameterValueurlParameterValue •String: The value portion of the URL query parameter used in attributing sessions to this activity.
Anchor to utmParametersutmParameters •UTMParameters: The set of Urchin Tracking Module used in the URL for tracking this marketing activity.
Anchor to marketingChannelmarketingChannel •MarketingChannel! non-nullDeprecated
Anchor to statusBadgeTypestatusBadgeType •MarketingActivityStatusBadgeType Deprecated

Anchor to MarketingEvent MarketingEvent

•OBJECT

Represents actions that market a merchant's store or products.

Anchor to appapp •App! non-null: The app that the marketing event is attributed to.
Anchor to channelHandlechannelHandle •String: 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 endedAtendedAt •DateTime: The date and time when the marketing event ended.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to manageUrlmanageUrl •URL: The URL where the marketing event can be managed.
Anchor to marketingChannelTypemarketingChannelType •MarketingChannel: The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
Anchor to previewUrlpreviewUrl •URL: The URL where the marketing event can be previewed.
Anchor to remoteIdremoteId •String: An optional ID that helps Shopify validate engagement data.
Anchor to scheduledToEndAtscheduledToEndAt •DateTime: The date and time when the marketing event is scheduled to end.
Anchor to sourceAndMediumsourceAndMedium •String! non-null: Where the MarketingEvent occurred and what kind of content was used. Because utmSource and utmMedium are often used interchangeably, this is based on a combination of marketingChannel, referringDomain, and type to provide a consistent representation for any given piece of marketing regardless of the app that created it.
Anchor to startedAtstartedAt •DateTime! non-null: The date and time when the marketing event started.
Anchor to typetype •MarketingTactic! non-null: The marketing event type.
Anchor to utmCampaignutmCampaign •String: The name of the marketing campaign.
Anchor to utmMediumutmMedium •String: The medium that the marketing campaign is using. Example values: cpc, banner.
Anchor to utmSourceutmSource •String: The referrer of the marketing event. Example values: google, newsletter.
Anchor to channelchannel •MarketingChannel Deprecated
Anchor to targetTypeDisplayTexttargetTypeDisplayText •String! non-nullDeprecated

Anchor to MarketRegionCountry MarketRegionCountry

•OBJECT

A country which comprises a market.

Anchor to codecode •CountryCode! non-null: The ISO code identifying the country.
Anchor to currencycurrency •CurrencySetting! non-null: The currency which this country uses given its market settings.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the region.

Anchor to MarketWebPresence MarketWebPresence

•OBJECT

The market’s web presence, which defines 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 alternateLocalesalternateLocales •[ShopLocale!]! non-null: The ShopLocale object for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and example.ca is the market’s domain, then example.ca/en will load in English.
Anchor to defaultLocaledefaultLocale •ShopLocale! non-null: The ShopLocale object for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and example.ca is the market’s domain, then example.ca will load in French.
Anchor to domaindomain •Domain: The web presence’s domain. This field will be null if subfolderSuffix isn't null.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to marketmarket •Market! non-null: The associated market.
Anchor to rootUrlsrootUrls •[MarketWebPresenceRootUrl!]! non-null: The list of root URLs for each of the web presence’s locales. As of version 2024-04 this value will no longer have a trailing slash.
Anchor to subfolderSuffixsubfolderSuffix •String: 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 MediaImage MediaImage

•OBJECT

The MediaImage object represents an image hosted on Shopify's content delivery network (CDN). Shopify CDN is a content system that serves as the primary way to store, manage, and deliver visual content for products, variants, and other resources across the Shopify platform.

The MediaImage object provides information to:

Store and display product and variant images across online stores, admin interfaces, and mobile apps.
Retrieve visual branding elements, including logos, banners, favicons, and background images in checkout flows.
Retrieve signed URLs for secure, time-limited access to original image files.

Each MediaImage object provides both the processed image data (with automatic optimization and CDN delivery) and access to the original source file. The image processing is handled asynchronously, so images might not be immediately available after upload. The status field indicates when processing is complete and the image is ready for use.

The MediaImage object implements the Media interface alongside other media types, like videos and 3D models.

Learn about managing media for products, product variants, and asynchronous media management.

Anchor to altalt •String: A word or phrase to share the nature or contents of a media.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image for the media. Returns null until status is READY.
Anchor to mediaContentTypemediaContentType •MediaContentType! non-null: The media content type.
Anchor to mediaErrorsmediaErrors •[MediaError!]! non-null: Any errors which have occurred on the media.
Anchor to mediaWarningsmediaWarnings •[MediaWarning!]! non-null: The warnings attached to the media.
Anchor to mimeTypemimeType •String: The MIME type of the image.
Anchor to originalSourceoriginalSource •MediaImageOriginalSource: The original source of the image.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to statusstatus •MediaStatus! non-null: Current status of the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.
Anchor to metafieldmetafield •Metafield Deprecated
Anchor to metafieldsmetafields •MetafieldConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

•OBJECT

A menu for display on the storefront.

Anchor to handlehandle •String! non-null: The menu's handle.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to isDefaultisDefault •Boolean! non-null: Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted.
Anchor to itemsitems •[MenuItem!]! non-null: A list of items on the menu sorted by position.
Anchor to titletitle •String! non-null: The menu's title.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.

Anchor to Metafield Metafield

•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 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 definitiondefinition •MetafieldDefinition: The metafield definition that the metafield belongs to, if any.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to jsonValuejsonValue •JSON! non-null: The data stored in the metafield in JSON format.
Anchor to keykey •String! non-null: The unique identifier for the metafield within its namespace.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! 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 •HasMetafields! non-null: The resource that the metafield is attached to.
Anchor to ownerTypeownerType •MetafieldOwnerType! non-null: The type of resource that the metafield is attached to.
Anchor to referencereference •MetafieldReference: Returns a reference object if the metafield definition's type is a resource reference.
Anchor to referencesreferences •MetafieldReferenceConnection: 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 updatedAtupdatedAt •DateTime! 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 •String Deprecated

Anchor to MetafieldDefinition MetafieldDefinition

•OBJECT

Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context.

Anchor to accessaccess

•MetafieldAccess!

non-null

The access settings associated with the metafield definition.

Anchor to capabilitiescapabilities

•MetafieldCapabilities!

non-null

The capabilities of the metafield definition.

Anchor to constraintsconstraints

•MetafieldDefinitionConstraints

The constraints that determine what subtypes of resources a metafield definition applies to.

Anchor to descriptiondescription

•String

The description of the metafield definition.

•ID!

non-null

A globally-unique ID.

Anchor to keykey

non-null

The unique identifier for the metafield definition within its namespace.

Anchor to metafieldsmetafields

non-null

The metafields that belong to the metafield definition.

Anchor to metafieldsCountmetafieldsCount

•Int!

non-null

The count of the metafields that belong to the metafield definition.

Anchor to validationStatusvalidationStatus •MetafieldValidationStatus: The current validation status.

non-null

The human-readable name of the metafield definition.

Anchor to namespacenamespace

•StandardMetafieldDefinitionTemplate

non-null

The container for a group of metafields that the metafield definition is associated with.

Anchor to ownerTypeownerType

•MetafieldOwnerType!

non-null

The resource type that the metafield definition is attached to.

Anchor to pinnedPositionpinnedPosition

•Int

The position of the metafield definition in the pinned list.

Anchor to standardTemplatestandardTemplate

The standard metafield definition template associated with the metafield definition.

Anchor to typetype

•MetafieldDefinitionType!

non-null

The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of supported types.

Anchor to useAsCollectionConditionuseAsCollectionCondition

•[MetafieldDefinitionValidation!]!

non-null

Whether the metafield definition can be used as a collection condition.

Anchor to validationsvalidations

non-null

A list of validation options for the metafields that belong to the metafield definition. For example, for a metafield definition with the type date, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum.

Anchor to validationStatusvalidationStatus

•MetafieldDefinitionValidationStatus!

non-null

The validation status for the metafields that belong to the metafield definition.

Anchor to visibleToStorefrontApivisibleToStorefrontApi

Anchor to MetafieldStorefrontVisibility MetafieldStorefrontVisibility

non-nullDeprecated

•OBJECT

By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API, you need to create a MetafieldStorefrontVisibility record. A MetafieldStorefrontVisibility record is a list of the metafields, defined by the owner_type, namespace, and key, to make visible in the Storefront API.

Learn about [exposing metafields in the Storefront API] (https://shopify.dev/custom-storefronts/products-collections/metafields) for more details.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the metafield was set to visible in the Storefront API.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to keykey •String! non-null: The key of a metafield to make visible in the Storefront API.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to namespacenamespace •String! non-null: The namespace of a metafield to make visible in the Storefront API.
Anchor to ownerTypeownerType •MetafieldOwnerType! non-null: The owner type of a metafield to make visible in the Storefront API.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the MetafieldStorefrontVisibility record was updated.

Anchor to Metaobject Metaobject

•OBJECT

Provides an object instance represented by a MetaobjectDefinition.

Anchor to capabilitiescapabilities •MetaobjectCapabilityData! non-null: Metaobject capabilities for this Metaobject.
Anchor to createdBycreatedBy •App! non-null: The app used to create the object.
Anchor to createdByAppcreatedByApp •App! non-null: The app used to create the object.
Anchor to createdByStaffcreatedByStaff •StaffMember: The staff member who created the metaobject.
Anchor to definitiondefinition •MetaobjectDefinition! non-null: The MetaobjectDefinition that models this object type.
Anchor to displayNamedisplayName •String! non-null: The preferred display name field value of the metaobject.
Anchor to fieldfield •MetaobjectField: The field for an object key, or null if the key has no field definition.
Anchor to fieldsfields •[MetaobjectField!]! non-null: All ordered fields of the metaobject with their definitions and values.
Anchor to handlehandle •String! non-null: The unique handle of the object, useful as a custom ID.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to referencedByreferencedBy •MetafieldRelationConnection! non-null: List of back references metafields that belong to the resource.
Anchor to thumbnailFieldthumbnailField •MetaobjectField: The recommended field to visually represent this metaobject. May be a file reference or color field.
Anchor to typetype •String! non-null: The type of the metaobject.
Anchor to updatedAtupdatedAt •DateTime! non-null: When the object was last updated.
Anchor to staffMemberstaffMember •StaffMember Deprecated

Anchor to MetaobjectDefinition MetaobjectDefinition

•OBJECT

Provides the definition of a generic object structure composed of metafields.

Anchor to accessaccess •MetaobjectAccess! non-null: Access configuration for the metaobject definition.
Anchor to capabilitiescapabilities •MetaobjectCapabilities! non-null: The capabilities of the metaobject definition.
Anchor to createdByAppcreatedByApp •App! non-null: The app used to create the metaobject definition.
Anchor to createdByStaffcreatedByStaff •StaffMember: The staff member who created the metaobject definition.
Anchor to descriptiondescription •String: The administrative description.
Anchor to displayNameKeydisplayNameKey •String: The key of a field to reference as the display name for each object.
Anchor to fieldDefinitionsfieldDefinitions •[MetaobjectFieldDefinition!]! non-null: The fields defined for this object type.
Anchor to hasThumbnailFieldhasThumbnailField •Boolean! non-null: Whether this metaobject definition has field whose type can visually represent a metaobject with the thumbnailField.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metaobjectsmetaobjects •MetaobjectConnection! non-null: A paginated connection to the metaobjects associated with the definition.
Anchor to metaobjectsCountmetaobjectsCount •Int! non-null: The count of metaobjects created for the definition.
Anchor to namename •String! non-null: The human-readable name.
Anchor to typetype •String! non-null: The type of the object definition. Defines the namespace of associated metafields.

Anchor to Model3d Model3d

•OBJECT

Represents a Shopify hosted 3D model.

Anchor to altalt •String: A word or phrase to describe the contents or the function of a file.
Anchor to boundingBoxboundingBox •Model3dBoundingBox: The 3d model's bounding box information.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to filenamefilename •String! non-null: The 3d model's filename.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to mediaContentTypemediaContentType •MediaContentType! non-null: The media content type.
Anchor to mediaErrorsmediaErrors •[MediaError!]! non-null: Any errors which have occurred on the media.
Anchor to mediaWarningsmediaWarnings •[MediaWarning!]! non-null: The warnings attached to the media.
Anchor to originalSourceoriginalSource •Model3dSource: The 3d model's original source.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to sourcessources •[Model3dSource!]! non-null: The 3d model's sources.
Anchor to statusstatus •MediaStatus! non-null: Current status of the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.

Anchor to OnlineStoreTheme OnlineStoreTheme

•OBJECT

A theme for display on the storefront.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the theme was created.
Anchor to filesfiles •OnlineStoreThemeFileConnection: The files in the theme.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the theme, set by the merchant.
Anchor to prefixprefix •String! non-null: The prefix of the theme.
Anchor to processingprocessing •Boolean! non-null: Whether the theme is processing.
Anchor to processingFailedprocessingFailed •Boolean! non-null: Whether the theme processing failed.
Anchor to rolerole •ThemeRole! non-null: The role of the theme.
Anchor to themeStoreIdthemeStoreId •Int: The theme store ID.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the theme was last updated.

Anchor to Order Order

•OBJECT

The Order object represents a customer's request to purchase one or more products from a store. Use the Order 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.

Note

Only 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 read_all_orders, read_orders, and write_orders scopes.

Caution

Only 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 additionalFeesadditionalFees •[AdditionalFee!]! non-null: A list of additional fees applied to an order, such as duties, import fees, or tax lines.
Anchor to agreementsagreements •SalesAgreementConnection! 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 •[ResourceAlert!]! 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.
Anchor to appapp •OrderApp: 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 billingAddressbillingAddress •MailingAddress: 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 billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress •Boolean! non-null: Whether the billing address matches the shipping address. Returns true if both addresses are the same, and false if they're different or if an address is missing.
Anchor to cancellationcancellation •OrderCancellation: Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any staff notes.
Anchor to cancelledAtcancelledAt •DateTime: The date and time in ISO 8601 format when an order was canceled. Returns null if the order hasn't been canceled.
Anchor to cancelReasoncancelReason •OrderCancelReason: 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 canMarkAsPaidcanMarkAsPaid •Boolean! 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 canNotifyCustomercanNotifyCustomer •Boolean! 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 cartDiscountAmountSetcartDiscountAmountSet •MoneyBag: 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 channelInformationchannelInformation •ChannelInformation: 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 clientIpclientIp •String: 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 closedAtclosedAt •DateTime: 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 confirmationNumberconfirmationNumber •String: A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example, XPAV284CT) 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 createdAtcreatedAt •DateTime! 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 currencyCodecurrencyCode •CurrencyCode! non-null: The shop currency when the order was placed. For example, "USD" or "CAD".
Anchor to currentCartDiscountAmountSetcurrentCartDiscountAmountSet •MoneyBag! 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 cartDiscountAmountSet field.
Anchor to currentShippingPriceSetcurrentShippingPriceSet •MoneyBag! non-null: The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
Anchor to currentSubtotalLineItemsQuantitycurrentSubtotalLineItemsQuantity •Int! 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 currentSubtotalPriceSetcurrentSubtotalPriceSet •MoneyBag! non-null: The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.
Anchor to currentTaxLinescurrentTaxLines •[TaxLine!]! 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 and title.
Anchor to currentTotalAdditionalFeesSetcurrentTotalAdditionalFeesSet •MoneyBag: 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 currentTotalDiscountsSetcurrentTotalDiscountsSet •MoneyBag! 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 currentTotalDutiesSetcurrentTotalDutiesSet •MoneyBag: The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.
Anchor to currentTotalPriceSetcurrentTotalPriceSet •MoneyBag! non-null: The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.
Anchor to currentTotalTaxSetcurrentTotalTaxSet •MoneyBag! 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 currentTotalWeightcurrentTotalWeight •UnsignedInt64! non-null: The total weight of the order after returns and refunds, in grams.
Anchor to customAttributescustomAttributes •[Attribute!]! 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 customerAcceptsMarketingcustomerAcceptsMarketing •Boolean! 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 customerJourneySummarycustomerJourneySummary •CustomerJourneySummary: 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 customerLocalecustomerLocale •String: 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 discountApplicationsdiscountApplications •DiscountApplicationConnection! 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 discountCodediscountCode •String: The discount code used for an order. Returns null if no discount code was applied.
Anchor to discountCodesdiscountCodes •[String!]! non-null: The discount codes used for the order. Multiple codes can be applied to a single order.
Anchor to displayAddressdisplayAddress •MailingAddress: 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 displayFinancialStatusdisplayFinancialStatus •OrderDisplayFinancialStatus: An order's financial status for display in the Shopify admin.
Anchor to displayFulfillmentStatusdisplayFulfillmentStatus •OrderDisplayFulfillmentStatus! 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 FulfillmentOrder object.
Anchor to disputesdisputes •[OrderDisputeSummary!]! 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 dutiesIncludeddutiesIncluded •Boolean! 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 estimatedTaxesestimatedTaxes •Boolean! 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 •EventConnection! 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 fulfillmentOrdersfulfillmentOrders •FulfillmentOrderConnection! 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 fulfillmentsCountfulfillmentsCount •Count: The total number of fulfillments for the order, including canceled ones.
Anchor to fullyPaidfullyPaid •Boolean! 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 hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether the merchant has added a timeline comment to the order.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to lineItemslineItems •LineItemConnection! 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 merchantBusinessEntitymerchantBusinessEntity •BusinessEntity! 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 merchantEditablemerchantEditable •Boolean! 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 merchantEditableErrorsmerchantEditableErrors •[String!]! non-null: A list of reasons why the order can't be edited. For example, canceled orders can't be edited.
Anchor to merchantOfRecordAppmerchantOfRecordApp •OrderApp: 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 and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
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 netPaymentSetnetPaymentSet •MoneyBag! 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 nonFulfillableLineItemsnonFulfillableLineItems •LineItemConnection! 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 originalTotalAdditionalFeesSetoriginalTotalAdditionalFeesSet •MoneyBag: 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 originalTotalDutiesSetoriginalTotalDutiesSet •MoneyBag: The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use currentTotalDutiesSet to retrieve the current duties amount after adjustments.
Anchor to originalTotalPriceSetoriginalTotalPriceSet •MoneyBag! 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 paymentCollectionDetailspaymentCollectionDetails •OrderPaymentCollectionDetails! 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 paymentGatewayNamespaymentGatewayNames •[String!]! 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 paymentTermspaymentTerms •PaymentTerms: 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 poNumberpoNumber •String: 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 presentmentCurrencyCodepresentmentCurrencyCode •CurrencyCode! 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 processedAtprocessedAt •DateTime! 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 purchasingEntitypurchasingEntity •PurchasingEntity: 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 refundDiscrepancySetrefundDiscrepancySet •MoneyBag! 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 registeredSourceUrlregisteredSourceUrl •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 requiresShippingrequiresShipping •Boolean! non-null: Whether the order requires physical shipping to the customer. Returns false for digital-only orders (such as gift cards or downloadable products) and true 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 retailLocationretailLocation •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 •ReturnConnection! 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 returnStatusreturnStatus •OrderReturnStatus! 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 •OrderRiskSummary! 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 shippingAddressshippingAddress •MailingAddress: 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 shippingLineshippingLine •ShippingLine: 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 shippingLinesshippingLines •ShippingLineConnection! 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 shopifyProtectshopifyProtect •ShopifyProtectOrderSummary: 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 sourceIdentifiersourceIdentifier •String: A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The receiptNumber field is derived from this value for POS orders.
Anchor to sourceNamesourceName •String: 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 staffMemberstaffMember •StaffMember: 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 statusPageUrlstatusPageUrl •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 subtotalLineItemsQuantitysubtotalLineItemsQuantity •Int! 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 subtotalPriceSetsubtotalPriceSet •MoneyBag: The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If taxesIncluded is true, then the subtotal also includes tax.
Anchor to suggestedRefundsuggestedRefund •SuggestedRefund: 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.
Anchor to tagstags •[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 taxesIncludedtaxesIncluded •Boolean! non-null: Whether taxes are included in the subtotal price of the order. When true, the subtotal and line item prices include tax amounts. When false, taxes are calculated and displayed separately.
Anchor to taxExempttaxExempt •Boolean! 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 taxLinestaxLines •[TaxLine!]! 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 and title.
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 totalCapturableSettotalCapturableSet •MoneyBag! non-null: The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.
Anchor to totalCashRoundingAdjustmenttotalCashRoundingAdjustment •CashRoundingAdjustment! 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 totalDiscountsSettotalDiscountsSet •MoneyBag: The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.
Anchor to totalOutstandingSettotalOutstandingSet •MoneyBag! 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 totalPriceSettotalPriceSet •MoneyBag! non-null: The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.
Anchor to totalReceivedSettotalReceivedSet •MoneyBag! non-null: The total amount received from the customer before returns, in shop and presentment currencies.
Anchor to totalRefundedSettotalRefundedSet •MoneyBag! non-null: The total amount that was refunded, in shop and presentment currencies.
Anchor to totalRefundedShippingSettotalRefundedShippingSet •MoneyBag! non-null: The total amount of shipping that was refunded, in shop and presentment currencies.
Anchor to totalShippingPriceSettotalShippingPriceSet •MoneyBag! 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 totalTaxSettotalTaxSet •MoneyBag: The total tax amount before returns, in shop and presentment currencies.
Anchor to totalTipReceivedSettotalTipReceivedSet •MoneyBag! non-null: The sum of all tip amounts for the order, in shop and presentment currencies.
Anchor to totalWeighttotalWeight •UnsignedInt64: The total weight of the order before returns, in grams.
Anchor to transactionstransactions •[OrderTransaction!]! non-null: A list of transactions associated with the order.
Anchor to transactionsCounttransactionsCount •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 updatedAtupdatedAt •DateTime! non-null: The date and time in ISO 8601 format when the order was last modified.
Anchor to cartDiscountAmountcartDiscountAmount •Money Deprecated
Anchor to channelchannel •Channel Deprecated
Anchor to customerJourneycustomerJourney •CustomerJourney Deprecated
Anchor to landingPageDisplayTextlandingPageDisplayText •String Deprecated
Anchor to landingPageUrllandingPageUrl •URL Deprecated
Anchor to localizationExtensionslocalizationExtensions •LocalizationExtensionConnection! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to netPaymentnetPayment •Money! non-nullDeprecated
Anchor to physicalLocationphysicalLocation •Location Deprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to referralCodereferralCode •String Deprecated
Anchor to referrerDisplayTextreferrerDisplayText •String Deprecated
Anchor to referrerUrlreferrerUrl •URL Deprecated
Anchor to riskLevelriskLevel •OrderRiskLevel! non-nullDeprecated
Anchor to risksrisks •[OrderRisk!]! non-nullDeprecated
Anchor to subtotalPricesubtotalPrice •Money Deprecated
Anchor to totalCapturabletotalCapturable •Money! non-nullDeprecated
Anchor to totalDiscountstotalDiscounts •Money Deprecated
Anchor to totalPricetotalPrice •Money! non-nullDeprecated
Anchor to totalReceivedtotalReceived •Money! non-nullDeprecated
Anchor to totalRefundedtotalRefunded •Money! non-nullDeprecated
Anchor to totalShippingPricetotalShippingPrice •Money! non-nullDeprecated
Anchor to totalTaxtotalTax •Money Deprecated
Anchor to totalTipReceivedtotalTipReceived •MoneyV2! non-nullDeprecated

Anchor to OrderAdjustment OrderAdjustment

•OBJECT

An order adjustment accounts for the difference between a calculated and actual refund amount.

Anchor to amountSetamountSet •MoneyBag! non-null: The amount of the order adjustment in shop and presentment currencies.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to reasonreason •OrderAdjustmentDiscrepancyReason: An optional reason that explains a discrepancy between calculated and actual refund amounts.
Anchor to taxAmountSettaxAmountSet •MoneyBag! non-null: The tax amount of the order adjustment in shop and presentment currencies.

Anchor to OrderDisputeSummary OrderDisputeSummary

•OBJECT

A summary of the important details for a dispute on an order.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to initiatedAsinitiatedAs •DisputeType! non-null: The type that the dispute was initiated as.
Anchor to statusstatus •DisputeStatus! non-null: The current status of the dispute.

Anchor to OrderTransaction OrderTransaction

•OBJECT

The OrderTransaction object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity.

Use the OrderTransaction object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using the OrderTransaction object include:

Processing new payments for orders
Managing payment authorizations and captures
Processing refunds for returned items
Tracking payment status and errors
Managing multi-currency transactions
Handling payment gateway integrations

Each OrderTransaction object has a kind that defines the type of transaction and a status that indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details.

Learn more about payment processing and payment gateway integrations.

Anchor to accountNumberaccountNumber •String: The masked account number associated with the payment method.
Anchor to amountRoundingSetamountRoundingSet •MoneyBag: The rounding adjustment applied on the cash amount in shop and presentment currencies.
Anchor to amountSetamountSet •MoneyBag! non-null: The amount and currency of the transaction in shop and presentment currencies.
Anchor to authorizationCodeauthorizationCode •String: Authorization code associated with the transaction.
Anchor to authorizationExpiresAtauthorizationExpiresAt •DateTime: The time when the authorization expires. This field is available only to stores on a Shopify Plus plan.
Anchor to createdAtcreatedAt •DateTime! non-null: Date and time when the transaction was created.
Anchor to errorCodeerrorCode •OrderTransactionErrorCode: A standardized error code, independent of the payment provider.
Anchor to feesfees •[TransactionFee!]! non-null: The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
Anchor to formattedGatewayformattedGateway •String: The human-readable payment gateway name used to process the transaction.
Anchor to gatewaygateway •String: The payment gateway used to process the transaction.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to kindkind •OrderTransactionKind! non-null: The kind of transaction.
Anchor to manuallyCapturablemanuallyCapturable •Boolean! non-null: Whether the transaction can be manually captured.
Anchor to maximumRefundableV2maximumRefundableV2 •MoneyV2: Specifies the available amount with currency to refund on the gateway. This value is only available for transactions of type SuggestedRefund.
Anchor to multiCapturablemultiCapturable •Boolean! non-null: Whether the transaction can be captured multiple times.
Anchor to orderorder •Order: The associated order.
Anchor to parentTransactionparentTransaction •OrderTransaction: The associated parent transaction, for example the authorization of a capture.
Anchor to paymentDetailspaymentDetails •PaymentDetails: The payment details for the transaction.
Anchor to paymentIconpaymentIcon •Image: The payment icon to display for the transaction.
Anchor to paymentIdpaymentId •String: The payment ID associated with the transaction.
Anchor to processedAtprocessedAt •DateTime: Date and time when the transaction was processed.
Anchor to receiptJsonreceiptJson •JSON: The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
Anchor to settlementCurrencysettlementCurrency •CurrencyCode: The settlement currency.
Anchor to settlementCurrencyRatesettlementCurrencyRate •Decimal: The rate used when converting the transaction amount to settlement currency.
Anchor to shopifyPaymentsSetshopifyPaymentsSet •ShopifyPaymentsTransactionSet: Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan.
Anchor to statusstatus •OrderTransactionStatus! non-null: The status of this transaction.
Anchor to testtest •Boolean! non-null: Whether the transaction is a test transaction.
Anchor to totalUnsettledSettotalUnsettledSet •MoneyBag: Specifies the available amount with currency to capture on the gateway in shop and presentment currencies. Only available when an amount is capturable or manually mark as paid.
Anchor to useruser •StaffMember: Staff member who was logged into the Shopify POS device when the transaction was processed.
Anchor to amountamount •Money! non-nullDeprecated
Anchor to amountV2amountV2 •MoneyV2! non-nullDeprecated
Anchor to maximumRefundablemaximumRefundable •Money Deprecated
Anchor to paymentMethodpaymentMethod •PaymentMethods Deprecated
Anchor to totalUnsettledtotalUnsettled •Money Deprecated
Anchor to totalUnsettledV2totalUnsettledV2 •MoneyV2 Deprecated

Anchor to Page Page

•OBJECT

A page on the Online Store.

Anchor to bodybody •HTML! non-null: The text content of the page, complete with HTML markup.
Anchor to bodySummarybodySummary •String! non-null: The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) of the page creation.
Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to handlehandle •String! non-null: A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to isPublishedisPublished •Boolean! non-null: Whether or not the page is visible.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to publishedAtpublishedAt •DateTime: The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.
Anchor to templateSuffixtemplateSuffix •String: The suffix of the template that's used to render the page.
Anchor to titletitle •String! non-null: Title of the page.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) of the latest page update.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to PaymentCustomization PaymentCustomization

•OBJECT

A payment customization.

Anchor to enabledenabled •Boolean! non-null: The enabled status of the payment customization.
Anchor to errorHistoryerrorHistory •FunctionsErrorHistory: The error history on the most recent version of the payment customization.
Anchor to functionIdfunctionId •String! non-null: The ID of the Shopify Function implementing the payment customization.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to shopifyFunctionshopifyFunction •ShopifyFunction! non-null: The Shopify Function implementing the payment customization.
Anchor to titletitle •String! non-null: The title of the payment customization.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to PaymentMandate PaymentMandate

•OBJECT

A payment instrument and the permission the owner of the instrument gives to the merchant to debit it.

Anchor to idid •ID! non-null: The unique ID of a payment mandate.
Anchor to paymentInstrumentpaymentInstrument •PaymentInstrument! non-null: The outputs details of the payment instrument.

Anchor to PaymentSchedule PaymentSchedule

•OBJECT

Represents the payment schedule for a single payment defined in the payment terms.

Anchor to completedAtcompletedAt •DateTime: Date and time when the payment schedule is paid or fulfilled.
Anchor to dueAtdueAt •DateTime: Date and time when the payment schedule is due.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to issuedAtissuedAt •DateTime: Date and time when the invoice is sent.
Anchor to paymentTermspaymentTerms •PaymentTerms! non-null: The payment terms the payment schedule belongs to.
Anchor to amountamount •MoneyV2! non-nullDeprecated

Anchor to PaymentTerms PaymentTerms

•OBJECT

Represents the payment terms for an order or draft order.

Anchor to draftOrderdraftOrder •DraftOrder: The draft order associated with the payment terms.
Anchor to dueInDaysdueInDays •Int: Duration of payment terms in days based on the payment terms template used to create the payment terms.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to orderorder •Order: The order associated with the payment terms.
Anchor to overdueoverdue •Boolean! non-null: Whether the payment terms have overdue payment schedules.
Anchor to paymentSchedulespaymentSchedules •PaymentScheduleConnection! non-null: List of schedules for the payment terms.
Anchor to paymentTermsNamepaymentTermsName •String! non-null: The name of the payment terms template used to create the payment terms.
Anchor to paymentTermsTypepaymentTermsType •PaymentTermsType! non-null: The payment terms template type 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 PaymentTermsTemplate PaymentTermsTemplate

•OBJECT

Represents the payment terms template object.

Anchor to descriptiondescription •String! non-null: The description of the payment terms template.
Anchor to dueInDaysdueInDays •Int: The number of days between the issued date and due date if this is the net type of payment terms.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the payment terms template.
Anchor to paymentTermsTypepaymentTermsType •PaymentTermsType! non-null: The type of the payment terms template.
Anchor to translatedNametranslatedName •String! non-null: The translated payment terms template name.

Anchor to PriceList PriceList

•OBJECT

Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.

For more information on price lists, refer to Support different pricing models.

Anchor to catalogcatalog •Catalog: The catalog that the price list is associated with.
Anchor to currencycurrency •CurrencyCode! non-null: The currency for fixed prices associated with this price list.
Anchor to fixedPricesCountfixedPricesCount •Int! non-null: The number of fixed prices on the price list.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The unique name of the price list, used as a human-readable identifier.
Anchor to parentparent •PriceListParent: Relative adjustments to other prices.
Anchor to pricesprices •PriceListPriceConnection! non-null: A list of prices associated with the price list.
Anchor to quantityRulesquantityRules •QuantityRuleConnection! non-null: A list of quantity rules associated with the price list, ordered by product variants.

Anchor to PriceRule PriceRule

•OBJECT

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

We recommend using the types and queries detailed at Getting started with discounts instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.

Anchor to allocationLimitallocationLimit •Int: The maximum number of times that the price rule can be allocated onto an order.
Anchor to allocationMethodallocationMethod •PriceRuleAllocationMethod! non-null: The method by which the price rule's value is allocated to its entitled items.
Anchor to appapp •App: The application that created the price rule.
Anchor to combinesWithcombinesWith •DiscountCombinesWith! non-null: The discount classes that you can use in combination with Shopify discount types.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the price rule was created.
Anchor to customerSelectioncustomerSelection •PriceRuleCustomerSelection! non-null: The customers that can use this price rule.
Anchor to discountClassdiscountClass •DiscountClass! non-null: The discount class that's used to control how discounts can be combined.
Anchor to discountCodesdiscountCodes •PriceRuleDiscountCodeConnection! non-null: List of the price rule's discount codes.
Anchor to discountCodesCountdiscountCodesCount •Count: How many discount codes associated with the price rule.
Anchor to endsAtendsAt •DateTime: The date and time when the price rule ends. For open-ended price rules, use null.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the price rule.
Anchor to featuresfeatures •[PriceRuleFeature!]! non-null: A list of the price rule's features.
Anchor to hasTimelineCommenthasTimelineComment •Boolean! non-null: Indicates whether there are any timeline comments on the price rule.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to itemEntitlementsitemEntitlements •PriceRuleItemEntitlements! non-null: The items to which the price rule applies.
Anchor to itemPrerequisitesitemPrerequisites •PriceRuleLineItemPrerequisites! non-null: The items required for the price rule to be applicable.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to oncePerCustomeroncePerCustomer •Boolean! non-null: Whether the price rule can be applied only once per customer.
Anchor to prerequisiteQuantityRangeprerequisiteQuantityRange •PriceRuleQuantityRange: The number of the entitled items must fall within this range for the price rule to be applicable.
Anchor to prerequisiteShippingPriceRangeprerequisiteShippingPriceRange •PriceRuleMoneyRange: The shipping cost must fall within this range for the price rule to be applicable.
Anchor to prerequisiteSubtotalRangeprerequisiteSubtotalRange •PriceRuleMoneyRange: The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
Anchor to prerequisiteToEntitlementQuantityRatioprerequisiteToEntitlementQuantityRatio •PriceRulePrerequisiteToEntitlementQuantityRatio: Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
Anchor to shareableUrlsshareableUrls •[PriceRuleShareableUrl!]! non-null: URLs that can be used to share the discount.
Anchor to shippingEntitlementsshippingEntitlements •PriceRuleShippingLineEntitlements! non-null: The shipping lines to which the price rule applies.
Anchor to startsAtstartsAt •DateTime! non-null: The date and time when the price rule starts.
Anchor to statusstatus •PriceRuleStatus! non-null: The status of the price rule.
Anchor to summarysummary •String: A detailed summary of the price rule.
Anchor to targettarget •PriceRuleTarget! non-null: The type of lines (line_item or shipping_line) to which the price rule applies.
Anchor to titletitle •String! non-null: The title of the price rule.
Anchor to totalSalestotalSales •MoneyV2: The total sales from orders where the price rule was used.
Anchor to usageCountusageCount •Int! non-null: The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.
Anchor to usageLimitusageLimit •Int: The maximum number of times that the price rule can be used in total.
Anchor to validityPeriodvalidityPeriod •PriceRuleValidityPeriod! non-null: A time period during which a price rule is applicable.
Anchor to valueV2valueV2 •PricingValue! non-null: The value of the price rule.
Anchor to entitlementToPrerequisiteQuantityRatioentitlementToPrerequisiteQuantityRatio •PriceRuleEntitlementToPrerequisiteQuantityRatio Deprecated
Anchor to traitstraits •[PriceRuleTrait!]! non-nullDeprecated
Anchor to valuevalue •PriceRuleValue! non-nullDeprecated

Anchor to PriceRuleDiscountCode PriceRuleDiscountCode

•OBJECT

A discount code of a price rule.

Anchor to appapp •App: The application that created the discount code.
Anchor to codecode •String! non-null: The code to apply the discount.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to usageCountusageCount •Int! non-null: The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.

Anchor to PrivateMetafield PrivateMetafield

•OBJECT

Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.

An application can create a maximum of 10 private metafields per shop resource.

Private metafields are deprecated. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the private metafield was created.
Anchor to idid •ID! non-null: The ID of the private metafield.
Anchor to keykey •String! non-null: The key name of the private metafield.
Anchor to namespacenamespace •String! non-null: The namespace of the private metafield.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the private metafield was updated.
Anchor to valuevalue •String! non-null: The value of a private metafield.
Anchor to valueTypevalueType •PrivateMetafieldValueType! non-null: Represents the private metafield value type.

Anchor to Product Product

•OBJECT

The Product object lets you manage products in a merchant’s store.

Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.

Learn more about working with Shopify's product model, including limitations and considerations.

Anchor to availablePublicationsCountavailablePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

Anchor to bundleComponentsbundleComponents

•ProductBundleComponentConnection!

non-null

A list of components that are associated with a product in a bundle.

Anchor to categorycategory

•TaxonomyCategory

The category of a product from Shopify's Standard Product Taxonomy.

Anchor to collectionscollections

•CollectionConnection!

non-null

A list of collections that include the product.

Anchor to combinedListingcombinedListing

•CombinedListing

A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.

Anchor to combinedListingRolecombinedListingRole

•CombinedListingsRole

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.

Anchor to compareAtPriceRangecompareAtPriceRange

•ProductCompareAtPriceRange

The compare-at price range of the product in the shop's default currency.

Anchor to contextualPricingcontextualPricing

•ProductContextualPricing!

non-null

The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. Only active markets are considered in the price resolution.

Anchor to createdAtcreatedAt

non-null

The date and time when the product was created.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to descriptiondescription

non-null

A single-line description of the product, with HTML tags removed.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

•HTML!

non-null

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Anchor to featuredMediafeaturedMedia

•Media

The featured media associated with the product.

Anchor to feedbackfeedback

•ResourceFeedback

The information that lets merchants know what steps they need to take to make sure that the app is set up correctly.

For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product".

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix

•String

The theme template that's used when customers view the gift card in a store.

Anchor to handlehandle

non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but no spaces. The handle is used in the online store URL for the product.

Anchor to hasOnlyDefaultVarianthasOnlyDefaultVariant

non-null

Whether the product has only a single variant with the default option and value.

Anchor to hasOutOfStockVariantshasOutOfStockVariants

non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents

non-null

Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.

•ID!

non-null

A globally-unique ID.

Anchor to inCollectioninCollection

non-null

Whether the product is in a specified collection.

Anchor to idid •ID! required: The ID of the collection to check. For example, id: "gid://shopify/Collection/123".

Anchor to isGiftCardisGiftCard

non-null

Whether the product is a gift card.

Anchor to legacyResourceIdlegacyResourceId

•UnsignedInt64!

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to mediamedia

•MediaConnection!

non-null

The media associated with the product. Valid media are images, 3D models, videos.

Anchor to mediaCountmediaCount

•Count

The total count of media that's associated with a product.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl

•URL

The preview URL for the online store.

Anchor to onlineStoreUrlonlineStoreUrl

•URL

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

Anchor to optionsoptions

•[ProductOption!]!

non-null

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

Anchor to priceRangeV2priceRangeV2

•ProductPriceRangeV2!

non-null

The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.

Anchor to productTypeproductType

non-null

The product type that merchants define.

Anchor to publishedAtpublishedAt

•DateTime

The date and time when the product was published to the online store.

Anchor to publishedInContextpublishedInContext

non-null

Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.

Anchor to contextcontext •ContextualPublicationContext! required: The context used to determine publication status.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

non-null

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

Anchor to publishedOnPublicationpublishedOnPublication

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

Anchor to requiresSellingPlanrequiresSellingPlan

non-null

Whether the product can only be purchased with a selling plan. Products that are sold on subscription (requiresSellingPlan: true) can be updated only for online stores. If you update a product to be subscription-only (requiresSellingPlan:false), then the product is unpublished from all channels, except the online store.

Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication

•ResourcePublicationV2

The resource that's either published or staged to be published to the publication.

Anchor to resourcePublicationsresourcePublications

•ResourcePublicationV2Connection!

non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

Anchor to resourcePublicationsV2resourcePublicationsV2

non-null

The list of resources that are either published or staged to be published to a publication.

Anchor to restrictedForResourcerestrictedForResource

•RestrictedForResource

Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.

Anchor to sellingPlanGroupssellingPlanGroups

•SellingPlanGroupConnection!

non-null

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

A count of selling plan groups that are associated with the product.

Anchor to seoseo

•SEO!

non-null

The SEO title and description that are associated with a product.

Anchor to statusstatus

•ProductStatus!

non-null

The product status, which controls visibility across all sales channels.

Anchor to tagstags

non-null

A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the sports and summer tags to products that are associated with sportwear for summer.

Updating tags overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the tagsAdd mutation.

Anchor to templateSuffixtemplateSuffix

•String

The theme template that's used when customers view the product in a store.

Anchor to titletitle

non-null

The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to totalInventorytotalInventory

•Int!

non-null

The quantity of inventory that's in stock.

Anchor to tracksInventorytracksInventory

non-null

Whether inventory tracking has been enabled for the product.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications

•PublicationConnection!

non-null

The list of publications that the resource isn't published to.

Anchor to updatedAtupdatedAt

non-null

The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

Anchor to variantsvariants

•ProductVariantConnection!

non-null

A list of variants associated with the product.

Anchor to variantsCountvariantsCount

•Count

The number of variants that are associated with the product.

Anchor to vendorvendor

non-null

The name of the product's vendor.

Anchor to bodyHtmlbodyHtml

•String

Deprecated

Anchor to customProductTypecustomProductType

•String

Deprecated

Anchor to descriptionPlainSummarydescriptionPlainSummary

•MetafieldDefinitionConnection!

non-nullDeprecated

Anchor to featuredImagefeaturedImage

•Image

Deprecated

Anchor to imagesimages

•ImageConnection!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Anchor to priceRangepriceRange

•ProductPriceRange!

non-nullDeprecated

Anchor to privateMetafieldprivateMetafield

•PrivateMetafield

Deprecated

Anchor to privateMetafieldsprivateMetafields

•PrivateMetafieldConnection!

non-nullDeprecated

Anchor to productCategoryproductCategory

•ProductCategory

Deprecated

Anchor to productPublicationsproductPublications

•ProductPublicationConnection!

non-nullDeprecated

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to publicationspublications

•ProductPublicationConnection!

non-nullDeprecated

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

Anchor to ProductBundleOperation ProductBundleOperation

non-nullDeprecated

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to standardizedProductTypestandardizedProductType

•StandardizedProductType

Deprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to totalVariantstotalVariants

•Int!

non-nullDeprecated

Anchor to unpublishedChannelsunpublishedChannels

•ChannelConnection!

non-nullDeprecated

•OBJECT

An entity that represents details of an asynchronous ProductBundleCreate or ProductBundleUpdate mutation.

By querying this entity with the productOperation query using the ID that was returned when the bundle was created or updated, this can be used to check the status of an operation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the created or updated product.

The userErrors field provides mutation errors that occurred during the operation.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to productproduct •Product: The product on which the operation is being performed.
Anchor to statusstatus •ProductOperationStatus! non-null: The status of this operation.
Anchor to userErrorsuserErrors •[ProductBundleMutationUserError!]! non-null: Returns mutation errors occurred during background mutation processing.

Anchor to ProductDeleteOperation ProductDeleteOperation

•OBJECT

An entity that represents details of an asynchronous ProductDelete mutation.

By querying this entity with the productOperation query using the ID that was returned when the product was deleted, this can be used to check the status of an operation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The deletedProductId field provides the ID of the deleted product.

The userErrors field provides mutation errors that occurred during the operation.

Anchor to deletedProductIddeletedProductId •ID: The ID of the deleted product.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to productproduct •Product: The product on which the operation is being performed.
Anchor to statusstatus •ProductOperationStatus! non-null: The status of this operation.
Anchor to userErrorsuserErrors •[UserError!]! non-null: Returns mutation errors occurred during background mutation processing.

Anchor to ProductDuplicateOperation ProductDuplicateOperation

•OBJECT

An entity that represents details of an asynchronous ProductDuplicate mutation.

By querying this entity with the productOperation query using the ID that was returned when the product was duplicated, this can be used to check the status of an operation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the original product.

The newProduct field provides the details of the new duplicate of the product.

The userErrors field provides mutation errors that occurred during the operation.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to newProductnewProduct •Product: The newly created duplicate of the original product.
Anchor to productproduct •Product: The product on which the operation is being performed.
Anchor to statusstatus •ProductOperationStatus! non-null: The status of this operation.
Anchor to userErrorsuserErrors •[UserError!]! non-null: Returns mutation errors occurred during background mutation processing.

Anchor to ProductFeed ProductFeed

•OBJECT

A product feed.

Anchor to countrycountry •CountryCode: The country of the product feed.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to languagelanguage •LanguageCode: The language of the product feed.
Anchor to statusstatus •ProductFeedStatus! non-null: The status of the product feed.

Anchor to ProductOption ProductOption

•OBJECT

The product property names. For example, "Size", "Color", and "Material". Variants are selected based on permutations of these options. The limit for each product property name is 255 characters.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to linkedMetafieldlinkedMetafield •LinkedMetafield: The metafield identifier linked to this option.
Anchor to namename •String! non-null: The product option’s name.
Anchor to optionValuesoptionValues •[ProductOptionValue!]! non-null: Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.
Anchor to positionposition •Int! non-null: The product option's position.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to valuesvalues •[String!]! non-null: The corresponding value to the product option name.

Anchor to ProductOptionValue ProductOptionValue

•OBJECT

The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option.

Anchor to hasVariantshasVariants •Boolean! non-null: Whether the product option value has any linked variants.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to linkedMetafieldValuelinkedMetafieldValue •String: The value of the linked metafield.
Anchor to namename •String! non-null: The name of the product option value.
Anchor to swatchswatch •ProductOptionValueSwatch: The swatch associated with the product option value.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.

Anchor to ProductSetOperation ProductSetOperation

•OBJECT

An entity that represents details of an asynchronous ProductSet mutation.

By querying this entity with the productOperation query using the ID that was returned when the product was created or updated, this can be used to check the status of an operation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the created or updated product.

The userErrors field provides mutation errors that occurred during the operation.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to productproduct •Product: The product on which the operation is being performed.
Anchor to statusstatus •ProductOperationStatus! non-null: The status of this operation.
Anchor to userErrorsuserErrors •[ProductSetUserError!]! non-null: Returns mutation errors occurred during background mutation processing.

Anchor to ProductTaxonomyNode ProductTaxonomyNode

•OBJECT

Represents a Shopify product taxonomy node.

Anchor to fullNamefullName •String! non-null: The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.
Anchor to idid •ID! non-null: The ID of the product taxonomy node.
Anchor to isLeafisLeaf •Boolean! non-null: Whether the node is a leaf node.
Anchor to isRootisRoot •Boolean! non-null: Whether the node is a root node.
Anchor to namename •String! non-null: The name of the product taxonomy node. For example, Dog Beds.

Anchor to ProductVariant ProductVariant

•OBJECT

The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

Tracking inventory for each variant
Setting unique prices for each variant
Assigning barcodes and SKUs to connect variants to fulfillment services
Attaching variant-specific images and media
Setting delivery and tax requirements
Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

InventoryItem: Used for inventory tracking
Image: Used for variant-specific images
SellingPlanGroup: Used for subscriptions and selling plans

Learn more about Shopify's product model.

Anchor to availableForSaleavailableForSale •Boolean! non-null: Whether the product variant is available for sale.
Anchor to barcodebarcode •String: The value of the barcode associated with the product.
Anchor to compareAtPricecompareAtPrice •Money: The compare-at price of the variant in the default shop currency.
Anchor to contextualPricingcontextualPricing •ProductVariantContextualPricing! non-null: The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the variant was created.
Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to deliveryProfiledeliveryProfile •DeliveryProfile: The delivery profile for the variant.
Anchor to displayNamedisplayName •String! non-null: Display name of the variant, based on product's title + variant's title.
Anchor to eventsevents •EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The featured image for the variant.
Anchor to inventoryIteminventoryItem •InventoryItem! non-null: The inventory item, which is used to query for inventory information.
Anchor to inventoryPolicyinventoryPolicy •ProductVariantInventoryPolicy! non-null: Whether customers are allowed to place an order for the product variant when it's out of stock.
Anchor to inventoryQuantityinventoryQuantity •Int: The total sellable quantity of the variant.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to mediamedia •MediaConnection! non-null: The media associated with the product variant.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to positionposition •Int! non-null: The order of the product variant in the list of product variants. The first position in the list is 1.
Anchor to priceprice •Money! non-null: The price of the product variant in the default shop currency.
Anchor to productproduct •Product! non-null: The product that this variant belongs to.
Anchor to productVariantComponentsproductVariantComponents •ProductVariantComponentConnection! non-null: A list of the product variant components.
Anchor to requiresComponentsrequiresComponents •Boolean! non-null: Whether a product variant requires components. The default value is false. If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.
Anchor to selectedOptionsselectedOptions •[SelectedOption!]! non-null: List of product options applied to the variant.
Anchor to sellableOnlineQuantitysellableOnlineQuantity •Int! non-null: The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.
Anchor to sellingPlanGroupssellingPlanGroups •SellingPlanGroupConnection! non-null: A list of all selling plan groups defined in the current shop associated with the product variant.
Anchor to sellingPlanGroupsCountsellingPlanGroupsCount •Count: Count of selling plan groups associated with the product variant.
Anchor to skusku •String: A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
Anchor to taxabletaxable •Boolean! non-null: Whether a tax is charged when the product variant is sold.
Anchor to titletitle •String! non-null: The title of the product variant.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to unitPriceMeasurementunitPriceMeasurement •UnitPriceMeasurement: The unit price measurement for the variant.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the product variant was last modified.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to presentmentPricespresentmentPrices •ProductVariantPricePairConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount •Int! non-nullDeprecated
Anchor to storefrontIdstorefrontId •StorefrontID! non-nullDeprecated
Anchor to taxCodetaxCode •String Deprecated

Anchor to ProductVariantComponent ProductVariantComponent

•OBJECT

A product variant component that is included within a bundle.

These are the individual product variants that make up a bundle product, where each component has a specific required quantity.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to productVariantproductVariant •ProductVariant! non-null: The product variant associated with the component.
Anchor to quantityquantity •Int! non-null: The required quantity of the component.

Anchor to Publication Publication

•OBJECT

A publication is a group of products and collections that is published to an app.

Anchor to autoPublishautoPublish

non-null

Whether new products are automatically published to this publication.

Anchor to catalogcatalog

•Catalog

The catalog associated with the publication.

Anchor to collectionPublicationsV3collectionPublicationsV3

non-null

The list of collection publication records, each representing the publication status and details for a collection published to this publication (typically channel).

Anchor to collectionscollections

•CollectionConnection!

non-null

The list of collections published to the publication.

Anchor to hasCollectionhasCollection

non-null

Whether the collection is available to the publication.

Anchor to idid •ID! required: Collection ID to check.

•ID!

non-null

A globally-unique ID.

Anchor to operationoperation

•PublicationOperation

A background operation associated with this publication.

Anchor to productPublicationsV3productPublicationsV3

non-null

The product publications for the list of products published to the publication.

Anchor to productsproducts

non-null

The list of products published to the publication.

Anchor to supportsFuturePublishingsupportsFuturePublishing

non-null

Whether the publication supports future publishing.

Anchor to appapp

•App!

non-nullDeprecated

Anchor to PublicationResourceOperation PublicationResourceOperation

non-nullDeprecated

•OBJECT

A bulk update operation on a publication.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to processedRowCountprocessedRowCount •Int: The count of processed rows, summing imported, failed, and skipped rows.
Anchor to rowCountrowCount •RowCount: Represents a rows objects within this background operation.
Anchor to statusstatus •ResourceOperationStatus! non-null: The status of this operation.

Anchor to QuantityPriceBreak QuantityPriceBreak

•OBJECT

Quantity price breaks lets you offer different rates that are based on the amount of a specific variant being ordered.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to minimumQuantityminimumQuantity •Int! non-null: Minimum quantity required to reach new quantity break price.
Anchor to priceprice •MoneyV2! non-null: The price of variant after reaching the minimum quanity.
Anchor to priceListpriceList •PriceList! non-null: The price list associated with this quantity break.
Anchor to variantvariant •ProductVariant! non-null: The product variant associated with this quantity break.

Anchor to Refund Refund

•OBJECT

The Refund object represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues.

The Refund object provides information to:

Process customer returns and issue payments back to customers
Handle partial or full refunds for line items with optional inventory restocking
Refund shipping costs, duties, and additional fees
Issue store credit refunds as an alternative to original payment method returns
Track and reconcile all financial transactions related to refunds

Each Refund object maintains detailed records of what was refunded, how much was refunded, which payment transactions were involved, and any inventory restocking that occurred. The refund can include multiple components such as product line items, shipping charges, taxes, duties, and additional fees, all calculated with proper currency handling for international orders.

Refunds are always associated with an order and can optionally be linked to a return if the refund was initiated through the returns process. The refund tracks both the presentment currency (what the customer sees) and the shop currency for accurate financial reporting.

Note

The existence of a Refund object doesn't guarantee that the money has been returned to the customer. The actual financial processing happens through associated OrderTransaction objects, which can be in various states, such as pending, processing, success, or failure. To determine if money has actually been refunded, check the status of the associated transactions.

Learn more about managing returns, refunding duties, and processing refunds.

Anchor to createdAtcreatedAt •DateTime: The date and time when the refund was created.
Anchor to dutiesduties •[RefundDuty!]: A list of the refunded duties as part of this refund.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to notenote •String: The optional note associated with the refund.
Anchor to orderorder •Order! non-null: The order associated with the refund.
Anchor to orderAdjustmentsorderAdjustments •OrderAdjustmentConnection! non-null: The order adjustments that are attached with the refund.
Anchor to refundLineItemsrefundLineItems •RefundLineItemConnection! non-null: The RefundLineItem resources attached to the refund.
Anchor to refundShippingLinesrefundShippingLines •RefundShippingLineConnection! non-null: The RefundShippingLine resources attached to the refund.
Anchor to returnreturn •Return: The return associated with the refund.
Anchor to staffMemberstaffMember •StaffMember: The staff member who created the refund.
Anchor to totalRefundedSettotalRefundedSet •MoneyBag! non-null: The total amount across all transactions for the refund, in shop and presentment currencies.
Anchor to transactionstransactions •OrderTransactionConnection! non-null: The transactions associated with the refund.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the refund was updated.
Anchor to totalRefundedtotalRefunded •MoneyV2! non-nullDeprecated

Anchor to RefundShippingLine RefundShippingLine

•OBJECT

A shipping line item that's included in a refund.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to shippingLineshippingLine •ShippingLine! non-null: The ShippingLine resource associated to the refunded shipping line item.
Anchor to subtotalAmountSetsubtotalAmountSet •MoneyBag! non-null: The subtotal amount of the refund shipping line in shop and presentment currencies.
Anchor to taxAmountSettaxAmountSet •MoneyBag! non-null: The tax amount of the refund shipping line in shop and presentment currencies.

Anchor to Return Return

•OBJECT

The Return object represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location. A return is associated with an order and can include multiple return line items. Each return has a status, which indicates the state of the return.

Use the Return object to capture the financial, logistical, and business intent of a return. For example, you can identify eligible items for a return and issue customers a refund for returned items on behalf of the merchant.

Learn more about providing a return management workflow for merchants. You can also manage exchanges, reverse fulfillment orders, and reverse deliveries on behalf of merchants.

Anchor to declinedecline •ReturnDecline: Additional information about the declined return.
Anchor to exchangeLineItemsexchangeLineItems •ExchangeLineItemConnection! non-null: The exchange line items attached to the return.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the return.
Anchor to orderorder •Order! non-null: The order that the return belongs to.
Anchor to refundsrefunds •RefundConnection! non-null: The list of refunds associated with the return.
Anchor to returnLineItemsreturnLineItems •ReturnLineItemTypeConnection! non-null: The return line items attached to the return.
Anchor to returnShippingFeesreturnShippingFees •[ReturnShippingFee!]! non-null: The return shipping fees for the return.
Anchor to reverseFulfillmentOrdersreverseFulfillmentOrders •ReverseFulfillmentOrderConnection! non-null: The list of reverse fulfillment orders for the return.
Anchor to statusstatus •ReturnStatus! non-null: The status of the return.
Anchor to totalQuantitytotalQuantity •Int! non-null: The sum of all return line item quantities for the return.
Anchor to suggestedRefundsuggestedRefund •SuggestedReturnRefund Deprecated

Anchor to ReturnableFulfillment ReturnableFulfillment

•OBJECT

A returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant.

Anchor to fulfillmentfulfillment •Fulfillment! non-null: The fulfillment that the returnable fulfillment refers to.
Anchor to idid •ID! non-null: The unique ID of the Returnable Fulfillment.
Anchor to returnableFulfillmentLineItemsreturnableFulfillmentLineItems •ReturnableFulfillmentLineItemConnection! non-null: The list of returnable fulfillment line items.

Anchor to ReturnLineItem ReturnLineItem

•OBJECT

A return line item.

Anchor to customerNotecustomerNote •String: A note from the customer that describes the item to be returned. Maximum length: 300 characters.
Anchor to fulfillmentLineItemfulfillmentLineItem •FulfillmentLineItem! non-null: The fulfillment line item from which items are returned.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to quantityquantity •Int! non-null: The quantity being returned.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The quantity that can be refunded.
Anchor to refundedQuantityrefundedQuantity •Int! non-null: The quantity that was refunded.
Anchor to restockingFeerestockingFee •RestockingFee: The restocking fee for the return line item.
Anchor to returnReasonreturnReason •ReturnReason! non-null: The reason for returning the item.
Anchor to returnReasonNotereturnReasonNote •String! non-null: Additional information about the reason for the return. Maximum length: 255 characters.
Anchor to totalWeighttotalWeight •Weight: The total weight of the item.
Anchor to withCodeDiscountedTotalPriceSetwithCodeDiscountedTotalPriceSet •MoneyBag! non-null: The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied.

Anchor to ReverseDelivery ReverseDelivery

•OBJECT

A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. For example, a buyer requests a return, and a merchant sends the buyer a shipping label. The reverse delivery contains the context of the items sent back, how they're being sent back (for example, a shipping label), and the current state of the delivery (tracking information).

Anchor to deliverabledeliverable •ReverseDeliveryDeliverable: The deliverable associated with the reverse delivery.
Anchor to idid •ID! non-null: The ID of the reverse delivery.
Anchor to reverseDeliveryLineItemsreverseDeliveryLineItems •ReverseDeliveryLineItemConnection! non-null: The reverse delivery line items attached to the reverse delivery.
Anchor to reverseFulfillmentOrderreverseFulfillmentOrder •ReverseFulfillmentOrder! non-null: The ReverseFulfillmentOrder associated with the reverse delivery.

Anchor to ReverseDeliveryLineItem ReverseDeliveryLineItem

•OBJECT

The details about a reverse delivery line item.

Anchor to dispositionsdispositions •[ReverseFulfillmentOrderDisposition!]! non-null: The dispositions of the item.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to quantityquantity •Int! non-null: The expected number of units.
Anchor to reverseFulfillmentOrderLineItemreverseFulfillmentOrderLineItem •ReverseFulfillmentOrderLineItem! non-null: The corresponding reverse fulfillment order line item.

Anchor to ReverseFulfillmentOrder ReverseFulfillmentOrder

•OBJECT

A group of one or more items in a return that will be processed at a fulfillment service. There can be more than one reverse fulfillment order for a return at a given location.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lineItemslineItems •ReverseFulfillmentOrderLineItemConnection! non-null: The list of reverse fulfillment order line items for the reverse fulfillment order.
Anchor to reverseDeliveriesreverseDeliveries •ReverseDeliveryConnection! non-null: The list of reverse deliveries for the reverse fulfillment order.
Anchor to statusstatus •ReverseFulfillmentOrderStatus! non-null: The status of the reverse fulfillment order.
Anchor to thirdPartyConfirmationthirdPartyConfirmation •ReverseFulfillmentOrderThirdPartyConfirmation: The current confirmation for the reverse fulfillment order from a third-party logistics service. If no third-party service is involved, then this value is nil.
Anchor to orderorder •Order! non-nullDeprecated

Anchor to ReverseFulfillmentOrderDisposition ReverseFulfillmentOrderDisposition

•OBJECT

The details of the arrangement of an item.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to locationlocation •Location: The location where the disposition occurred.
Anchor to quantityquantity •Int! non-null: The number of disposed units.
Anchor to typetype •ReverseFulfillmentOrderDispositionType! non-null: The final arrangement of an item.

Anchor to ReverseFulfillmentOrderLineItem ReverseFulfillmentOrderLineItem

•OBJECT

The details about a reverse fulfillment order line item.

Anchor to dispositionsdispositions •[ReverseFulfillmentOrderDisposition!]! non-null: The dispositions of the item.
Anchor to fulfillmentLineItemfulfillmentLineItem •FulfillmentLineItem: The corresponding fulfillment line item for a reverse fulfillment order line item.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to totalQuantitytotalQuantity •Int! non-null: The total number of units to be processed.

Anchor to SaleAdditionalFee SaleAdditionalFee

•OBJECT

The additional fee details for a line item.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the additional fee.
Anchor to priceprice •MoneyBag! non-null: The price of the additional fee.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: A list of taxes charged on the additional fee.

Anchor to SavedSearch SavedSearch

•OBJECT

A saved search is a representation of a search query saved in the admin.

Anchor to filtersfilters •[SearchFilter!]! non-null: The filters of a saved search.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to namename •String! non-null: The name of a saved search.
Anchor to queryquery •String! non-null: The query string of a saved search. This includes search terms and filters.
Anchor to resourceTyperesourceType •SearchResultType! non-null: The type of resource this saved search is searching in.
Anchor to searchTermssearchTerms •String! non-null: The search terms of a saved search.

Anchor to ScriptTag ScriptTag

•OBJECT

Theme app extensions

If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. Learn more.

Script tag deprecation

Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.

A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the Order status page of checkout.

Anchor to cachecache •Boolean! non-null: Whether the Shopify CDN can cache and serve the script tag. If true, then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If false, then the script will be served as is.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the script tag was created.
Anchor to displayScopedisplayScope •ScriptTagDisplayScope! non-null: The page or pages on the online store that the script should be included.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to srcsrc •URL! non-null: The URL to the remote script.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the script tag was last updated.

Anchor to Segment Segment

•OBJECT

A dynamic collection of customers based on specific criteria.

Anchor to creationDatecreationDate •DateTime! non-null: The date and time when the segment was added to the store.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lastEditDatelastEditDate •DateTime! non-null: The date and time when the segment was last updated.
Anchor to namename •String! non-null: The name of the segment.
Anchor to queryquery •String! non-null: A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.

Anchor to SellingPlan SellingPlan

•OBJECT

Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

For more information on selling plans, refer to Creating and managing selling plans.

Anchor to billingPolicybillingPolicy •SellingPlanBillingPolicy! non-null: A selling plan policy which describes the recurring billing details.
Anchor to categorycategory •SellingPlanCategory: The category used to classify the selling plan for reporting purposes.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the selling plan was created.
Anchor to deliveryPolicydeliveryPolicy •SellingPlanDeliveryPolicy! non-null: A selling plan policy which describes the delivery details.
Anchor to descriptiondescription •String: Buyer facing string which describes the selling plan commitment.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inventoryPolicyinventoryPolicy •SellingPlanInventoryPolicy: When to reserve inventory for a selling plan.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String! non-null: A customer-facing description of the selling plan.

If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.
Anchor to optionsoptions •[String!]! non-null: The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
Anchor to positionposition •Int: Relative position of the selling plan for display. A lower position will be displayed before a higher position.
Anchor to pricingPoliciespricingPolicies •[SellingPlanPricingPolicy!]! non-null: Selling plan pricing details.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated

Anchor to SellingPlanGroup SellingPlanGroup

•OBJECT

Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

Anchor to appIdappId

•String

The ID for app, exposed in Liquid and product JSON.

Anchor to appliesToProductappliesToProduct

non-null

Whether the given product is directly associated to the selling plan group.

Anchor to productIdproductId •ID! required: The ID of the product.

Anchor to appliesToProductVariantappliesToProductVariant

non-null

Whether the given product variant is directly associated to the selling plan group.

Anchor to productVariantIdproductVariantId •ID! required: The ID of the product.

Anchor to appliesToProductVariantsappliesToProductVariants

non-null

Whether any of the product variants of the given product are associated to the selling plan group.

Anchor to productIdproductId •ID! required: The ID of the product.

Anchor to createdAtcreatedAt

non-null

The date and time when the selling plan group was created.

Anchor to descriptiondescription

•String

The merchant-facing description of the selling plan group.

•ID!

non-null

A globally-unique ID.

Anchor to merchantCodemerchantCode

non-null

The merchant-facing label of the selling plan group.

non-null

The buyer-facing label of the selling plan group.

Anchor to optionsoptions

non-null

The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

Anchor to positionposition

•Int

The relative position of the selling plan group for display.

Anchor to productsproducts

Anchor to ServerPixel ServerPixel

non-null

Products associated to the selling plan group.

Anchor to productsCountproductsCount

•Count

A count of products associated to the selling plan group.

Anchor to productVariantsproductVariants

•ProductVariantConnection!

non-null

Product variants associated to the selling plan group.

Anchor to productVariantsCountproductVariantsCount

•Count

A count of product variants associated to the selling plan group.

Anchor to sellingPlanssellingPlans

•SellingPlanConnection!

non-null

Selling plans associated to the selling plan group.

Anchor to summarysummary

•String

A summary of the policies associated to the selling plan group.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

•OBJECT

A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to statusstatus •ServerPixelStatus: The current state of this server pixel.
Anchor to webhookEndpointAddresswebhookEndpointAddress •String: Address of the EventBridge or PubSub endpoint.

Anchor to Shop Shop

•OBJECT

Represents a collection of general settings and information about the shop.

Anchor to accountOwneraccountOwner •StaffMember! non-null: Account owner information.
Anchor to alertsalerts •[ShopAlert!]! non-null: A list of the shop's active alert messages that appear in the Shopify admin.
Anchor to allProductCategoriesListallProductCategoriesList •[TaxonomyCategory!]! non-null: A list of the shop's product categories. Limit: 1000 product categories.
Anchor to availableChannelAppsavailableChannelApps •AppConnection! non-null: The list of sales channels not currently installed on the shop.
Anchor to billingAddressbillingAddress •ShopAddress! non-null: The shop's billing address information.
Anchor to channelDefinitionsForInstalledChannelschannelDefinitionsForInstalledChannels •[AvailableChannelDefinitionsByChannel!]! non-null: List of all channel definitions associated with a shop.
Anchor to checkoutApiSupportedcheckoutApiSupported •Boolean! non-null: Specifies whether the shop supports checkouts via Checkout API.
Anchor to contactEmailcontactEmail •String! non-null: The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
Anchor to countriesInShippingZonescountriesInShippingZones •CountriesInShippingZones! non-null: Countries that have been defined in shipping zones for the shop.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the shop was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The three letter code for the currency that the shop sells in.
Anchor to currencyFormatscurrencyFormats •CurrencyFormats! non-null: How currencies are displayed on your store.
Anchor to currencySettingscurrencySettings •CurrencySettingConnection! non-null: The presentment currency settings for the shop excluding the shop's own currency.
Anchor to customerAccountscustomerAccounts •ShopCustomerAccountsSetting! non-null: Whether customer accounts are required, optional, or disabled for the shop.
Anchor to customerAccountsV2customerAccountsV2 •CustomerAccountsV2! non-null: Information about the shop's customer accounts.
Anchor to customerTagscustomerTags •StringConnection! non-null: A list of tags that have been added to customer accounts.
Anchor to descriptiondescription •String: The shop's meta description used in search engine results.
Anchor to draftOrderTagsdraftOrderTags •StringConnection! non-null: A list of tags that have been added to draft orders.
Anchor to emailemail •String! non-null: The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
Anchor to enabledPresentmentCurrenciesenabledPresentmentCurrencies •[CurrencyCode!]! non-null: The presentment currencies enabled for the shop.
Anchor to featuresfeatures •ShopFeatures! non-null: The set of features enabled for the shop.
Anchor to fulfillmentServicesfulfillmentServices •[FulfillmentService!]! non-null: List of the shop's installed fulfillment services.
Anchor to ianaTimezoneianaTimezone •String! non-null: The shop's time zone as defined by the IANA.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to marketingSmsConsentEnabledAtCheckoutmarketingSmsConsentEnabledAtCheckout •Boolean! non-null: Whether SMS marketing has been enabled on the shop's checkout configuration settings.
Anchor to merchantApprovalSignalsmerchantApprovalSignals •MerchantApprovalSignals: The approval signals for a shop to support onboarding to channel apps.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to myshopifyDomainmyshopifyDomain •String! non-null: The shop's .myshopify.com domain name.
Anchor to namename •String! non-null: The shop's name.
Anchor to navigationSettingsnavigationSettings •[NavigationItem!]! non-null: The shop's settings related to navigation.
Anchor to orderNumberFormatPrefixorderNumberFormatPrefix •String! non-null: The prefix that appears before order numbers.
Anchor to orderNumberFormatSuffixorderNumberFormatSuffix •String! non-null: The suffix that appears after order numbers.
Anchor to orderTagsorderTags •StringConnection! non-null: A list of tags that have been added to orders.
Anchor to paymentSettingspaymentSettings •PaymentSettings! non-null: The shop's settings related to payments.
Anchor to planplan •ShopPlan! non-null: The shop's billing plan.
Anchor to primaryDomainprimaryDomain •Domain! non-null: The primary domain of the shop's online store.
Anchor to resourceLimitsresourceLimits •ShopResourceLimits! non-null: The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.
Anchor to richTextEditorUrlrichTextEditorUrl •URL! non-null: The URL of the rich text editor that can be used for mobile devices.
Anchor to searchsearch •SearchResultConnection! non-null: Fetches a list of admin search results by a specified query.
Anchor to searchFilterssearchFilters •SearchFilterOptions! non-null: The list of search filter options for the shop. These can be used to filter productvisibility for the shop.
Anchor to setupRequiredsetupRequired •Boolean! non-null: Whether the shop has outstanding setup steps.
Anchor to shipsToCountriesshipsToCountries •[CountryCode!]! non-null: The list of countries that the shop ships to.
Anchor to shopOwnerNameshopOwnerName •String! non-null: The name of the shop owner.
Anchor to shopPoliciesshopPolicies •[ShopPolicy!]! non-null: The list of all legal policies associated with a shop.
Anchor to storefrontAccessTokensstorefrontAccessTokens •StorefrontAccessTokenConnection! non-null: The storefront access token of a private application. These are scoped per-application.
Anchor to taxesIncludedtaxesIncluded •Boolean! non-null: Whether applicable taxes are included in the shop's product prices.
Anchor to taxShippingtaxShipping •Boolean! non-null: Whether the shop charges taxes for shipping.
Anchor to timezoneAbbreviationtimezoneAbbreviation •String! non-null: The shop's time zone abbreviation.
Anchor to timezoneOffsettimezoneOffset •String! non-null: The shop's time zone offset.
Anchor to timezoneOffsetMinutestimezoneOffsetMinutes •Int! non-null: The shop's time zone offset expressed as a number of minutes.
Anchor to transactionalSmsDisabledtransactionalSmsDisabled •Boolean! non-null: Whether transactional SMS sent by Shopify have been disabled for a shop.
Anchor to translationstranslations •[Translation!]! non-null: The published translations associated with the resource.
Anchor to unitSystemunitSystem •UnitSystem! non-null: The shop's unit system for weights and measures.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time when the shop was last updated.
Anchor to urlurl •URL! non-null: The URL of the shop's online store.
Anchor to weightUnitweightUnit •WeightUnit! non-null: The shop's primary unit of weight for products and shipping.
Anchor to allProductCategoriesallProductCategories •[ProductCategory!]! non-nullDeprecated
Anchor to analyticsTokenanalyticsToken •String! non-nullDeprecated
Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders •FulfillmentOrderConnection! non-nullDeprecated
Anchor to channelschannels •ChannelConnection! non-nullDeprecated
Anchor to collectionByHandlecollectionByHandle •Collection Deprecated
Anchor to collectionscollections •CollectionConnection! non-nullDeprecated
Anchor to collectionSavedSearchescollectionSavedSearches •SavedSearchConnection! non-nullDeprecated
Anchor to customerscustomers •CustomerConnection! non-nullDeprecated
Anchor to customerSavedSearchescustomerSavedSearches •SavedSearchConnection! non-nullDeprecated
Anchor to domainsdomains •[Domain!]! non-nullDeprecated
Anchor to draftOrdersdraftOrders •DraftOrderConnection! non-nullDeprecated
Anchor to draftOrderSavedSearchesdraftOrderSavedSearches •SavedSearchConnection! non-nullDeprecated
Anchor to fulfillmentOrdersfulfillmentOrders •FulfillmentOrderConnection! non-nullDeprecated
Anchor to inventoryItemsinventoryItems •InventoryItemConnection! non-nullDeprecated
Anchor to limitedPendingOrderCountlimitedPendingOrderCount •LimitedPendingOrderCount! non-nullDeprecated
Anchor to locationslocations •LocationConnection! non-nullDeprecated
Anchor to marketingEventsmarketingEvents •MarketingEventConnection! non-nullDeprecated
Anchor to ordersorders •OrderConnection! non-nullDeprecated
Anchor to orderSavedSearchesorderSavedSearches •SavedSearchConnection! non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafield Deprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection! non-nullDeprecated
Anchor to productByHandleproductByHandle •Product Deprecated
Anchor to productImagesproductImages •ImageConnection! non-nullDeprecated
Anchor to productsproducts •ProductConnection! non-nullDeprecated
Anchor to productSavedSearchesproductSavedSearches •SavedSearchConnection! non-nullDeprecated
Anchor to productTagsproductTags •StringConnection! non-nullDeprecated
Anchor to productTypesproductTypes •StringConnection! non-nullDeprecated
Anchor to productVariantsproductVariants •ProductVariantConnection! non-nullDeprecated
Anchor to productVendorsproductVendors •StringConnection! non-nullDeprecated
Anchor to publicationCountpublicationCount •Int! non-nullDeprecated
Anchor to staffMembersstaffMembers •StaffMemberConnection! non-nullDeprecated
Anchor to storefrontUrlstorefrontUrl •URL! non-nullDeprecated
Anchor to uploadedImagesByIdsuploadedImagesByIds •[Image!]! non-nullDeprecated

Anchor to ShopAddress ShopAddress

•OBJECT

An address for a shop.

Anchor to address1address1

•String

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

Anchor to address2address2

•String

The second line of the address. Typically the number of the apartment, suite, or unit.

Anchor to citycity

•String

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

Anchor to companycompany

•String

The name of the company or organization.

Anchor to coordinatesValidatedcoordinatesValidated

non-null

Whether the address coordinates are valid.

Anchor to countrycountry

•String

The name of the country.

Anchor to countryCodeV2countryCodeV2

•CountryCode

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

For example, US.

Anchor to formattedformatted

non-null

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

Anchor to withCompanywithCompany •Boolean Default:true: Whether to include the company in the formatted address.

Anchor to formattedAreaformattedArea

•String

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

•ID!

non-null

A globally-unique ID.

Anchor to latitudelatitude

•Float

The latitude coordinate of the address.

Anchor to longitudelongitude

•Float

The longitude coordinate of the address.

•String

A phone number associated with the address.

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

Anchor to provinceprovince

•String

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

Anchor to provinceCodeprovinceCode

•String

The alphanumeric code for the region.

For example, ON.

Anchor to zipzip

•String

The zip or postal code of the address.

Anchor to countryCodecountryCode

•String

Deprecated

Anchor to firstNamefirstName

•String

Deprecated

Anchor to lastNamelastName

•String

Deprecated