Node

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.

name

•ResourcePublicationConnection!

non-null

The name of the channel.

productPublicationsV3

non-null

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

products

•ProductConnection!

non-null

The list of products published to the channel.

productsCount

•Count

The count of products published to the channel. Limited to a maximum of 10000 by default.

supportsFuturePublishing

non-null

Whether the channel supports future publishing.

handle

•ProductPublicationConnection!

non-nullDeprecated

navigationItems

•[NavigationItem!]!

non-nullDeprecated

overviewPath

•URL

Deprecated

productPublications

non-nullDeprecated

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

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.

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.

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.

availablePublicationsCount

•Count

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

description

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.

descriptionHtml

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

events

•EventConnection!

non-null

The paginated list of events associated with the host subject.

feedback

•ResourceFeedback

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

handle

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.

hasProduct

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.

image

•Image

The image associated with the collection.

legacyResourceId

•UnsignedInt64!

non-null

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

metafield

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

metafields

•MetafieldConnection!

non-null

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

products

•ProductConnection!

non-null

The products that are included in the collection.

productsCount

•Count

The number of products in the collection.

publishedOnCurrentPublication

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.

publishedOnPublication

•ResourcePublicationConnection!

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

resourcePublications

non-null

The list of resources that are published to a publication.

resourcePublicationsCount

•Count

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

resourcePublicationsV2

•ResourcePublicationV2Connection!

non-null

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

ruleSet

•CollectionRuleSet

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

seo

•SEO!

non-null

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

sortOrder

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

templateSuffix

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

title

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.

translations

•[Translation!]!

non-null

The published translations associated with the resource.

unpublishedPublications

•PublicationConnection!

non-null

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

updatedAt

•MetafieldDefinitionConnection!

non-null

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

metafieldDefinitions

non-nullDeprecated

privateMetafield

•PrivateMetafield

Deprecated

privateMetafields

•PrivateMetafieldConnection!

non-nullDeprecated

publicationCount

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

publications

•CollectionPublicationConnection!

non-nullDeprecated

publishedOnChannel

non-nullDeprecated

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

publishedOnCurrentChannel

non-nullDeprecated

storefrontId

•StorefrontID!

non-nullDeprecated

unpublishedChannels

•ChannelConnection!

non-nullDeprecated

Comment

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

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.

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

CompanyAddress

•OBJECT

Represents a billing or shipping address for a company location.

address1

non-null

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

address2

•String

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

city

•String

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

companyName

non-null

The name of the company.

country

•String

The name of the country.

countryCode

•CountryCode!

non-null

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

createdAt

non-null

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

firstName

•String

The first name of the recipient.

formattedAddress

•[String!]!

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.

formattedArea

•String

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

•ID!

non-null

A globally-unique ID.

lastName

•String

The last name of the recipient.

phone

•String

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

province

•String

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

recipient

•String

The identity of the recipient e.g. 'Receiving Department'.

updatedAt

CompanyContactRoleAssignment

non-null

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

zip

•String

The zip or postal code of the address.

zoneCode

•String

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

CompanyContact

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

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.

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

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.

billingAddress

•CompanyAddress

The address used as billing address for the location.

buyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

catalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

catalogsCount

•Count

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

company

•Company!

non-null

The company that the company location belongs to.

createdAt

non-null

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

currency

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

defaultCursor

non-null

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

draftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

events

•EventConnection!

non-null

The paginated list of events associated with the host subject.

externalId

•String

A unique externally-supplied ID for the company location.

hasTimelineComment

non-null

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

•ID!

non-null

A globally-unique ID.

inCatalog

non-null

Whether the company location is assigned a specific catalog.

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

locale

•String

The preferred locale of the company location.

market

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

metafield

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

metafields

•MetafieldConnection!

non-null

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

name

•CompanyContactRoleAssignmentConnection!

non-null

The name of the company location.

note

•String

A note about the company location.

orders

•OrderConnection!

non-null

The list of orders for the company location.

ordersCount

•Count

The total number of orders placed for the location.

phone

•String

The phone number of the company location.

roleAssignments

non-null

The list of roles assigned to the company location.

shippingAddress

•CompanyAddress

The address used as shipping address for the location.

staffMemberAssignments

•CompanyLocationStaffMemberAssignmentConnection!

non-null

The list of staff members assigned to the company location.

totalSpent

•MoneyV2!

non-null

The total amount spent by the location.

updatedAt

•MetafieldDefinitionConnection!

non-null

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

metafieldDefinitions

non-nullDeprecated

orderCount

•Int!

non-nullDeprecated

privateMetafield

•PrivateMetafield

Deprecated

privateMetafields

•PrivateMetafieldConnection!

non-nullDeprecated

taxExemptions

•[TaxExemption!]!

non-nullDeprecated

taxRegistrationId

•String

Deprecated

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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

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

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

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

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.

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

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

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

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.

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.

ExchangeLineItem

•OBJECT

An item for exchange.

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

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

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.

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

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.

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

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

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.

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.

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

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.

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.

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.

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

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

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.

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.

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.

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: Quantities for the requested names.
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.

InventoryQuantity

•OBJECT

Represents a quantity of an inventory item at a specific location, for a specific name.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name that identifies the inventory quantity.
Anchor to quantityquantity •Int! non-null: The quantity for the quantity name.
Anchor to updatedAtupdatedAt •DateTime: When the quantity was last updated.

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

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.

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

MailingAddress

•OBJECT

Represents a customer mailing address.

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

address1

•String

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

address2

•String

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

city

•String

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

company

•String

The name of the customer's company or organization.

coordinatesValidated

•MailingAddressValidationResult

non-null

Whether the address corresponds to recognized latitude and longitude values.

country

•String

The name of the country.

countryCodeV2

•CountryCode

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

For example, US.

firstName

•String

The first name of the customer.

formatted

•[String!]!

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.

formattedArea

•String

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

•ID!

non-null

A globally-unique ID.

lastName

•String

The last name of the customer.

latitude

•Float

The latitude coordinate of the customer address.

longitude

•Float

The longitude coordinate of the customer address.

name

•String

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

phone

•String

A unique phone number for the customer.

province

•String

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

provinceCode

•String

The alphanumeric code for the region.

For example, ON.

timeZone

•String

The time zone of the address.

validationResultSummary

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.

zip

•String

The zip or postal code of the address.

countryCode

•String

Deprecated

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

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.

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

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

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.

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.

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.

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

MetafieldDefinition

•OBJECT

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

access

•MetafieldAccess!

non-null

The access settings associated with the metafield definition.

capabilities

•MetafieldCapabilities!

non-null

The capabilities of the metafield definition.

constraints

•MetafieldDefinitionConstraints

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

description

•String

The description of the metafield definition.

•ID!

non-null

A globally-unique ID.

key

non-null

The unique identifier for the metafield definition within its namespace.

metafields

•MetafieldConnection!

non-null

The metafields that belong to the metafield definition.

metafieldsCount

•Int!

non-null

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

Anchor to validationStatusvalidationStatus •MetafieldValidationStatus: The current validation status.

name

non-null

The human-readable name of the metafield definition.

namespace

•StandardMetafieldDefinitionTemplate

non-null

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

ownerType

•MetafieldOwnerType!

non-null

The resource type that the metafield definition is attached to.

pinnedPosition

•Int

The position of the metafield definition in the pinned list.

standardTemplate

The standard metafield definition template associated with the metafield definition.

type

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

useAsCollectionCondition

•[MetafieldDefinitionValidation!]!

non-null

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

validations

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.

validationStatus

•MetafieldDefinitionValidationStatus!

non-null

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

visibleToStorefrontApi