AbandonedCheckout |
A checkout that was abandoned by the customer. |
Abandonment |
A browse, cart, or checkout that was abandoned by a customer. |
AbandonmentEmailStateUpdatePayload |
Return type for abandonmentEmailStateUpdate mutation. |
AbandonmentEmailStateUpdateUserError |
An error that occurs during the execution of AbandonmentEmailStateUpdate . |
AbandonmentProductsAddedToCartArgs |
A browse, cart, or checkout that was abandoned by a customer. |
AbandonmentProductsViewedArgs |
A browse, cart, or checkout that was abandoned by a customer. |
AbandonmentUpdateActivitiesDeliveryStatusesPayload |
Return type for abandonmentUpdateActivitiesDeliveryStatuses mutation. |
AbandonmentUpdateActivitiesDeliveryStatusesUserError |
An error that occurs during the execution of AbandonmentUpdateActivitiesDeliveryStatuses . |
AccessScope |
The permission required to access a Shopify Admin API or Storefront API resource for a shop. Merchants grant access scopes that are requested by applications. |
AddAllProductsOperation |
Represents an operation publishing all products to a publication. |
AdditionalFee |
The additional fees that have been applied to the order. |
AdditionalFeeSale |
A sale associated with an additional fee charge. |
AdjustmentSale |
A sale associated with an order price adjustment. |
AllDiscountItems |
Targets all items the cart for a specified discount. |
ApiVersion |
A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, 2021-10 ). |
App |
A Shopify application. |
AppCatalog |
A catalog that defines the publication associated with an app. |
AppCatalogAppsArgs |
A catalog that defines the publication associated with an app. |
AppConnection |
An auto-generated type for paginating through multiple Apps. |
AppCredit |
App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify. |
AppCreditConnection |
An auto-generated type for paginating through multiple AppCredits. |
AppCreditEdge |
An auto-generated type which holds one AppCredit and a cursor during pagination. |
AppDiscountType |
A script that defines a discount type. |
AppEdge |
An auto-generated type which holds one App and a cursor during pagination. |
AppFeedback |
Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an app on their store. |
AppInstallation |
Represents an installed application on a shop. |
AppInstallationAllSubscriptionsArgs |
Represents an installed application on a shop. |
AppInstallationConnection |
An auto-generated type for paginating through multiple AppInstallations. |
AppInstallationCreditsArgs |
Represents an installed application on a shop. |
AppInstallationEdge |
An auto-generated type which holds one AppInstallation and a cursor during pagination. |
AppInstallationMetafieldArgs |
Represents an installed application on a shop. |
AppInstallationMetafieldsArgs |
Represents an installed application on a shop. |
AppInstallationOneTimePurchasesArgs |
Represents an installed application on a shop. |
AppInstallationPrivateMetafieldArgs |
Represents an installed application on a shop. |
AppInstallationPrivateMetafieldsArgs |
Represents an installed application on a shop. |
AppInstallationRevenueAttributionRecordsArgs |
Represents an installed application on a shop. |
AppPlanInput |
The pricing model for the app subscription. The pricing model input can be either appRecurringPricingDetails or appUsagePricingDetails . |
AppPlanV2 |
The app plan that the merchant is subscribed to. |
AppPurchase |
Services and features purchased once by the store. |
AppPurchaseOneTime |
Services and features purchased once by a store. |
AppPurchaseOneTimeConnection |
An auto-generated type for paginating through multiple AppPurchaseOneTimes. |
AppPurchaseOneTimeCreatePayload |
Return type for appPurchaseOneTimeCreate mutation. |
AppPurchaseOneTimeEdge |
An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination. |
AppRecurringPricing |
The pricing information about a subscription app. The object contains an interval (the frequency at which the shop is billed for an app subscription) and a price (the amount to be charged to the subscribing shop at each interval). |
AppRecurringPricingInput |
Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval. |
AppRevenueAttributionRecord |
Represents app revenue that was captured externally by the partner. |
AppRevenueAttributionRecordConnection |
An auto-generated type for paginating through multiple AppRevenueAttributionRecords. |
AppRevenueAttributionRecordCreateUserError |
An error that occurs during the execution of AppRevenueAttributionRecordCreate . |
AppRevenueAttributionRecordDeleteUserError |
An error that occurs during the execution of AppRevenueAttributionRecordDelete . |
AppRevenueAttributionRecordEdge |
An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination. |
AppSubscription |
Provides users access to services and/or features for a duration of time. |
AppSubscriptionCancelPayload |
Return type for appSubscriptionCancel mutation. |
AppSubscriptionConnection |
An auto-generated type for paginating through multiple AppSubscriptions. |
AppSubscriptionCreatePayload |
Return type for appSubscriptionCreate mutation. |
AppSubscriptionDiscount |
Discount applied to the recurring pricing portion of a subscription. |
AppSubscriptionDiscountAmount |
The fixed amount value of a discount. |
AppSubscriptionDiscountInput |
The input fields to specify a discount to the recurring pricing portion of a subscription over a number of billing intervals. |
AppSubscriptionDiscountPercentage |
The percentage value of a discount. |
AppSubscriptionDiscountValueInput |
The input fields to specify the value discounted every billing interval. |
AppSubscriptionEdge |
An auto-generated type which holds one AppSubscription and a cursor during pagination. |
AppSubscriptionLineItem |
The plan attached to an app subscription. |
AppSubscriptionLineItemInput |
The input fields to add more than one pricing plan to an app subscription. |
AppSubscriptionLineItemUpdatePayload |
Return type for appSubscriptionLineItemUpdate mutation. |
AppSubscriptionLineItemUsageRecordsArgs |
The plan attached to an app subscription. |
AppSubscriptionTrialExtendPayload |
Return type for appSubscriptionTrialExtend mutation. |
AppSubscriptionTrialExtendUserError |
An error that occurs during the execution of AppSubscriptionTrialExtend . |
AppUsagePricing |
Defines a usage pricing model for the app subscription. These charges are variable based on how much the merchant uses the app. |
AppUsagePricingInput |
The input fields to issue arbitrary charges for app usage associated with a subscription. |
AppUsageRecord |
Store usage for app subscriptions with usage pricing. |
AppUsageRecordConnection |
An auto-generated type for paginating through multiple AppUsageRecords. |
AppUsageRecordCreatePayload |
Return type for appUsageRecordCreate mutation. |
AppUsageRecordEdge |
An auto-generated type which holds one AppUsageRecord and a cursor during pagination. |
Attribute |
Represents a generic custom attribute. |
AttributeInput |
The input fields for an attribute. |
AutomaticDiscountApplication |
Automatic discount applications capture the intentions of a discount that was automatically applied. |
AvailableChannelDefinitionsByChannel |
Represents an object containing all information for channels available to a shop. |
BasePaymentDetails |
Generic payment details that are related to a transaction. |
BasicEvent |
Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product. |
BillingAttemptUserError |
Represents an error that happens during the execution of a billing attempt mutation. |
BulkMutationUserError |
Represents an error that happens during execution of a bulk mutation. |
BulkOperation |
<p>An asynchronous long-running operation to fetch data in bulk or to bulk import data.</p><p>Bulk operations are created using the bulkOperationRunQuery or bulkOperationRunMutation mutation. After they are created, clients should poll the status field for updates. When COMPLETED , the url field contains a link to the data in [JSONL](http://jsonlines.org/) format.</p><p>Refer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.</p> |
BulkOperationCancelPayload |
Return type for bulkOperationCancel mutation. |
BulkOperationRunMutationPayload |
Return type for bulkOperationRunMutation mutation. |
BulkOperationRunQueryPayload |
Return type for bulkOperationRunQuery mutation. |
BulkProductResourceFeedbackCreatePayload |
Return type for bulkProductResourceFeedbackCreate mutation. |
BulkProductResourceFeedbackCreateUserError |
An error that occurs during the execution of BulkProductResourceFeedbackCreate . |
BundlesFeature |
Represents the Bundles feature configuration for the shop. |
BusinessCustomerUserError |
An error that happens during the execution of a business customer mutation. |
BuyerExperienceConfiguration |
Settings describing the behavior of checkout for a B2B buyer. |
BuyerExperienceConfigurationInput |
The input fields specifying the behavior of checkout for a B2B buyer. |
CalculatedAutomaticDiscountApplication |
A discount that is automatically applied to an order that is being edited. |
CalculatedDiscountAllocation |
An amount discounting the line that has been allocated by an associated discount application. |
CalculatedDiscountApplication |
A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied. |
CalculatedDiscountApplicationConnection |
An auto-generated type for paginating through multiple CalculatedDiscountApplications. |
CalculatedDiscountApplicationEdge |
An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination. |
CalculatedDiscountCodeApplication |
A discount code that is applied to an order that is being edited. |
CalculatedDraftOrder |
The computed properties for a draft order. |
CalculatedDraftOrderLineItem |
The computed line items for a draft order. |
CalculatedLineItem |
A line item involved in order editing that may be newly added or have new changes applied. |
CalculatedLineItemConnection |
An auto-generated type for paginating through multiple CalculatedLineItems. |
CalculatedLineItemEdge |
An auto-generated type which holds one CalculatedLineItem and a cursor during pagination. |
CalculatedManualDiscountApplication |
Represents a discount that was manually created for an order that is being edited. |
CalculatedOrder |
An order with edits applied but not saved. |
CalculatedOrderAddedDiscountApplicationsArgs |
An order with edits applied but not saved. |
CalculatedOrderAddedLineItemsArgs |
An order with edits applied but not saved. |
CalculatedOrderLineItemsArgs |
An order with edits applied but not saved. |
CalculatedOrderStagedChangesArgs |
An order with edits applied but not saved. |
CalculatedScriptDiscountApplication |
A discount created by a Shopify script for an order that is being edited. |
CardPaymentDetails |
Card payment details related to a transaction. |
CartTransform |
A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). |
CartTransformConnection |
An auto-generated type for paginating through multiple CartTransforms. |
CartTransformCreatePayload |
Return type for cartTransformCreate mutation. |
CartTransformCreateUserError |
An error that occurs during the execution of CartTransformCreate . |
CartTransformDeletePayload |
Return type for cartTransformDelete mutation. |
CartTransformDeleteUserError |
An error that occurs during the execution of CartTransformDelete . |
CartTransformEdge |
An auto-generated type which holds one CartTransform and a cursor during pagination. |
CartTransformMetafieldArgs |
A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). |
CartTransformMetafieldsArgs |
A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). |
CartTransformPrivateMetafieldArgs |
A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). |
CartTransformPrivateMetafieldsArgs |
A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). |
Catalog |
A list of products with publishing and pricing information. A catalog can be associated with a specific context, such as a [Market ](https://shopify.dev/api/admin-graphql/current/objects/market), [CompanyLocation ](https://shopify.dev/api/admin-graphql/current/objects/companylocation), or [App ](https://shopify.dev/api/admin-graphql/current/objects/app). |
CatalogConnection |
An auto-generated type for paginating through multiple Catalogs. |
CatalogContextInput |
The input fields for the context in which the catalog’s publishing and pricing rules apply. |
CatalogContextUpdatePayload |
Return type for catalogContextUpdate mutation. |
CatalogCreateInput |
The input fields required to create a catalog. |
CatalogCreatePayload |
Return type for catalogCreate mutation. |
CatalogCsvOperation |
A catalog csv operation represents a CSV file import. |
CatalogDeletePayload |
Return type for catalogDelete mutation. |
CatalogEdge |
An auto-generated type which holds one Catalog and a cursor during pagination. |
CatalogUpdateInput |
The input fields used to update a catalog. |
CatalogUpdatePayload |
Return type for catalogUpdate mutation. |
CatalogUserError |
Defines errors encountered while managing a catalog. |
Channel |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelCollectionPublicationsV3Args |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelCollectionsArgs |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelConnection |
An auto-generated type for paginating through multiple Channels. |
ChannelDefinition |
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. |
ChannelEdge |
An auto-generated type which holds one Channel and a cursor during pagination. |
ChannelHasCollectionArgs |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelInformation |
Contains the information for a given sales channel. |
ChannelProductPublicationsArgs |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelProductPublicationsV3Args |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
ChannelProductsArgs |
A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. |
CheckoutBranding |
<p>The settings of checkout visual customizations.</p><p>To learn more about updating checkout branding settings, refer to the [checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert) mutation.</p> |
CheckoutBrandingButton |
The buttons customizations. |
CheckoutBrandingButtonColorRoles |
Colors for buttons. |
CheckoutBrandingButtonColorRolesInput |
The input fields to set colors for buttons. |
CheckoutBrandingButtonInput |
The input fields used to update the buttons customizations. |
CheckoutBrandingCheckbox |
The checkboxes customizations. |
CheckoutBrandingCheckboxInput |
The input fields used to update the checkboxes customizations. |
CheckoutBrandingColorGlobal |
A set of colors for customizing the overall look and feel of the checkout. |
CheckoutBrandingColorGlobalInput |
The input fields to customize the overall look and feel of the checkout. |
CheckoutBrandingColorRoles |
A group of colors used together on a surface. |
CheckoutBrandingColorRolesInput |
The input fields for a group of colors used together on a surface. |
CheckoutBrandingColors |
The color settings for global colors and color schemes. |
CheckoutBrandingColorScheme |
A base set of color customizations that is applied to an area of Checkout, from which every component pulls its colors from. |
CheckoutBrandingColorSchemeInput |
The input fields for a base set of color customizations that is applied to an area of Checkout, from which every component pulls its colors from. |
CheckoutBrandingColorSchemes |
The color schemes. |
CheckoutBrandingColorSchemesInput |
The input fields for the color schemes. |
CheckoutBrandingColorsInput |
The input fields used to update the color settings for global colors and color schemes. |
CheckoutBrandingControl |
The form controls customizations. |
CheckoutBrandingControlColorRoles |
Colors for form controls. |
CheckoutBrandingControlColorRolesInput |
The input fields to define colors for form controls. |
CheckoutBrandingControlInput |
The input fields used to update the form controls customizations. |
CheckoutBrandingCornerRadiusVariables |
The corner radius variables. |
CheckoutBrandingCornerRadiusVariablesInput |
The input fields used to update the corner radius variables. |
CheckoutBrandingCustomFont |
A custom font. |
CheckoutBrandingCustomFontGroupInput |
The input fields required to update a custom font group. |
CheckoutBrandingCustomFontInput |
The input fields required to update a font. |
CheckoutBrandingCustomizations |
The customizations that apply to specific components or areas of the user interface. |
CheckoutBrandingCustomizationsInput |
The input fields used to update the components customizations. |
CheckoutBrandingDesignSystem |
The design system allows you to set values that represent specific attributes of your brand like color and font. These attributes are used throughout the user interface. This brings consistency and allows you to easily make broad design changes. |
CheckoutBrandingDesignSystemInput |
The input fields used to update the design system. |
CheckoutBrandingFont |
A font. |
CheckoutBrandingFontGroup |
A font group. |
CheckoutBrandingFontGroupInput |
The input fields used to update a font group. |
CheckoutBrandingFontSize |
The font size. |
CheckoutBrandingFontSizeInput |
The input fields used to update the font size. |
CheckoutBrandingGlobal |
The global customizations. |
CheckoutBrandingGlobalInput |
The input fields used to update the global customizations. |
CheckoutBrandingHeader |
The header customizations. |
CheckoutBrandingHeaderInput |
The input fields used to update the header customizations. |
CheckoutBrandingHeadingLevel |
The heading level customizations. |
CheckoutBrandingHeadingLevelInput |
The input fields for heading level customizations. |
CheckoutBrandingImage |
A checkout branding image. |
CheckoutBrandingImageInput |
The input fields used to update a checkout branding image uploaded via the Files API. |
CheckoutBrandingInput |
The input fields used to upsert the checkout branding settings. |
CheckoutBrandingLogo |
The store logo customizations. |
CheckoutBrandingLogoInput |
The input fields used to update the logo customizations. |
CheckoutBrandingMain |
The main area customizations. |
CheckoutBrandingMainInput |
The input fields used to update the main area customizations. |
CheckoutBrandingMerchandiseThumbnail |
The merchandise thumbnails customizations. |
CheckoutBrandingMerchandiseThumbnailInput |
The input fields used to update the merchandise thumbnails customizations. |
CheckoutBrandingOrderSummary |
The order summary customizations. |
CheckoutBrandingOrderSummaryInput |
The input fields used to update the order summary customizations. |
CheckoutBrandingSelect |
The selects customizations. |
CheckoutBrandingSelectInput |
The input fields used to update the selects customizations. |
CheckoutBrandingShopifyFont |
A Shopify font. |
CheckoutBrandingShopifyFontGroupInput |
The input fields used to update a Shopify font group. |
CheckoutBrandingTextField |
The text fields customizations. |
CheckoutBrandingTextFieldInput |
The input fields used to update the text fields customizations. |
CheckoutBrandingTypography |
The typography settings. |
CheckoutBrandingTypographyInput |
The input fields used to update the typography. |
CheckoutBrandingTypographyStyle |
The typography customizations. |
CheckoutBrandingTypographyStyleGlobal |
The global typography customizations. |
CheckoutBrandingTypographyStyleGlobalInput |
The input fields used to update the global typography customizations. |
CheckoutBrandingTypographyStyleInput |
The input fields used to update the typography customizations. |
CheckoutBrandingUpsertPayload |
Return type for checkoutBrandingUpsert mutation. |
CheckoutBrandingUpsertUserError |
An error that occurs during the execution of CheckoutBrandingUpsert . |
CheckoutProfile |
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. |
CheckoutProfileConnection |
An auto-generated type for paginating through multiple CheckoutProfiles. |
CheckoutProfileEdge |
An auto-generated type which holds one CheckoutProfile and a cursor during pagination. |
Collection |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionAddProductsPayload |
Return type for collectionAddProducts mutation. |
CollectionAddProductsV2Payload |
Return type for collectionAddProductsV2 mutation. |
CollectionAddProductsV2UserError |
An error that occurs during the execution of CollectionAddProductsV2 . |
CollectionConnection |
An auto-generated type for paginating through multiple Collections. |
CollectionCreatePayload |
Return type for collectionCreate mutation. |
CollectionDeleteInput |
The input fields for specifying the collection to delete. |
CollectionDeletePayload |
Return type for collectionDelete mutation. |
CollectionDescriptionArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionEdge |
An auto-generated type which holds one Collection and a cursor during pagination. |
CollectionHasProductArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionInput |
The input fields required to create a collection. |
CollectionMetafieldArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionMetafieldDefinitionsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionMetafieldsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPrivateMetafieldArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPrivateMetafieldsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionProductsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPublication |
Represents the publications where a collection is published. |
CollectionPublicationConnection |
An auto-generated type for paginating through multiple CollectionPublications. |
CollectionPublicationCountArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPublicationEdge |
An auto-generated type which holds one CollectionPublication and a cursor during pagination. |
CollectionPublicationInput |
The input fields for publications to which a collection will be published. |
CollectionPublicationsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPublishedOnChannelArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPublishedOnPublicationArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionPublishInput |
The input fields for specifying a collection to publish and the sales channels to publish it to. |
CollectionPublishPayload |
Return type for collectionPublish mutation. |
CollectionRemoveProductsPayload |
Return type for collectionRemoveProducts mutation. |
CollectionReorderProductsPayload |
Return type for collectionReorderProducts mutation. |
CollectionResourcePublicationsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionResourcePublicationsV2Args |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionRule |
Represents at rule that’s used to assign products to a collection. |
CollectionRuleConditions |
This object defines all columns and allowed relations that can be used in rules for smart collections to automatically include the matching products. |
CollectionRuleInput |
The input fields for a rule to associate with a collection. |
CollectionRuleMetafieldCondition |
Identifies a metafield definition used as a rule for the smart collection. |
CollectionRuleProductCategoryCondition |
Specifies the condition for a Product Category field. |
CollectionRuleSet |
The set of rules that are used to determine which products are included in the collection. |
CollectionRuleSetInput |
The input fields for a rule set of the collection. |
CollectionRuleTextCondition |
Specifies the condition for a text field. |
CollectionTranslationsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionUnpublishedChannelsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionUnpublishedPublicationsArgs |
<p>Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.</p><p>Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.</p><p>Collections can also be created for a custom group of products. These are called custom or manual collections.</p> |
CollectionUnpublishInput |
The input fields for specifying the collection to unpublish and the sales channels to remove it from. |
CollectionUnpublishPayload |
Return type for collectionUnpublish mutation. |
CollectionUpdatePayload |
Return type for collectionUpdate mutation. |
CommentEvent |
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. |
CommentEventAttachment |
A file attachment associated to a comment event. |
CommentEventSubject |
The subject line of a comment event. |
CompaniesDeletePayload |
Return type for companiesDelete mutation. |
Company |
Represents information about a company which is also a customer of the shop. |
CompanyAddress |
Represents a billing or shipping address for a company location. |
CompanyAddressDeletePayload |
Return type for companyAddressDelete mutation. |
CompanyAddressFormattedAddressArgs |
Represents a billing or shipping address for a company location. |
CompanyAddressInput |
The input fields to create or update the address of a company location. |
CompanyAssignCustomerAsContactPayload |
Return type for companyAssignCustomerAsContact mutation. |
CompanyAssignMainContactPayload |
Return type for companyAssignMainContact mutation. |
CompanyConnection |
An auto-generated type for paginating through multiple Companies. |
CompanyContact |
A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). |
CompanyContactAssignRolePayload |
Return type for companyContactAssignRole mutation. |
CompanyContactAssignRolesPayload |
Return type for companyContactAssignRoles mutation. |
CompanyContactConnection |
An auto-generated type for paginating through multiple CompanyContacts. |
CompanyContactCreatePayload |
Return type for companyContactCreate mutation. |
CompanyContactDeletePayload |
Return type for companyContactDelete mutation. |
CompanyContactDraftOrdersArgs |
A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). |
CompanyContactEdge |
An auto-generated type which holds one CompanyContact and a cursor during pagination. |
CompanyContactInput |
The input fields for company contact attributes when creating or updating a company contact. |
CompanyContactOrdersArgs |
A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). |
CompanyContactRemoveFromCompanyPayload |
Return type for companyContactRemoveFromCompany mutation. |
CompanyContactRevokeRolePayload |
Return type for companyContactRevokeRole mutation. |
CompanyContactRevokeRolesPayload |
Return type for companyContactRevokeRoles mutation. |
CompanyContactRole |
The role for a [company contact](https://shopify.dev/api/admin-graphql/latest/objects/companycontact). |
CompanyContactRoleAssign |
The input fields for the role and location to assign to a company contact. |
CompanyContactRoleAssignment |
The CompanyContactRoleAssignment describes the company and location associated to a company contact’s role. |
CompanyContactRoleAssignmentConnection |
An auto-generated type for paginating through multiple CompanyContactRoleAssignments. |
CompanyContactRoleAssignmentEdge |
An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination. |
CompanyContactRoleAssignmentsArgs |
A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). |
CompanyContactRoleConnection |
An auto-generated type for paginating through multiple CompanyContactRoles. |
CompanyContactRoleEdge |
An auto-generated type which holds one CompanyContactRole and a cursor during pagination. |
CompanyContactRolesArgs |
Represents information about a company which is also a customer of the shop. |
CompanyContactsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyContactsDeletePayload |
Return type for companyContactsDelete mutation. |
CompanyContactSendWelcomeEmailPayload |
Return type for companyContactSendWelcomeEmail mutation. |
CompanyContactUpdatePayload |
Return type for companyContactUpdate mutation. |
CompanyCreateInput |
The input fields and values for creating a company and its associated resources. |
CompanyCreatePayload |
Return type for companyCreate mutation. |
CompanyDeletePayload |
Return type for companyDelete mutation. |
CompanyDraftOrdersArgs |
Represents information about a company which is also a customer of the shop. |
CompanyEdge |
An auto-generated type which holds one Company and a cursor during pagination. |
CompanyEventsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyInput |
The input fields for company attributes when creating or updating a company. |
CompanyLocation |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationAssignAddressPayload |
Return type for companyLocationAssignAddress mutation. |
CompanyLocationAssignRolesPayload |
Return type for companyLocationAssignRoles mutation. |
CompanyLocationAssignTaxExemptionsPayload |
Return type for companyLocationAssignTaxExemptions mutation. |
CompanyLocationCatalog |
A list of products with publishing and pricing information associated with company locations. |
CompanyLocationCatalogCompanyLocationsArgs |
A list of products with publishing and pricing information associated with company locations. |
CompanyLocationCatalogsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationConnection |
An auto-generated type for paginating through multiple CompanyLocations. |
CompanyLocationCreatePayload |
Return type for companyLocationCreate mutation. |
CompanyLocationCreateTaxRegistrationPayload |
Return type for companyLocationCreateTaxRegistration mutation. |
CompanyLocationDeletePayload |
Return type for companyLocationDelete mutation. |
CompanyLocationDraftOrdersArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationEdge |
An auto-generated type which holds one CompanyLocation and a cursor during pagination. |
CompanyLocationEventsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationInCatalogArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationInput |
The input fields for company location when creating or updating a company location. |
CompanyLocationMetafieldArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationMetafieldDefinitionsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationMetafieldsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationOrdersArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationPrivateMetafieldArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationPrivateMetafieldsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationRevokeRolesPayload |
Return type for companyLocationRevokeRoles mutation. |
CompanyLocationRevokeTaxExemptionsPayload |
Return type for companyLocationRevokeTaxExemptions mutation. |
CompanyLocationRevokeTaxRegistrationPayload |
Return type for companyLocationRevokeTaxRegistration mutation. |
CompanyLocationRoleAssign |
The input fields for the role and contact to assign on a location. |
CompanyLocationRoleAssignmentsArgs |
A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. |
CompanyLocationsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyLocationsDeletePayload |
Return type for companyLocationsDelete mutation. |
CompanyLocationUpdateInput |
The input fields for company location when creating or updating a company location. |
CompanyLocationUpdatePayload |
Return type for companyLocationUpdate mutation. |
CompanyMetafieldArgs |
Represents information about a company which is also a customer of the shop. |
CompanyMetafieldDefinitionsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyMetafieldsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyOrdersArgs |
Represents information about a company which is also a customer of the shop. |
CompanyPrivateMetafieldArgs |
Represents information about a company which is also a customer of the shop. |
CompanyPrivateMetafieldsArgs |
Represents information about a company which is also a customer of the shop. |
CompanyRevokeMainContactPayload |
Return type for companyRevokeMainContact mutation. |
CompanyUpdatePayload |
Return type for companyUpdate mutation. |
ContextualPricingContext |
The input fields for the context data that determines the pricing of a variant. |
ContextualPublicationContext |
The context data that determines the publication status of a product. |
CountriesInShippingZones |
The list of all the countries from the combined shipping zones for the shop. |
CountryHarmonizedSystemCode |
The country-specific harmonized system code and ISO country code for an inventory item. |
CountryHarmonizedSystemCodeConnection |
An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes. |
CountryHarmonizedSystemCodeEdge |
An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination. |
CountryHarmonizedSystemCodeInput |
The input fields required to specify a harmonized system code. |
CreateMediaInput |
The input fields required to create a media object. |
CurrencyFormats |
Currency formats configured for the merchant. These formats are available to use within Liquid. |
CurrencySetting |
A setting for a presentment currency. |
CurrencySettingConnection |
An auto-generated type for paginating through multiple CurrencySettings. |
CurrencySettingEdge |
An auto-generated type which holds one CurrencySetting and a cursor during pagination. |
Customer |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerAccountsV2 |
Information about the shop’s customer accounts. |
CustomerAddressesArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerAddTaxExemptionsPayload |
Return type for customerAddTaxExemptions mutation. |
CustomerConnection |
An auto-generated type for paginating through multiple Customers. |
CustomerCreatePayload |
Return type for customerCreate mutation. |
CustomerCreditCard |
Represents a card instrument for customer payment method. |
CustomerCreditCardBillingAddress |
The billing address of a credit card payment instrument. |
CustomerDeleteInput |
The input fields to delete a customer. |
CustomerDeletePayload |
Return type for customerDelete mutation. |
CustomerEdge |
An auto-generated type which holds one Customer and a cursor during pagination. |
CustomerEmailAddress |
Represents an email address. |
CustomerEmailMarketingConsentInput |
Information that describes when a customer consented to receiving marketing material by email. |
CustomerEmailMarketingConsentState |
The record of when a customer consented to receive marketing material by email. |
CustomerEmailMarketingConsentUpdateInput |
The input fields for the email consent information to update for a given customer ID. |
CustomerEmailMarketingConsentUpdatePayload |
Return type for customerEmailMarketingConsentUpdate mutation. |
CustomerEmailMarketingConsentUpdateUserError |
An error that occurs during the execution of CustomerEmailMarketingConsentUpdate . |
CustomerEventsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerGenerateAccountActivationUrlPayload |
Return type for customerGenerateAccountActivationUrl mutation. |
CustomerInput |
The input fields and values to use when creating or updating a customer. |
CustomerJourney |
Represents a customer’s visiting activities on a shop’s online store. |
CustomerJourneySummary |
Represents a customer’s visiting activities on a shop’s online store. |
CustomerJourneySummaryMomentsArgs |
Represents a customer’s visiting activities on a shop’s online store. |
CustomerMergeable |
An object that represents whether a customer can be merged with another customer. |
CustomerMergeError |
The error blocking a customer merge. |
CustomerMergeOverrideFields |
The input fields to override default customer merge rules. |
CustomerMergePayload |
Return type for customerMerge mutation. |
CustomerMergePreview |
A preview of the results of a customer merge request. |
CustomerMergePreviewAlternateFields |
The fields that can be used to override the default fields. |
CustomerMergePreviewBlockingFields |
The blocking fields of a customer merge preview. These fields will block customer merge unless edited. |
CustomerMergePreviewDefaultFields |
The fields that will be kept as part of a customer merge preview. |
CustomerMergePreviewDefaultFieldsAddressesArgs |
The fields that will be kept as part of a customer merge preview. |
CustomerMergePreviewDefaultFieldsDiscountNodesArgs |
The fields that will be kept as part of a customer merge preview. |
CustomerMergePreviewDefaultFieldsDraftOrdersArgs |
The fields that will be kept as part of a customer merge preview. |
CustomerMergePreviewDefaultFieldsGiftCardsArgs |
The fields that will be kept as part of a customer merge preview. |
CustomerMergePreviewDefaultFieldsOrdersArgs |
The fields that will be kept as part of a customer merge preview. |
CustomerMergeRequest |
A merge request for merging two customers. |
CustomerMergeUserError |
An error that occurs while merging two customers. |
CustomerMetafieldArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerMetafieldDefinitionsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerMetafieldsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerMoment |
Represents a session preceding an order, often used for building a timeline of events leading to an order. |
CustomerMomentConnection |
An auto-generated type for paginating through multiple CustomerMoments. |
CustomerMomentEdge |
An auto-generated type which holds one CustomerMoment and a cursor during pagination. |
CustomerOrdersArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerPaymentInstrumentBillingAddress |
The billing address of a payment instrument. |
CustomerPaymentMethod |
A customer’s payment method. |
CustomerPaymentMethodConnection |
An auto-generated type for paginating through multiple CustomerPaymentMethods. |
CustomerPaymentMethodCreateFromDuplicationDataPayload |
Return type for customerPaymentMethodCreateFromDuplicationData mutation. |
CustomerPaymentMethodCreateFromDuplicationDataUserError |
An error that occurs during the execution of CustomerPaymentMethodCreateFromDuplicationData . |
CustomerPaymentMethodCreditCardCreatePayload |
Return type for customerPaymentMethodCreditCardCreate mutation. |
CustomerPaymentMethodCreditCardUpdatePayload |
Return type for customerPaymentMethodCreditCardUpdate mutation. |
CustomerPaymentMethodEdge |
An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination. |
CustomerPaymentMethodGetDuplicationDataPayload |
Return type for customerPaymentMethodGetDuplicationData mutation. |
CustomerPaymentMethodGetDuplicationDataUserError |
An error that occurs during the execution of CustomerPaymentMethodGetDuplicationData . |
CustomerPaymentMethodGetUpdateUrlPayload |
Return type for customerPaymentMethodGetUpdateUrl mutation. |
CustomerPaymentMethodGetUpdateUrlUserError |
An error that occurs during the execution of CustomerPaymentMethodGetUpdateUrl . |
CustomerPaymentMethodPaypalBillingAgreementCreatePayload |
Return type for customerPaymentMethodPaypalBillingAgreementCreate mutation. |
CustomerPaymentMethodPaypalBillingAgreementUpdatePayload |
Return type for customerPaymentMethodPaypalBillingAgreementUpdate mutation. |
CustomerPaymentMethodRemoteCreatePayload |
Return type for customerPaymentMethodRemoteCreate mutation. |
CustomerPaymentMethodRemoteCreditCardCreatePayload |
Return type for customerPaymentMethodRemoteCreditCardCreate mutation. |
CustomerPaymentMethodRemoteInput |
The input fields for a remote gateway payment method, only one remote reference permitted. |
CustomerPaymentMethodRemoteUserError |
Represents an error in the input of a mutation. |
CustomerPaymentMethodRevokePayload |
Return type for customerPaymentMethodRevoke mutation. |
CustomerPaymentMethodsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerPaymentMethodSendUpdateEmailPayload |
Return type for customerPaymentMethodSendUpdateEmail mutation. |
CustomerPaymentMethodSubscriptionContractsArgs |
A customer’s payment method. |
CustomerPaymentMethodUserError |
Represents an error in the input of a mutation. |
CustomerPaypalBillingAgreement |
Represents a PayPal instrument for customer payment method. |
CustomerPhoneNumber |
A phone number. |
CustomerPrivateMetafieldArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerPrivateMetafieldsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerRemoveTaxExemptionsPayload |
Return type for customerRemoveTaxExemptions mutation. |
CustomerReplaceTaxExemptionsPayload |
Return type for customerReplaceTaxExemptions mutation. |
CustomerSegmentMember |
The member of a segment. |
CustomerSegmentMemberConnection |
The connection type for the CustomerSegmentMembers object. |
CustomerSegmentMemberEdge |
An auto-generated type which holds one CustomerSegmentMember and a cursor during pagination. |
CustomerSegmentMemberMetafieldArgs |
The member of a segment. |
CustomerSegmentMemberMetafieldsArgs |
The member of a segment. |
CustomerSegmentMemberPrivateMetafieldArgs |
The member of a segment. |
CustomerSegmentMemberPrivateMetafieldsArgs |
The member of a segment. |
CustomerSegmentMembersQuery |
A job to determine a list of members, such as customers, that are associated with an individual segment. |
CustomerSegmentMembersQueryCreatePayload |
Return type for customerSegmentMembersQueryCreate mutation. |
CustomerSegmentMembersQueryInput |
The input fields and values for creating a customer segment members query. |
CustomerSegmentMembersQueryUserError |
Represents a customer segment members query custom error. |
CustomerShopPayAgreement |
Represents a Shop Pay card instrument for customer payment method. |
CustomerSmsMarketingConsentError |
An error that occurs during execution of an SMS marketing consent mutation. |
CustomerSmsMarketingConsentInput |
The marketing consent information when the customer consented to receiving marketing material by SMS. |
CustomerSmsMarketingConsentState |
<p>The record of when a customer consented to receive marketing material by SMS.</p><p>The customer’s consent state reflects the record with the most recent date when consent was updated.</p> |
CustomerSmsMarketingConsentUpdateInput |
The input fields for updating SMS marketing consent information for a given customer ID. |
CustomerSmsMarketingConsentUpdatePayload |
Return type for customerSmsMarketingConsentUpdate mutation. |
CustomerStatistics |
A customer’s computed statistics. |
CustomerSubscriptionContractsArgs |
<p>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.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
CustomerUpdateDefaultAddressPayload |
Return type for customerUpdateDefaultAddress mutation. |
CustomerUpdatePayload |
Return type for customerUpdate mutation. |
CustomerVisit |
Represents a customer’s session visiting a shop’s online store, including information about the marketing activity attributed to starting the session. |
CustomerVisitProductInfo |
This type returns the information about the product and product variant from a customer visit. |
CustomerVisitProductInfoConnection |
An auto-generated type for paginating through multiple CustomerVisitProductInfos. |
CustomerVisitProductInfoEdge |
An auto-generated type which holds one CustomerVisitProductInfo and a cursor during pagination. |
CustomShippingPackageInput |
The input fields for a custom shipping package used to pack shipment. |
DelegateAccessToken |
<p>A token that delegates a set of scopes from the original permission.</p><p>To learn more about creating delegate access tokens, refer to [Delegate OAuth access tokens to subsystems] (https://shopify.dev/apps/auth/oauth/delegate-access-tokens).</p> |
DelegateAccessTokenCreatePayload |
Return type for delegateAccessTokenCreate mutation. |
DelegateAccessTokenCreateUserError |
An error that occurs during the execution of DelegateAccessTokenCreate . |
DelegateAccessTokenDestroyPayload |
Return type for delegateAccessTokenDestroy mutation. |
DelegateAccessTokenDestroyUserError |
An error that occurs during the execution of DelegateAccessTokenDestroy . |
DelegateAccessTokenInput |
The input fields for a delegate access token. |
DeletionEvent |
Deletion events chronicle the destruction of resources (e.g. products and collections). Once deleted, the deletion event is the only trace of the original’s existence, as the resource itself has been removed and can no longer be accessed. |
DeletionEventConnection |
An auto-generated type for paginating through multiple DeletionEvents. |
DeletionEventEdge |
An auto-generated type which holds one DeletionEvent and a cursor during pagination. |
DeliveryAvailableService |
A shipping service and a list of countries that the service is available for. |
DeliveryBrandedPromise |
Represents a branded promise presented to buyers. |
DeliveryCarrierService |
A shipping service provider or a carrier account. |
DeliveryCarrierServiceAndLocations |
A carrier service and the associated list of shop locations. |
DeliveryCarrierServiceAvailableServicesForCountriesArgs |
A shipping service provider or a carrier account. |
DeliveryCondition |
A condition that must pass for a delivery method definition to be applied to an order. |
DeliveryCountry |
A country that is used to define a shipping zone. |
DeliveryCountryAndZone |
The country details and the associated shipping zone. |
DeliveryCountryCodeOrRestOfWorld |
The country code and whether the country is a part of the ‘Rest Of World’ shipping zone. |
DeliveryCountryCodesOrRestOfWorld |
The list of country codes and information whether the countries are a part of the ‘Rest Of World’ shipping zone. |
DeliveryCountryInput |
The input fields to specify a country. |
DeliveryCustomization |
A delivery customization. |
DeliveryCustomizationActivationPayload |
Return type for deliveryCustomizationActivation mutation. |
DeliveryCustomizationConnection |
An auto-generated type for paginating through multiple DeliveryCustomizations. |
DeliveryCustomizationCreatePayload |
Return type for deliveryCustomizationCreate mutation. |
DeliveryCustomizationDeletePayload |
Return type for deliveryCustomizationDelete mutation. |
DeliveryCustomizationEdge |
An auto-generated type which holds one DeliveryCustomization and a cursor during pagination. |
DeliveryCustomizationError |
An error that occurs during the execution of a delivery customization mutation. |
DeliveryCustomizationInput |
The input fields to create and update a delivery customization. |
DeliveryCustomizationMetafieldArgs |
A delivery customization. |
DeliveryCustomizationMetafieldDefinitionsArgs |
A delivery customization. |
DeliveryCustomizationMetafieldsArgs |
A delivery customization. |
DeliveryCustomizationPrivateMetafieldArgs |
A delivery customization. |
DeliveryCustomizationPrivateMetafieldsArgs |
A delivery customization. |
DeliveryCustomizationUpdatePayload |
Return type for deliveryCustomizationUpdate mutation. |
DeliveryLegacyModeBlocked |
Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. |
DeliveryLocalPickupSettings |
Local pickup settings associated with a location. |
DeliveryLocationGroup |
A location group is a collection of locations. They share zones and delivery methods across delivery profiles. |
DeliveryLocationGroupLocationsArgs |
A location group is a collection of locations. They share zones and delivery methods across delivery profiles. |
DeliveryLocationGroupZone |
Links a location group with a zone and the associated method definitions. |
DeliveryLocationGroupZoneConnection |
An auto-generated type for paginating through multiple DeliveryLocationGroupZones. |
DeliveryLocationGroupZoneEdge |
An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination. |
DeliveryLocationGroupZoneInput |
The input fields for a delivery zone associated to a location group and profile. |
DeliveryLocationGroupZoneMethodDefinitionsArgs |
Links a location group with a zone and the associated method definitions. |
DeliveryLocationLocalPickupEnableInput |
The input fields for a local pickup setting associated with a location. |
DeliveryLocationLocalPickupSettingsError |
Represents an error that happened when changing local pickup settings for a location. |
DeliveryMethod |
The delivery method used by a fulfillment order. |
DeliveryMethodDefinition |
A method definition contains the delivery rate and the conditions that must be met for the method to be applied. |
DeliveryMethodDefinitionConnection |
An auto-generated type for paginating through multiple DeliveryMethodDefinitions. |
DeliveryMethodDefinitionCounts |
The number of method definitions for a zone, separated into merchant-owned and participant definitions. |
DeliveryMethodDefinitionEdge |
An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination. |
DeliveryMethodDefinitionInput |
The input fields for a method definition. |
DeliveryParticipant |
A participant defines carrier-calculated rates for shipping services with a possible merchant-defined fixed fee or a percentage-of-rate fee. |
DeliveryParticipantInput |
The input fields for a participant. |
DeliveryParticipantService |
A mail service provided by the participant. |
DeliveryParticipantServiceInput |
The input fields for a shipping service provided by a participant. |
DeliveryPriceConditionInput |
The input fields for a price-based condition of a delivery method definition. |
DeliveryProductVariantsCount |
How many product variants are in a profile. This count is capped at 500. |
DeliveryProfile |
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. |
DeliveryProfileConnection |
An auto-generated type for paginating through multiple DeliveryProfiles. |
DeliveryProfileCreatePayload |
Return type for deliveryProfileCreate mutation. |
DeliveryProfileEdge |
An auto-generated type which holds one DeliveryProfile and a cursor during pagination. |
DeliveryProfileInput |
The input fields for a delivery profile. |
DeliveryProfileItem |
A product and the subset of associated variants that are part of this delivery profile. |
DeliveryProfileItemConnection |
An auto-generated type for paginating through multiple DeliveryProfileItems. |
DeliveryProfileItemEdge |
An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination. |
DeliveryProfileItemVariantsArgs |
A product and the subset of associated variants that are part of this delivery profile. |
DeliveryProfileLocationGroup |
Links a location group with zones. Both are associated to a delivery profile. |
DeliveryProfileLocationGroupInput |
The input fields for a location group associated to a delivery profile. |
DeliveryProfileLocationGroupLocationGroupZonesArgs |
Links a location group with zones. Both are associated to a delivery profile. |
DeliveryProfileProfileItemsArgs |
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. |
DeliveryProfileProfileLocationGroupsArgs |
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. |
DeliveryProfileRemovePayload |
Return type for deliveryProfileRemove mutation. |
DeliveryProfileSellingPlanGroupsArgs |
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. |
DeliveryProfileUnassignedLocationsPaginatedArgs |
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. |
DeliveryProfileUpdatePayload |
Return type for deliveryProfileUpdate mutation. |
DeliveryProvince |
A region that is used to define a shipping zone. |
DeliveryProvinceInput |
The input fields to specify a region. |
DeliveryRateDefinition |
The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition). |
DeliveryRateDefinitionInput |
The input fields for a rate definition. |
DeliverySetting |
The DeliverySetting object enables you to manage shop-wide shipping settings. You can enable legacy compatibility mode for the multi-location delivery profiles feature if the legacy mode isn’t blocked. |
DeliverySettingInput |
The input fields for shop-level delivery settings. |
DeliverySettingUpdatePayload |
Return type for deliverySettingUpdate mutation. |
DeliveryShippingOriginAssignPayload |
Return type for deliveryShippingOriginAssign mutation. |
DeliveryUpdateConditionInput |
The input fields for updating the condition of a delivery method definition. |
DeliveryWeightConditionInput |
The input fields for a weight-based condition of a delivery method definition. |
DeliveryZone |
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. |
DiscountAllocation |
An amount that’s allocated to a line based on an associated discount application. |
DiscountAmount |
The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items. |
DiscountAmountInput |
The input fields for the value of the discount and how it is applied. |
DiscountApplication |
<p>Discount applications capture the intentions of a discount source at the time of application on an order’s line items or shipping lines.</p><p>Discount applications don’t represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.</p> |
DiscountApplicationConnection |
An auto-generated type for paginating through multiple DiscountApplications. |
DiscountApplicationEdge |
An auto-generated type which holds one DiscountApplication and a cursor during pagination. |
DiscountAutomaticActivatePayload |
Return type for discountAutomaticActivate mutation. |
DiscountAutomaticApp |
An automatic app discount. |
DiscountAutomaticAppCreatePayload |
Return type for discountAutomaticAppCreate mutation. |
DiscountAutomaticAppInput |
The input fields to create an app discount. |
DiscountAutomaticAppUpdatePayload |
Return type for discountAutomaticAppUpdate mutation. |
DiscountAutomaticBasic |
An automatic discount that offers customers a percentage discount, or fixed amount discount, on specific products, collections, or the entire order. |
DiscountAutomaticBasicCreatePayload |
Return type for discountAutomaticBasicCreate mutation. |
DiscountAutomaticBasicInput |
The input fields to create or update an automatic basic discount. |
DiscountAutomaticBasicUpdatePayload |
Return type for discountAutomaticBasicUpdate mutation. |
DiscountAutomaticBulkDeletePayload |
Return type for discountAutomaticBulkDelete mutation. |
DiscountAutomaticBxgy |
An automatic discount that offers customers a Buy X, Get Y (BXGY) discount. |
DiscountAutomaticBxgyCreatePayload |
Return type for discountAutomaticBxgyCreate mutation. |
DiscountAutomaticBxgyEventsArgs |
An automatic discount that offers customers a Buy X, Get Y (BXGY) discount. |
DiscountAutomaticBxgyInput |
The input fields to create or update an automatic Buy X, Get Y (BXGY) discount. |
DiscountAutomaticBxgyUpdatePayload |
Return type for discountAutomaticBxgyUpdate mutation. |
DiscountAutomaticConnection |
An auto-generated type for paginating through multiple DiscountAutomatics. |
DiscountAutomaticDeactivatePayload |
Return type for discountAutomaticDeactivate mutation. |
DiscountAutomaticDeletePayload |
Return type for discountAutomaticDelete mutation. |
DiscountAutomaticEdge |
An auto-generated type which holds one DiscountAutomatic and a cursor during pagination. |
DiscountAutomaticFreeShipping |
An automatic discount that offers customers free shipping on their order. |
DiscountAutomaticFreeShippingCreatePayload |
Return type for discountAutomaticFreeShippingCreate mutation. |
DiscountAutomaticFreeShippingInput |
The input fields to create or update free shipping automatic discount. |
DiscountAutomaticFreeShippingUpdatePayload |
Return type for discountAutomaticFreeShippingUpdate mutation. |
DiscountAutomaticNode |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodeConnection |
An auto-generated type for paginating through multiple DiscountAutomaticNodes. |
DiscountAutomaticNodeEdge |
An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination. |
DiscountAutomaticNodeEventsArgs |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodeMetafieldArgs |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodeMetafieldDefinitionsArgs |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodeMetafieldsArgs |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodePrivateMetafieldArgs |
A node containing an automatic discount and its related events. |
DiscountAutomaticNodePrivateMetafieldsArgs |
A node containing an automatic discount and its related events. |
DiscountCodeActivatePayload |
Return type for discountCodeActivate mutation. |
DiscountCodeApp |
A code app discount. |
DiscountCodeAppCodesArgs |
A code app discount. |
DiscountCodeAppCreatePayload |
Return type for discountCodeAppCreate mutation. |
DiscountCodeAppInput |
The input fields to create a code app discount. |
DiscountCodeApplication |
<p>Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.</p><p>Discount applications don’t represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.</p> |
DiscountCodeAppUpdatePayload |
Return type for discountCodeAppUpdate mutation. |
DiscountCodeBasic |
A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order. |
DiscountCodeBasicCodesArgs |
A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order. |
DiscountCodeBasicCreatePayload |
Return type for discountCodeBasicCreate mutation. |
DiscountCodeBasicInput |
The input fields to create or update a basic code discount. |
DiscountCodeBasicUpdatePayload |
Return type for discountCodeBasicUpdate mutation. |
DiscountCodeBulkActivatePayload |
Return type for discountCodeBulkActivate mutation. |
DiscountCodeBulkDeactivatePayload |
Return type for discountCodeBulkDeactivate mutation. |
DiscountCodeBulkDeletePayload |
Return type for discountCodeBulkDelete mutation. |
DiscountCodeBxgy |
A code discount that offers customers a Buy X, Get Y (BXGY) discount. |
DiscountCodeBxgyCodesArgs |
A code discount that offers customers a Buy X, Get Y (BXGY) discount. |
DiscountCodeBxgyCreatePayload |
Return type for discountCodeBxgyCreate mutation. |
DiscountCodeBxgyInput |
The input fields to create or update a BXGY code discount. |
DiscountCodeBxgyUpdatePayload |
Return type for discountCodeBxgyUpdate mutation. |
DiscountCodeDeactivatePayload |
Return type for discountCodeDeactivate mutation. |
DiscountCodeDeletePayload |
Return type for discountCodeDelete mutation. |
DiscountCodeFreeShipping |
A code discount that offers customers free shipping on their order. |
DiscountCodeFreeShippingCodesArgs |
A code discount that offers customers free shipping on their order. |
DiscountCodeFreeShippingCreatePayload |
Return type for discountCodeFreeShippingCreate mutation. |
DiscountCodeFreeShippingInput |
The input fields to create or update a free shipping code discount. |
DiscountCodeFreeShippingUpdatePayload |
Return type for discountCodeFreeShippingUpdate mutation. |
DiscountCodeNode |
A node containing a code discount and its related events. |
DiscountCodeNodeConnection |
An auto-generated type for paginating through multiple DiscountCodeNodes. |
DiscountCodeNodeEdge |
An auto-generated type which holds one DiscountCodeNode and a cursor during pagination. |
DiscountCodeNodeEventsArgs |
A node containing a code discount and its related events. |
DiscountCodeNodeMetafieldArgs |
A node containing a code discount and its related events. |
DiscountCodeNodeMetafieldDefinitionsArgs |
A node containing a code discount and its related events. |
DiscountCodeNodeMetafieldsArgs |
A node containing a code discount and its related events. |
DiscountCodeNodePrivateMetafieldArgs |
A node containing a code discount and its related events. |
DiscountCodeNodePrivateMetafieldsArgs |
A node containing a code discount and its related events. |
DiscountCodeRedeemCodeBulkDeletePayload |
Return type for discountCodeRedeemCodeBulkDelete mutation. |
DiscountCollections |
A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied. |
DiscountCollectionsCollectionsArgs |
A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied. |
DiscountCollectionsInput |
The input fields for collections attached to a discount. |
DiscountCombinesWith |
Determines which discount classes the discount can combine with. |
DiscountCombinesWithInput |
The input fields to determine which discount classes the discount can combine with. |
DiscountCountries |
The shipping destinations where the discount can be applied. |
DiscountCountriesInput |
The input fields for a list of countries to add or remove from the free shipping discount. |
DiscountCountryAll |
The DiscountCountryAll object lets you target all countries as shipping destination for discount eligibility. |
DiscountCustomerAll |
The DiscountCustomerAll object lets you target all customers for discount eligibility. |
DiscountCustomerBuys |
The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable. |
DiscountCustomerBuysInput |
The input fields for prerequisite items and quantity for the discount. |
DiscountCustomerBuysValueInput |
The input fields for prerequisite quantity or minimum purchase amount required for the discount. |
DiscountCustomerGets |
The qualifying items in an order, the quantity of each one, and the total value of the discount. |
DiscountCustomerGetsInput |
Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount. |
DiscountCustomerGetsValueInput |
The input fields for the quantity of items discounted and the discount value. |
DiscountCustomers |
A list of customers eligible for the discount. |
DiscountCustomerSegments |
A list of customer segments that contain the customers that the discount applies to. |
DiscountCustomerSegmentsInput |
The input fields for which customer segments to add to or remove from the discount. |
DiscountCustomerSelectionInput |
The input fields for the customers who can use this discount. |
DiscountCustomersInput |
The input fields for which customers to add to or remove from the discount. |
DiscountEffectInput |
The input fields for how the discount will be applied. Currently, only percentage off is supported. |
DiscountItemsInput |
The input fields for the items attached to a discount. You can specify the discount items by product ID or collection ID. |
DiscountMinimumQuantity |
The minimum quantity of items required for the discount to apply. |
DiscountMinimumQuantityInput |
The input fields for the minimum quantity required for the discount. |
DiscountMinimumRequirementInput |
The input fields for the minimum quantity or subtotal required for a discount. |
DiscountMinimumSubtotal |
The minimum subtotal required for the discount to apply. |
DiscountMinimumSubtotalInput |
The input fields for the minimum subtotal required for a discount. |
DiscountNode |
A discount wrapper node. |
DiscountNodeConnection |
An auto-generated type for paginating through multiple DiscountNodes. |
DiscountNodeEdge |
An auto-generated type which holds one DiscountNode and a cursor during pagination. |
DiscountNodeEventsArgs |
A discount wrapper node. |
DiscountNodeMetafieldArgs |
A discount wrapper node. |
DiscountNodeMetafieldDefinitionsArgs |
A discount wrapper node. |
DiscountNodeMetafieldsArgs |
A discount wrapper node. |
DiscountNodePrivateMetafieldArgs |
A discount wrapper node. |
DiscountNodePrivateMetafieldsArgs |
A discount wrapper node. |
DiscountOnQuantity |
The quantity of items discounted, the discount value, and how the discount will be applied. |
DiscountOnQuantityInput |
The input fields for the quantity of items discounted and the discount value. |
DiscountPercentage |
A discount effect that gives customers a percentage off of specified items on their order. |
DiscountProducts |
A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. |
DiscountProductsInput |
The input fields for the products and product variants attached to a discount. |
DiscountProductsProductsArgs |
A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. |
DiscountProductsProductVariantsArgs |
A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. |
DiscountPurchaseAmount |
A purchase amount in the context of a discount. This object can be used to define the minimum purchase amount required for a discount to be applicable. |
DiscountQuantity |
A quantity of items in the context of a discount. This object can be used to define the minimum quantity of items required to apply a discount. Alternatively, it can be used to define the quantity of items that can be discounted. |
DiscountRedeemCode |
A code that a customer can use at checkout to receive a discount. For example, a customer can use the redeem code ‘SUMMER20’ at checkout to receive a 20% discount on their entire order. |
DiscountRedeemCodeBulkAddPayload |
Return type for discountRedeemCodeBulkAdd mutation. |
DiscountRedeemCodeBulkCreation |
The properties and status of a bulk discount redeem code creation operation. |
DiscountRedeemCodeBulkCreationCode |
A result of a discount redeem code creation operation created by a bulk creation. |
DiscountRedeemCodeBulkCreationCodeConnection |
An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes. |
DiscountRedeemCodeBulkCreationCodeEdge |
An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination. |
DiscountRedeemCodeBulkCreationCodesArgs |
The properties and status of a bulk discount redeem code creation operation. |
DiscountRedeemCodeConnection |
An auto-generated type for paginating through multiple DiscountRedeemCodes. |
DiscountRedeemCodeEdge |
An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination. |
DiscountRedeemCodeInput |
The input fields for the redeem code to attach to a discount. |
DiscountShareableUrl |
A shareable URL for a discount code. |
DiscountShippingDestinationSelectionInput |
The input fields for the destinations where the free shipping discount will be applied. |
DiscountUserError |
An error that occurs during the execution of a discount mutation. |
DisplayableError |
Represents an error in the input of a mutation. |
DisputeEvidenceUpdatePayload |
Return type for disputeEvidenceUpdate mutation. |
DisputeEvidenceUpdateUserError |
An error that occurs during the execution of DisputeEvidenceUpdate . |
Domain |
A unique string that represents the address of a Shopify store on the Internet. |
DomainLocalization |
The country and language settings assigned to a domain. |
DraftOrder |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderAppliedDiscount |
The order-level discount applied to a draft order. |
DraftOrderAppliedDiscountInput |
The input fields for applying an order-level discount to a draft order. |
DraftOrderBulkAddTagsPayload |
Return type for draftOrderBulkAddTags mutation. |
DraftOrderBulkDeletePayload |
Return type for draftOrderBulkDelete mutation. |
DraftOrderBulkRemoveTagsPayload |
Return type for draftOrderBulkRemoveTags mutation. |
DraftOrderCalculatePayload |
Return type for draftOrderCalculate mutation. |
DraftOrderCompletePayload |
Return type for draftOrderComplete mutation. |
DraftOrderConnection |
An auto-generated type for paginating through multiple DraftOrders. |
DraftOrderCreateFromOrderPayload |
Return type for draftOrderCreateFromOrder mutation. |
DraftOrderCreateMerchantCheckoutPayload |
Return type for draftOrderCreateMerchantCheckout mutation. |
DraftOrderCreatePayload |
Return type for draftOrderCreate mutation. |
DraftOrderDeleteInput |
The input fields to specify the draft order to delete by its ID. |
DraftOrderDeletePayload |
Return type for draftOrderDelete mutation. |
DraftOrderDuplicatePayload |
Return type for draftOrderDuplicate mutation. |
DraftOrderEdge |
An auto-generated type which holds one DraftOrder and a cursor during pagination. |
DraftOrderEventsArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderInput |
The input fields used to create or update a draft order. |
DraftOrderInvoicePreviewPayload |
Return type for draftOrderInvoicePreview mutation. |
DraftOrderInvoiceSendPayload |
Return type for draftOrderInvoiceSend mutation. |
DraftOrderLineItem |
A line item included in a draft order. |
DraftOrderLineItemConnection |
An auto-generated type for paginating through multiple DraftOrderLineItems. |
DraftOrderLineItemEdge |
An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. |
DraftOrderLineItemInput |
The input fields used to create a line item for a draft order. |
DraftOrderLineItemsArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderLocalizationExtensionsArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderMetafieldArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderMetafieldsArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderPrivateMetafieldArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderPrivateMetafieldsArgs |
<p>An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:</p><p>- 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. - Save an order as a draft and resume working on it later.</p><p>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 local currency.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
DraftOrderTag |
Represents a draft order tag. |
DraftOrderUpdatePayload |
Return type for draftOrderUpdate mutation. |
Duty |
The duty details for a line item. |
DutySale |
A sale associated with a duty charge. |
EditableProperty |
The attribute editable information. |
EmailInput |
The input fields for an email. |
ErrorPosition |
Error position information in a ShopifyQL parsing error. |
ErrorsServerPixelUserError |
An error that occurs during the execution of a server pixel mutation. |
ErrorsWebPixelUserError |
An error that occurs during the execution of a web pixel mutation. |
Event |
Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product. |
EventBridgeServerPixelUpdatePayload |
Return type for eventBridgeServerPixelUpdate mutation. |
EventBridgeWebhookSubscriptionCreatePayload |
Return type for eventBridgeWebhookSubscriptionCreate mutation. |
EventBridgeWebhookSubscriptionInput |
The input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionUpdatePayload |
Return type for eventBridgeWebhookSubscriptionUpdate mutation. |
EventConnection |
An auto-generated type for paginating through multiple Events. |
EventEdge |
An auto-generated type which holds one Event and a cursor during pagination. |
ExchangeV2 |
An exchange where existing items on an order are returned and new items are added to the order. |
ExchangeV2Additions |
New items associated to the exchange. |
ExchangeV2Connection |
An auto-generated type for paginating through multiple ExchangeV2s. |
ExchangeV2Edge |
An auto-generated type which holds one ExchangeV2 and a cursor during pagination. |
ExchangeV2LineItem |
Contains information about an item in the exchange. |
ExchangeV2Returns |
Return items associated to the exchange. |
ExternalVideo |
Represents a video hosted outside of Shopify. |
FailedRequirement |
Requirements that must be met before an app can be installed. |
File |
A file interface. |
FileAcknowledgeUpdateFailedPayload |
Return type for fileAcknowledgeUpdateFailed mutation. |
FileConnection |
An auto-generated type for paginating through multiple Files. |
FileCreateInput |
The input fields that are required to create a file object. |
FileCreatePayload |
Return type for fileCreate mutation. |
FileDeletePayload |
Return type for fileDelete mutation. |
FileEdge |
An auto-generated type which holds one File and a cursor during pagination. |
FileError |
A file error. This typically occurs when there is an issue with the file itself causing it to fail validation. Check the file before attempting to upload again. |
FilesUserError |
An error that happens during the execution of a Files API query or mutation. |
FileUpdateInput |
The input fields that are required to update a file object. |
FileUpdatePayload |
Return type for fileUpdate mutation. |
FilterOption |
A filter option is one possible value in a search filter. |
FlowTriggerReceivePayload |
Return type for flowTriggerReceive mutation. |
Fulfillment |
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. |
FulfillmentCancelPayload |
Return type for fulfillmentCancel mutation. |
FulfillmentConnection |
An auto-generated type for paginating through multiple Fulfillments. |
FulfillmentConstraintRule |
A fulfillment constraint rule. |
FulfillmentConstraintRuleCreatePayload |
Return type for fulfillmentConstraintRuleCreate mutation. |
FulfillmentConstraintRuleCreateUserError |
An error that occurs during the execution of FulfillmentConstraintRuleCreate . |
FulfillmentConstraintRuleDeletePayload |
Return type for fulfillmentConstraintRuleDelete mutation. |
FulfillmentConstraintRuleDeleteUserError |
An error that occurs during the execution of FulfillmentConstraintRuleDelete . |
FulfillmentConstraintRuleMetafieldArgs |
A fulfillment constraint rule. |
FulfillmentConstraintRuleMetafieldsArgs |
A fulfillment constraint rule. |
FulfillmentConstraintRulePrivateMetafieldArgs |
A fulfillment constraint rule. |
FulfillmentConstraintRulePrivateMetafieldsArgs |
A fulfillment constraint rule. |
FulfillmentCreateV2Payload |
Return type for fulfillmentCreateV2 mutation. |
FulfillmentEdge |
An auto-generated type which holds one Fulfillment and a cursor during pagination. |
FulfillmentEvent |
The fulfillment event that describes the fulfilllment status at a particular time. |
FulfillmentEventConnection |
An auto-generated type for paginating through multiple FulfillmentEvents. |
FulfillmentEventCreatePayload |
Return type for fulfillmentEventCreate mutation. |
FulfillmentEventEdge |
An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. |
FulfillmentEventInput |
The input fields used to create a fulfillment event. |
FulfillmentEventsArgs |
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. |
FulfillmentFulfillmentLineItemsArgs |
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. |
FulfillmentFulfillmentOrdersArgs |
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. |
FulfillmentHold |
A fulfillment hold currently applied on a fulfillment order. |
FulfillmentLineItem |
Represents a line item from an order that’s included in a fulfillment. |
FulfillmentLineItemConnection |
An auto-generated type for paginating through multiple FulfillmentLineItems. |
FulfillmentLineItemEdge |
An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. |
FulfillmentOrder |
<p>The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location.</p><p>{{ ‘/api/reference/fulfillment_order_relationships.png’ | image }}</p><p>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](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment.</p><p>[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).</p><p>> 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](#the-lifecycle-of-a-fulfillment-order).</p><p>## Retrieving fulfillment orders</p><p>### Fulfillment orders from an order</p><p>All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection.</p><p>[API access scopes](#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.</p><p>### Fulfillment orders assigned to the app for fulfillment</p><p>Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-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](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to.</p><p>The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.</p><p>### All fulfillment orders</p><p>Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/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](#api-access-scopes) it was granted with.</p><p>## The lifecycle of a fulfillment order</p><p>### Fulfillment Order Creation</p><p>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.</p><p>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.</p><p>### The lifecycle of a fulfillment order at a merchant managed location</p><p>Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done.</p><p>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.</p><p>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.</p><p>[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).</p><p>### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request.</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service.</p><p>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 [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation.</p><p>[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).</p><p>## API access scopes</p><p>Fulfillment orders are governed by the following API access scopes:</p><p>* 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.</p><p>### Fulfillment service app access scopes</p><p>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.</p><p>### Order management app access scopes</p><p>**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.</p><p>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.</p><p>## Notifications about fulfillment orders</p><p>Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) 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.</p><p>Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur.</p><p>[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).</p> |
FulfillmentOrderAcceptCancellationRequestPayload |
Return type for fulfillmentOrderAcceptCancellationRequest mutation. |
FulfillmentOrderAcceptFulfillmentRequestPayload |
Return type for fulfillmentOrderAcceptFulfillmentRequest mutation. |
FulfillmentOrderAssignedLocation |
<p>The fulfillment order’s assigned location. This is the location where the fulfillment is expected to happen.</p><p>The fulfillment order’s assigned location might change in the following cases:</p><p>- The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove]( https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder]( https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder ) field within the mutation’s response.</p><p>- Work on the fulfillment order has not yet begun, which means that the fulfillment order has the [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open), [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold) status, and the shop’s location properties might be undergoing edits (for example, in the Shopify admin).</p><p>If the [fulfillmentOrderMove]( https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove ) mutation has moved the fulfillment order’s line items to a new location, but hasn’t moved the fulfillment order instance itself, then the original fulfillment order’s assigned location doesn’t change. This happens if the fulfillment order is being split during the move, or if all line items can be moved to an existing fulfillment order at a new location.</p><p>Once the fulfillment order has been taken into work or canceled, which means that the fulfillment order has the [IN_PROGRESS](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-inprogress), [CLOSED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-closed), [CANCELLED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-cancelled), or [INCOMPLETE](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-incomplete) status, FulfillmentOrderAssignedLocation acts as a snapshot of the shop’s location content. Up-to-date shop’s location data may be queried through [location]( https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderAssignedLocation#field-fulfillmentorderassignedlocation-location ) connection.</p> |
FulfillmentOrderCancelPayload |
Return type for fulfillmentOrderCancel mutation. |
FulfillmentOrderClosePayload |
Return type for fulfillmentOrderClose mutation. |
FulfillmentOrderConnection |
An auto-generated type for paginating through multiple FulfillmentOrders. |
FulfillmentOrderDestination |
Represents the destination where the items should be sent upon fulfillment. |
FulfillmentOrderEdge |
An auto-generated type which holds one FulfillmentOrder and a cursor during pagination. |
FulfillmentOrderFulfillmentsArgs |
<p>The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location.</p><p>{{ ‘/api/reference/fulfillment_order_relationships.png’ | image }}</p><p>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](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment.</p><p>[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).</p><p>> 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](#the-lifecycle-of-a-fulfillment-order).</p><p>## Retrieving fulfillment orders</p><p>### Fulfillment orders from an order</p><p>All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection.</p><p>[API access scopes](#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.</p><p>### Fulfillment orders assigned to the app for fulfillment</p><p>Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-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](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to.</p><p>The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.</p><p>### All fulfillment orders</p><p>Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/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](#api-access-scopes) it was granted with.</p><p>## The lifecycle of a fulfillment order</p><p>### Fulfillment Order Creation</p><p>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.</p><p>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.</p><p>### The lifecycle of a fulfillment order at a merchant managed location</p><p>Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done.</p><p>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.</p><p>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.</p><p>[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).</p><p>### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request.</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service.</p><p>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 [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation.</p><p>[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).</p><p>## API access scopes</p><p>Fulfillment orders are governed by the following API access scopes:</p><p>* 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.</p><p>### Fulfillment service app access scopes</p><p>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.</p><p>### Order management app access scopes</p><p>**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.</p><p>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.</p><p>## Notifications about fulfillment orders</p><p>Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) 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.</p><p>Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur.</p><p>[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).</p> |
FulfillmentOrderHoldInput |
The input fields for the fulfillment hold applied on the fulfillment order. |
FulfillmentOrderHoldPayload |
Return type for fulfillmentOrderHold mutation. |
FulfillmentOrderHoldUserError |
An error that occurs during the execution of FulfillmentOrderHold . |
FulfillmentOrderInternationalDuties |
The international duties relevant to a fulfillment order. |
FulfillmentOrderLineItem |
Associates an order line item with quantities requiring fulfillment from the respective fulfillment order. |
FulfillmentOrderLineItemConnection |
An auto-generated type for paginating through multiple FulfillmentOrderLineItems. |
FulfillmentOrderLineItemEdge |
An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination. |
FulfillmentOrderLineItemInput |
The input fields used to include the quantity of the fulfillment order line item that should be fulfilled. |
FulfillmentOrderLineItemsArgs |
<p>The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location.</p><p>{{ ‘/api/reference/fulfillment_order_relationships.png’ | image }}</p><p>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](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment.</p><p>[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).</p><p>> 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](#the-lifecycle-of-a-fulfillment-order).</p><p>## Retrieving fulfillment orders</p><p>### Fulfillment orders from an order</p><p>All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection.</p><p>[API access scopes](#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.</p><p>### Fulfillment orders assigned to the app for fulfillment</p><p>Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-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](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to.</p><p>The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.</p><p>### All fulfillment orders</p><p>Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/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](#api-access-scopes) it was granted with.</p><p>## The lifecycle of a fulfillment order</p><p>### Fulfillment Order Creation</p><p>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.</p><p>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.</p><p>### The lifecycle of a fulfillment order at a merchant managed location</p><p>Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done.</p><p>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.</p><p>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.</p><p>[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).</p><p>### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request.</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service.</p><p>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 [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation.</p><p>[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).</p><p>## API access scopes</p><p>Fulfillment orders are governed by the following API access scopes:</p><p>* 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.</p><p>### Fulfillment service app access scopes</p><p>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.</p><p>### Order management app access scopes</p><p>**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.</p><p>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.</p><p>## Notifications about fulfillment orders</p><p>Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) 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.</p><p>Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur.</p><p>[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).</p> |
FulfillmentOrderLineItemsInput |
The input fields used to include the line items of a specified fulfillment order that should be fulfilled. |
FulfillmentOrderLineItemsPreparedForPickupInput |
The input fields for marking fulfillment order line items as ready for pickup. |
FulfillmentOrderLineItemsPreparedForPickupPayload |
Return type for fulfillmentOrderLineItemsPreparedForPickup mutation. |
FulfillmentOrderLineItemsPreparedForPickupUserError |
An error that occurs during the execution of FulfillmentOrderLineItemsPreparedForPickup . |
FulfillmentOrderLineItemWarning |
A fulfillment order line item warning. For example, a warning about why a fulfillment request was rejected. |
FulfillmentOrderLocationForMove |
A location that a fulfillment order can potentially move to. |
FulfillmentOrderLocationForMoveConnection |
An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves. |
FulfillmentOrderLocationForMoveEdge |
An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination. |
FulfillmentOrderLocationsForMoveArgs |
<p>The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location.</p><p>{{ ‘/api/reference/fulfillment_order_relationships.png’ | image }}</p><p>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](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment.</p><p>[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).</p><p>> 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](#the-lifecycle-of-a-fulfillment-order).</p><p>## Retrieving fulfillment orders</p><p>### Fulfillment orders from an order</p><p>All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection.</p><p>[API access scopes](#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.</p><p>### Fulfillment orders assigned to the app for fulfillment</p><p>Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-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](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to.</p><p>The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.</p><p>### All fulfillment orders</p><p>Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/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](#api-access-scopes) it was granted with.</p><p>## The lifecycle of a fulfillment order</p><p>### Fulfillment Order Creation</p><p>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.</p><p>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.</p><p>### The lifecycle of a fulfillment order at a merchant managed location</p><p>Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done.</p><p>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.</p><p>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.</p><p>[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).</p><p>### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request.</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service.</p><p>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 [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation.</p><p>[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).</p><p>## API access scopes</p><p>Fulfillment orders are governed by the following API access scopes:</p><p>* 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.</p><p>### Fulfillment service app access scopes</p><p>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.</p><p>### Order management app access scopes</p><p>**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.</p><p>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.</p><p>## Notifications about fulfillment orders</p><p>Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) 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.</p><p>Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur.</p><p>[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).</p> |
FulfillmentOrderMerchantRequest |
A request made by the merchant or an order management app to a fulfillment service for a fulfillment order. |
FulfillmentOrderMerchantRequestConnection |
An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests. |
FulfillmentOrderMerchantRequestEdge |
An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination. |
FulfillmentOrderMerchantRequestsArgs |
<p>The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location.</p><p>{{ ‘/api/reference/fulfillment_order_relationships.png’ | image }}</p><p>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](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment.</p><p>[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).</p><p>> 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](#the-lifecycle-of-a-fulfillment-order).</p><p>## Retrieving fulfillment orders</p><p>### Fulfillment orders from an order</p><p>All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection.</p><p>[API access scopes](#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.</p><p>### Fulfillment orders assigned to the app for fulfillment</p><p>Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-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](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to.</p><p>The API client must be granted the read_assigned_fulfillment_orders access scope to access the assigned fulfillment orders.</p><p>### All fulfillment orders</p><p>Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/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](#api-access-scopes) it was granted with.</p><p>## The lifecycle of a fulfillment order</p><p>### Fulfillment Order Creation</p><p>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.</p><p>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.</p><p>### The lifecycle of a fulfillment order at a merchant managed location</p><p>Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done.</p><p>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.</p><p>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.</p><p>[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).</p><p>### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request.</p><p>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](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service.</p><p>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 [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation.</p><p>[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).</p><p>## API access scopes</p><p>Fulfillment orders are governed by the following API access scopes:</p><p>* 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.</p><p>### Fulfillment service app access scopes</p><p>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.</p><p>### Order management app access scopes</p><p>**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.</p><p>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.</p><p>## Notifications about fulfillment orders</p><p>Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) 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.</p><p>Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur.</p><p>[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).</p> |
FulfillmentOrderMergeInput |
The input fields for merging fulfillment orders. |
FulfillmentOrderMergeInputMergeIntent |
The input fields for merging fulfillment orders into a single merged fulfillment order. |
FulfillmentOrderMergePayload |
Return type for fulfillmentOrderMerge mutation. |
FulfillmentOrderMergeResult |
The result of merging a set of fulfillment orders. |
FulfillmentOrderMergeUserError |
An error that occurs during the execution of FulfillmentOrderMerge . |
FulfillmentOrderMovePayload |
Return type for fulfillmentOrderMove mutation. |
FulfillmentOrderOpenPayload |
Return type for fulfillmentOrderOpen mutation. |
FulfillmentOrderRejectCancellationRequestPayload |
Return type for fulfillmentOrderRejectCancellationRequest mutation. |
FulfillmentOrderRejectFulfillmentRequestPayload |
Return type for fulfillmentOrderRejectFulfillmentRequest mutation. |
FulfillmentOrderReleaseHoldPayload |
Return type for fulfillmentOrderReleaseHold mutation. |
FulfillmentOrderReleaseHoldUserError |
An error that occurs during the execution of FulfillmentOrderReleaseHold . |
FulfillmentOrderReschedulePayload |
Return type for fulfillmentOrderReschedule mutation. |
FulfillmentOrderRescheduleUserError |
An error that occurs during the execution of FulfillmentOrderReschedule . |
FulfillmentOrderSplitInput |
The input fields for the split applied to the fulfillment order. |
FulfillmentOrderSplitPayload |
Return type for fulfillmentOrderSplit mutation. |
FulfillmentOrderSplitResult |
The result of splitting a fulfillment order. |
FulfillmentOrderSplitUserError |
An error that occurs during the execution of FulfillmentOrderSplit . |
FulfillmentOrdersReleaseHoldsPayload |
Return type for fulfillmentOrdersReleaseHolds mutation. |
FulfillmentOrdersReleaseHoldsUserError |
An error that occurs during the execution of FulfillmentOrdersReleaseHolds . |
FulfillmentOrdersSetFulfillmentDeadlinePayload |
Return type for fulfillmentOrdersSetFulfillmentDeadline mutation. |
FulfillmentOrdersSetFulfillmentDeadlineUserError |
An error that occurs during the execution of FulfillmentOrdersSetFulfillmentDeadline . |
FulfillmentOrderSubmitCancellationRequestPayload |
Return type for fulfillmentOrderSubmitCancellationRequest mutation. |
FulfillmentOrderSubmitFulfillmentRequestPayload |
Return type for fulfillmentOrderSubmitFulfillmentRequest mutation. |
FulfillmentOrderSupportedAction |
One of the actions that the fulfillment order supports in its current state. |
FulfillmentOriginAddress |
The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center. |
FulfillmentOriginAddressInput |
The input fields used to include the address at which the fulfillment occurred. Typically the address of a warehouse or a fulfillment center. |
FulfillmentService |
<p>A **Fulfillment Service** is a third party warehouse that prepares and ships orders on behalf of the store owner. Fulfillment services charge a fee to package and ship items and update product inventory levels. Some well known fulfillment services with Shopify integrations include: Amazon, Shipwire, and Rakuten. When an app registers a new FulfillmentService on a store, Shopify automatically creates a Location that’s associated to the fulfillment service. To learn more about fulfillment services, refer to [Manage fulfillments as a fulfillment service app](https://shopify.dev/apps/fulfillment/fulfillment-service-apps) guide.</p><p>## Mutations</p><p>You can work with the FulfillmentService object with the [fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate), [fulfillmentServiceUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceUpdate), and [fulfillmentServiceDelete](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceDelete) mutations.</p><p>## Hosted endpoints</p><p>Fulfillment service providers integrate with Shopify by providing Shopify with a set of hosted endpoints that Shopify can query on certain conditions. These endpoints must have a common prefix, and this prefix should be supplied in the callbackUrl parameter in the [fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate) mutation.</p><p>- Shopify sends POST requests to the <callbackUrl>/fulfillment_order_notification endpoint to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests, if fulfillment_orders_opt_in is set to true .</p><p>[As of the 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation), it’s mandatory for a fulfillment service to follow a fulfillment order based workflow by having fulfillment_orders_opt_in set to true , hosting the <callbackUrl>/fulfillment_order_notification endpoint, and acting on fulfillment requests and cancellations.</p><p>For more information, refer to [Receive fulfillment requests and cancellations](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations). - Shopify sends GET requests to the <callbackUrl>/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders, if trackingSupport is set to true .</p><p>For more information, refer to [Enable tracking support](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-8-enable-tracking-support-optional).</p><p>Fulfillment services can also update tracking information with the [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation, rather than waiting for Shopify to ask for tracking numbers. - Shopify sends GET requests to the <callbackUrl>/fetch_stock endpoint to retrieve inventory levels, if inventoryManagement is set to true .</p><p>For more information, refer to [Sharing inventory levels with Shopify](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-9-share-inventory-levels-with-shopify-optional).</p><p>To make sure you have everything set up correctly, you can test the callbackUrl -prefixed endpoints in your development store.</p><p>## Resources and webhooks</p><p>There are a variety of objects and webhooks that enable a fulfillment service to work. To exchange fulfillment information with Shopify, fulfillment services use the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder), [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) and [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) objects and related mutations. To act on fulfillment process events that happen on the Shopify side, besides awaiting calls to callbackUrl -prefixed endpoints, fulfillment services can subscribe to the [fulfillment order](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) and [order](https://shopify.dev/api/admin-rest/latest/resources/webhook) webhooks.</p> |
FulfillmentServiceCreatePayload |
Return type for fulfillmentServiceCreate mutation. |
FulfillmentServiceDeletePayload |
Return type for fulfillmentServiceDelete mutation. |
FulfillmentServiceUpdatePayload |
Return type for fulfillmentServiceUpdate mutation. |
FulfillmentTrackingInfo |
Represents the tracking information for a fulfillment. |
FulfillmentTrackingInfoArgs |
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. |
FulfillmentTrackingInfoUpdateV2Payload |
Return type for fulfillmentTrackingInfoUpdateV2 mutation. |
FulfillmentTrackingInput |
<p>The input fields that specify all possible fields for tracking information.</p><p>> Note: > If you provide the url field, you should not provide the urls field. > > If you provide the number field, you should not provide the numbers field. > > If you provide the url field, you should provide the number field. > > If you provide the urls field, you should provide the numbers field.</p> |
FulfillmentV2Input |
The input fields used to create a fulfillment from fulfillment orders. |
FunctionsAppBridge |
The App Bridge information for a Shopify Function. |
FunctionsErrorHistory |
The error history from running a Shopify Function. |
GenericFile |
Represents any file other than HTML. |
GiftCard |
Represents an issued gift card. |
GiftCardConnection |
An auto-generated type for paginating through multiple GiftCards. |
GiftCardCreateInput |
The input fields to issue a gift card. |
GiftCardCreatePayload |
Return type for giftCardCreate mutation. |
GiftCardDisablePayload |
Return type for giftCardDisable mutation. |
GiftCardEdge |
An auto-generated type which holds one GiftCard and a cursor during pagination. |
GiftCardSale |
A sale associated with a gift card. |
GiftCardUpdateInput |
The input fields to update a gift card. |
GiftCardUpdatePayload |
Return type for giftCardUpdate mutation. |
GiftCardUserError |
Represents an error that happens during the execution of a gift card mutation. |
HasEvents |
Represents an object that has a list of events. |
HasEventsEventsArgs |
Represents an object that has a list of events. |
HasLocalizationExtensions |
Localization extensions associated with the specified resource. For example, the tax id for government invoice. |
HasLocalizationExtensionsLocalizationExtensionsArgs |
Localization extensions associated with the specified resource. For example, the tax id for government invoice. |
HasMetafieldDefinitions |
Resources that metafield definitions can be applied to. |
HasMetafieldDefinitionsMetafieldDefinitionsArgs |
Resources that metafield definitions can be applied to. |
HasMetafields |
Represents information about the metafields associated to the specified resource. |
HasMetafieldsMetafieldArgs |
Represents information about the metafields associated to the specified resource. |
HasMetafieldsMetafieldsArgs |
Represents information about the metafields associated to the specified resource. |
HasMetafieldsPrivateMetafieldArgs |
Represents information about the metafields associated to the specified resource. |
HasMetafieldsPrivateMetafieldsArgs |
Represents information about the metafields associated to the specified resource. |
HasPublishedTranslations |
Published translations associated with the resource. |
HasPublishedTranslationsTranslationsArgs |
Published translations associated with the resource. |
Image |
Represents an image resource. |
ImageConnection |
An auto-generated type for paginating through multiple Images. |
ImageEdge |
An auto-generated type which holds one Image and a cursor during pagination. |
ImageInput |
The input fields for an image. |
ImageMetafieldArgs |
Represents an image resource. |
ImageMetafieldsArgs |
Represents an image resource. |
ImagePrivateMetafieldArgs |
Represents an image resource. |
ImagePrivateMetafieldsArgs |
Represents an image resource. |
ImageTransformedSrcArgs |
Represents an image resource. |
ImageTransformInput |
<p>The available options for transforming an image.</p><p>All transformation options are considered best effort. Any transformation that the original image type doesn’t support will be ignored.</p> |
ImageUploadParameter |
<p>A parameter to upload an image.</p><p>Deprecated in favor of [StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter), which is used in [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget) and returned by the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).</p> |
ImageUrlArgs |
Represents an image resource. |
IncomingRequestLineItemInput |
The input fields for the incoming line item. |
InventoryActivatePayload |
Return type for inventoryActivate mutation. |
InventoryAdjustItemInput |
The input fields for items and their adjustments. |
InventoryAdjustmentGroup |
Represents a group of adjustments made as part of the same operation. |
InventoryAdjustmentGroupChangesArgs |
Represents a group of adjustments made as part of the same operation. |
InventoryAdjustQuantitiesInput |
The input fields required to adjust inventory quantities. |
InventoryAdjustQuantitiesPayload |
Return type for inventoryAdjustQuantities mutation. |
InventoryAdjustQuantitiesUserError |
An error that occurs during the execution of InventoryAdjustQuantities . |
InventoryAdjustQuantityInput |
The input fields required to adjust the inventory quantity. |
InventoryAdjustQuantityPayload |
Return type for inventoryAdjustQuantity mutation. |
InventoryBulkAdjustQuantityAtLocationPayload |
Return type for inventoryBulkAdjustQuantityAtLocation mutation. |
InventoryBulkToggleActivationInput |
The input fields to specify whether the inventory item should be activated or not at the specified location. |
InventoryBulkToggleActivationPayload |
Return type for inventoryBulkToggleActivation mutation. |
InventoryBulkToggleActivationUserError |
An error that occurred while setting the activation status of an inventory item. |
InventoryChange |
Represents a change in an inventory quantity of an inventory item at a location. |
InventoryChangeInput |
The input fields for the change to be made to an inventory item at a location. |
InventoryDeactivatePayload |
Return type for inventoryDeactivate mutation. |
InventoryItem |
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. |
InventoryItemConnection |
An auto-generated type for paginating through multiple InventoryItems. |
InventoryItemCountryHarmonizedSystemCodesArgs |
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. |
InventoryItemEdge |
An auto-generated type which holds one InventoryItem and a cursor during pagination. |
InventoryItemInput |
The input fields for an inventory item. |
InventoryItemInventoryLevelArgs |
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. |
InventoryItemInventoryLevelsArgs |
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. |
InventoryItemUpdateInput |
The input fields for an inventory item. |
InventoryItemUpdatePayload |
Return type for inventoryItemUpdate mutation. |
InventoryLevel |
The quantities of an inventory item that are related to a specific location. |
InventoryLevelConnection |
An auto-generated type for paginating through multiple InventoryLevels. |
InventoryLevelEdge |
An auto-generated type which holds one InventoryLevel and a cursor during pagination. |
InventoryLevelInput |
The input fields for an inventory level. |
InventoryLevelQuantitiesArgs |
The quantities of an inventory item that are related to a specific location. |
InventoryMoveQuantitiesInput |
The input fields required to move inventory quantities. |
InventoryMoveQuantitiesPayload |
Return type for inventoryMoveQuantities mutation. |
InventoryMoveQuantitiesUserError |
An error that occurs during the execution of InventoryMoveQuantities . |
InventoryMoveQuantityChange |
Represents the change to be made to an inventory item at a location. The change can either involve the same quantity name between different locations, or involve different quantity names between the same location. |
InventoryMoveQuantityTerminalInput |
The input fields representing the change to be made to an inventory item at a location. |
InventoryProperties |
General inventory properties for the shop. |
InventoryQuantity |
Represents a quantity of an inventory item at a specific location, for a specific name. |
InventoryQuantityName |
Details about an individual quantity name. |
InventorySetOnHandQuantitiesInput |
The input fields required to set inventory on hand quantities. |
InventorySetOnHandQuantitiesPayload |
Return type for inventorySetOnHandQuantities mutation. |
InventorySetOnHandQuantitiesUserError |
An error that occurs during the execution of InventorySetOnHandQuantities . |
InventorySetQuantityInput |
The input fields for the quantity to be set for an inventory item at a location. |
Job |
A job corresponds to some long running task that the client should poll for status. |
JobResult |
A job corresponds to some long running task that the client should poll for status. |
LegacyInteroperability |
Interoperability metadata for types that directly correspond to a REST Admin API resource. For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API. |
LimitedPendingOrderCount |
The total number of pending orders on a shop if less then a maximum, or that maximum. The atMax field indicates when this maximum has been reached. |
LineItem |
Represents individual products and quantities purchased in the associated order. |
LineItemConnection |
An auto-generated type for paginating through multiple LineItems. |
LineItemEdge |
An auto-generated type which holds one LineItem and a cursor during pagination. |
LineItemGroup |
A line item group (bundle) to which a line item belongs to. |
LineItemMutable |
Represents a single line item on an order. |
LineItemMutableConnection |
An auto-generated type for paginating through multiple LineItemMutables. |
LineItemMutableEdge |
An auto-generated type which holds one LineItemMutable and a cursor during pagination. |
LineItemMutableTaxLinesArgs |
Represents a single line item on an order. |
LineItemSellingPlan |
Represents the selling plan for a line item. |
LineItemTaxLinesArgs |
Represents individual products and quantities purchased in the associated order. |
Link |
A link to direct users to. |
LinkTranslationsArgs |
A link to direct users to. |
Locale |
A locale. |
LocalizationExtension |
Represents the value captured by a localization extension. Localization extensions are additional fields required by certain countries on international orders. For example, some countries require additional fields for customs information or tax identification numbers. |
LocalizationExtensionConnection |
An auto-generated type for paginating through multiple LocalizationExtensions. |
LocalizationExtensionEdge |
An auto-generated type which holds one LocalizationExtension and a cursor during pagination. |
LocalizationExtensionInput |
The input fields for a LocalizationExtensionInput. |
Location |
Represents the location where the physical good resides. |
LocationActivatePayload |
Return type for locationActivate mutation. |
LocationActivateUserError |
An error that occurs while activating a location. |
LocationAddAddressInput |
The input fields to use to specify the address while adding a location. |
LocationAddInput |
The input fields to use to add a location. |
LocationAddPayload |
Return type for locationAdd mutation. |
LocationAddress |
Represents the address of a location. |
LocationAddUserError |
An error that occurs while adding a location. |
LocationConnection |
An auto-generated type for paginating through multiple Locations. |
LocationDeactivatePayload |
Return type for locationDeactivate mutation. |
LocationDeactivateUserError |
The possible errors that can be returned when executing the locationDeactivate mutation. |
LocationDeletePayload |
Return type for locationDelete mutation. |
LocationDeleteUserError |
An error that occurs while deleting a location. |
LocationEdge |
An auto-generated type which holds one Location and a cursor during pagination. |
LocationEditAddressInput |
The input fields to use to edit the address of a location. |
LocationEditInput |
The input fields to use to edit a location. |
LocationEditPayload |
Return type for locationEdit mutation. |
LocationEditUserError |
An error that occurs while editing a location. |
LocationInventoryLevelArgs |
Represents the location where the physical good resides. |
LocationInventoryLevelsArgs |
Represents the location where the physical good resides. |
LocationLocalPickupDisablePayload |
Return type for locationLocalPickupDisable mutation. |
LocationLocalPickupEnablePayload |
Return type for locationLocalPickupEnable mutation. |
LocationMetafieldArgs |
Represents the location where the physical good resides. |
LocationMetafieldDefinitionsArgs |
Represents the location where the physical good resides. |
LocationMetafieldsArgs |
Represents the location where the physical good resides. |
LocationPrivateMetafieldArgs |
Represents the location where the physical good resides. |
LocationPrivateMetafieldsArgs |
Represents the location where the physical good resides. |
LocationSuggestedAddress |
Represents a suggested address for a location. |
MailingAddress |
<p>Represents a customer mailing address.</p><p>For example, a customer’s default address and an order’s billing address are both mailling addresses.</p> |
MailingAddressConnection |
An auto-generated type for paginating through multiple MailingAddresses. |
MailingAddressEdge |
An auto-generated type which holds one MailingAddress and a cursor during pagination. |
MailingAddressFormattedArgs |
<p>Represents a customer mailing address.</p><p>For example, a customer’s default address and an order’s billing address are both mailling addresses.</p> |
MailingAddressInput |
The input fields to create or update a mailing address. |
ManualDiscountApplication |
<p>Manual discount applications capture the intentions of a discount that was manually created for an order.</p><p>Discount applications don’t represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.</p> |
Market |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketCatalog |
A list of products with publishing and pricing information associated with markets. |
MarketCatalogConnection |
An auto-generated type for paginating through multiple MarketCatalogs. |
MarketCatalogEdge |
An auto-generated type which holds one MarketCatalog and a cursor during pagination. |
MarketCatalogMarketsArgs |
A list of products with publishing and pricing information associated with markets. |
MarketCatalogsArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketConnection |
An auto-generated type for paginating through multiple Markets. |
MarketCreateInput |
The input fields required to create a market. |
MarketCreatePayload |
Return type for marketCreate mutation. |
MarketCurrencySettings |
A market’s currency settings. |
MarketCurrencySettingsUpdateInput |
The input fields used to update the currency settings of a market. |
MarketCurrencySettingsUpdatePayload |
Return type for marketCurrencySettingsUpdate mutation. |
MarketCurrencySettingsUserError |
Error codes for failed market multi-currency operations. |
MarketDeletePayload |
Return type for marketDelete mutation. |
MarketEdge |
An auto-generated type which holds one Market and a cursor during pagination. |
MarketingActivity |
The marketing activity resource represents marketing that a merchant created through an app. |
MarketingActivityBudgetInput |
The input fields combining budget amount and its marketing budget type. |
MarketingActivityConnection |
An auto-generated type for paginating through multiple MarketingActivities. |
MarketingActivityCreateExternalInput |
The input fields for creating an externally-managed marketing activity. |
MarketingActivityCreateExternalPayload |
Return type for marketingActivityCreateExternal mutation. |
MarketingActivityCreateInput |
The input fields required to create a marketing activity. |
MarketingActivityCreatePayload |
Return type for marketingActivityCreate mutation. |
MarketingActivityEdge |
An auto-generated type which holds one MarketingActivity and a cursor during pagination. |
MarketingActivityExtensionAppErrors |
Represents errors returned from apps when using the marketing activity extension. |
MarketingActivityUpdateExternalInput |
The input fields required to update an externally managed marketing activity. |
MarketingActivityUpdateExternalPayload |
Return type for marketingActivityUpdateExternal mutation. |
MarketingActivityUpdateInput |
The input fields required to update a marketing activity. |
MarketingActivityUpdatePayload |
Return type for marketingActivityUpdate mutation. |
MarketingActivityUserError |
An error that occurs during the execution of a Shopify Marketing mutation. |
MarketingBudget |
This type combines budget amount and its marketing budget type. |
MarketingEngagement |
Marketing engagement represents customer activity taken on a marketing activity or a marketing channel. |
MarketingEngagementCreatePayload |
Return type for marketingEngagementCreate mutation. |
MarketingEngagementInput |
The input fields for a marketing engagement. |
MarketingEvent |
Represents actions that market a merchant’s store or products. |
MarketingEventConnection |
An auto-generated type for paginating through multiple MarketingEvents. |
MarketingEventEdge |
An auto-generated type which holds one MarketingEvent and a cursor during pagination. |
MarketLocalizableContent |
The market localizable content of a resource’s field. |
MarketLocalizableResource |
A resource that has market localizable fields. |
MarketLocalizableResourceConnection |
An auto-generated type for paginating through multiple MarketLocalizableResources. |
MarketLocalizableResourceEdge |
An auto-generated type which holds one MarketLocalizableResource and a cursor during pagination. |
MarketLocalizableResourceMarketLocalizationsArgs |
A resource that has market localizable fields. |
MarketLocalization |
The market localization of a field within a resource, which is determined by the market ID. |
MarketLocalizationRegisterInput |
The input fields and values for creating or updating a market localization. |
MarketLocalizationsRegisterPayload |
Return type for marketLocalizationsRegister mutation. |
MarketLocalizationsRemovePayload |
Return type for marketLocalizationsRemove mutation. |
MarketMetafieldArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketMetafieldDefinitionsArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketMetafieldsArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketPrivateMetafieldArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketPrivateMetafieldsArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketRegion |
A geographic region which comprises a market. |
MarketRegionConnection |
An auto-generated type for paginating through multiple MarketRegions. |
MarketRegionCountry |
A country which comprises a market. |
MarketRegionCreateInput |
The input fields for creating a market region with exactly one required option. |
MarketRegionDeletePayload |
Return type for marketRegionDelete mutation. |
MarketRegionEdge |
An auto-generated type which holds one MarketRegion and a cursor during pagination. |
MarketRegionsArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketRegionsCreatePayload |
Return type for marketRegionsCreate mutation. |
MarketUpdateInput |
The input fields used to update a market. |
MarketUpdatePayload |
Return type for marketUpdate mutation. |
MarketUserError |
Defines errors encountered while managing a Market. |
MarketWebPresence |
<p>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](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).</p><p>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](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in this market.</p> |
MarketWebPresenceConnection |
An auto-generated type for paginating through multiple MarketWebPresences. |
MarketWebPresenceCreateInput |
The input fields used to create a web presence for a market. |
MarketWebPresenceCreatePayload |
Return type for marketWebPresenceCreate mutation. |
MarketWebPresenceDeletePayload |
Return type for marketWebPresenceDelete mutation. |
MarketWebPresenceEdge |
An auto-generated type which holds one MarketWebPresence and a cursor during pagination. |
MarketWebPresenceRootUrl |
The URL for the homepage of the online store in the context of a particular market and a particular locale. |
MarketWebPresencesArgs |
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](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). |
MarketWebPresenceUpdateInput |
The input fields used to update a web presence for a market. |
MarketWebPresenceUpdatePayload |
Return type for marketWebPresenceUpdate mutation. |
Media |
Represents a media interface. |
MediaConnection |
An auto-generated type for paginating through multiple Media. |
MediaEdge |
An auto-generated type which holds one Media and a cursor during pagination. |
MediaError |
Represents a media error. This typically occurs when there is an issue with the media itself causing it to fail validation. Check the media before attempting to upload again. |
MediaImage |
An image hosted on Shopify. |
MediaImageMetafieldArgs |
An image hosted on Shopify. |
MediaImageMetafieldsArgs |
An image hosted on Shopify. |
MediaImageOriginalSource |
The original source for an image. |
MediaImagePrivateMetafieldArgs |
An image hosted on Shopify. |
MediaImagePrivateMetafieldsArgs |
An image hosted on Shopify. |
MediaPreviewImage |
Represents the preview image for a media. |
MediaUserError |
Represents an error that happens during execution of a Media query or mutation. |
MediaWarning |
Represents a media warning. This occurs when there is a non-blocking concern regarding your media. Consider reviewing your media to ensure it is correct and its parameters are as expected. |
MerchantApprovalSignals |
Merchant approval for accelerated onboarding to channel integration apps. |
Metafield |
Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/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. |
MetafieldAccess |
The access settings for this metafield definition. |
MetafieldAccessGrant |
An explicit access grant for the metafields under this definition. |
MetafieldAccessGrantDeleteInput |
The input fields for an explicit access grant to be deleted for the metafields under this definition. |
MetafieldAccessGrantInput |
The input fields for an explicit access grant to be created or updated for the metafields under this definition. |
MetafieldAccessGrantOperationInput |
The input fields for possible operations for modifying access grants. Exactly one option is required. |
MetafieldAccessInput |
The input fields for the access settings for the metafields under the definition. |
MetafieldAccessUpdateInput |
The input fields for the access settings for the metafields under the definition. |
MetafieldConnection |
An auto-generated type for paginating through multiple Metafields. |
MetafieldDefinition |
Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context. |
MetafieldDefinitionConnection |
An auto-generated type for paginating through multiple MetafieldDefinitions. |
MetafieldDefinitionCreatePayload |
Return type for metafieldDefinitionCreate mutation. |
MetafieldDefinitionCreateUserError |
An error that occurs during the execution of MetafieldDefinitionCreate . |
MetafieldDefinitionDeletePayload |
Return type for metafieldDefinitionDelete mutation. |
MetafieldDefinitionDeleteUserError |
An error that occurs during the execution of MetafieldDefinitionDelete . |
MetafieldDefinitionEdge |
An auto-generated type which holds one MetafieldDefinition and a cursor during pagination. |
MetafieldDefinitionInput |
The input fields required to create a metafield definition. |
MetafieldDefinitionMetafieldsArgs |
Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context. |
MetafieldDefinitionMetafieldsCountArgs |
Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context. |
MetafieldDefinitionPinPayload |
Return type for metafieldDefinitionPin mutation. |
MetafieldDefinitionPinUserError |
An error that occurs during the execution of MetafieldDefinitionPin . |
MetafieldDefinitionSupportedValidation |
<p>The type and name for the optional validation configuration of a metafield.</p><p>For example, a supported validation might consist of a max name and a number_integer type. This validation can then be used to enforce a maximum character length for a single_line_text_field metafield.</p> |
MetafieldDefinitionType |
A metafield definition type provides basic foundation and validation for a metafield. |
MetafieldDefinitionUnpinPayload |
Return type for metafieldDefinitionUnpin mutation. |
MetafieldDefinitionUnpinUserError |
An error that occurs during the execution of MetafieldDefinitionUnpin . |
MetafieldDefinitionUpdateInput |
The input fields required to update a metafield definition. |
MetafieldDefinitionUpdatePayload |
Return type for metafieldDefinitionUpdate mutation. |
MetafieldDefinitionUpdateUserError |
An error that occurs during the execution of MetafieldDefinitionUpdate . |
MetafieldDefinitionValidation |
<p>A configured metafield definition validation.</p><p>For example, for a metafield definition of number_integer type, you can set a validation with the name max and a value of 15 . This validation will ensure that the value of the metafield is a number less than or equal to 15.</p><p>Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).</p> |
MetafieldDefinitionValidationInput |
<p>The name and value for a metafield definition validation.</p><p>For example, for a metafield definition of single_line_text_field type, you can set a validation with the name min and a value of 10 . This validation will ensure that the value of the metafield is at least 10 characters.</p><p>Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).</p> |
MetafieldDeleteInput |
The input fields to delete a metafield. |
MetafieldDeletePayload |
Return type for metafieldDelete mutation. |
MetafieldEdge |
An auto-generated type which holds one Metafield and a cursor during pagination. |
MetafieldInput |
The input fields to use to create or update a metafield through a mutation on the owning resource. An alternative way to create or update a metafield is by using the [metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation. |
MetafieldReferenceConnection |
An auto-generated type for paginating through multiple MetafieldReferences. |
MetafieldReferenceEdge |
An auto-generated type which holds one MetafieldReference and a cursor during pagination. |
MetafieldReferencesArgs |
Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/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. |
MetafieldRelation |
Defines a relation between two resources via a reference metafield. The referencer owns the joining field with a given namespace and key, while the target is referenced by the field. |
MetafieldRelationConnection |
An auto-generated type for paginating through multiple MetafieldRelations. |
MetafieldRelationEdge |
An auto-generated type which holds one MetafieldRelation and a cursor during pagination. |
MetafieldsSetInput |
The input fields for a metafield value to set. |
MetafieldsSetPayload |
Return type for metafieldsSet mutation. |
MetafieldsSetUserError |
An error that occurs during the execution of MetafieldsSet . |
MetafieldStorefrontVisibility |
<p>By default, the Storefront API can’t read metafields. To make specific metafields visible in the Storefront API, you need to create a MetafieldStorefrontVisibility record. A MetafieldStorefrontVisibility record is a list of the metafields, defined by the owner_type , namespace , and key , to make visible in the Storefront API.</p><p>Learn about [exposing metafields in the Storefront API] (https://shopify.dev/custom-storefronts/products-collections/metafields) for more details.</p> |
MetafieldStorefrontVisibilityConnection |
An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities. |
MetafieldStorefrontVisibilityCreatePayload |
Return type for metafieldStorefrontVisibilityCreate mutation. |
MetafieldStorefrontVisibilityDeletePayload |
Return type for metafieldStorefrontVisibilityDelete mutation. |
MetafieldStorefrontVisibilityEdge |
An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination. |
MetafieldStorefrontVisibilityInput |
The input fields to create a MetafieldStorefrontVisibility record. |
Metaobject |
Provides an object instance represented by a MetaobjectDefinition. |
MetaobjectAccess |
Provides metaobject definition’s access configuration. |
MetaobjectAccessInput |
The input fields for configuring metaobject access controls. |
MetaobjectBulkDeletePayload |
Return type for metaobjectBulkDelete mutation. |
MetaobjectBulkDeleteWhereCondition |
Specifies the condition by which metaobjects are deleted. Exactly one field of input is required. |
MetaobjectCapabilities |
Provides the capabilities of a metaobject definition. |
MetaobjectCapabilitiesOnlineStore |
The Online Store capability of a metaobject definition. |
MetaobjectCapabilitiesPublishable |
The publishable capability of a metaobject definition. |
MetaobjectCapabilitiesRenderable |
The renderable capability of a metaobject definition. |
MetaobjectCapabilitiesTranslatable |
The translatable capability of a metaobject definition. |
MetaobjectCapabilityCreateInput |
The input fields for creating a metaobject capability. |
MetaobjectCapabilityData |
Provides the capabilities of a metaobject. |
MetaobjectCapabilityDataInput |
The input fields for metaobject capabilities. |
MetaobjectCapabilityDataOnlineStore |
The Online Store capability for the parent metaobject. |
MetaobjectCapabilityDataOnlineStoreInput |
The input fields for the Online Store capability to control renderability on the Online Store. |
MetaobjectCapabilityDataPublishable |
The publishable capability for the parent metaobject. |
MetaobjectCapabilityDataPublishableInput |
The input fields for publishable capability to adjust visibility on channels. |
MetaobjectCapabilityDefinitionDataOnlineStore |
The Online Store capability data for the metaobject definition. |
MetaobjectCapabilityDefinitionDataOnlineStoreInput |
The input fields of the Online Store capability. |
MetaobjectCapabilityDefinitionDataRenderable |
The renderable capability data for the metaobject definition. |
MetaobjectCapabilityDefinitionDataRenderableInput |
The input fields of the renderable capability for SEO aliases. |
MetaobjectCapabilityOnlineStoreInput |
The input fields for enabling and disabling the Online Store capability. |
MetaobjectCapabilityPublishableInput |
The input fields for enabling and disabling the publishable capability. |
MetaobjectCapabilityRenderableInput |
The input fields for enabling and disabling the renderable capability. |
MetaobjectCapabilityTranslatableInput |
The input fields for enabling and disabling the translatable capability. |
MetaobjectCapabilityUpdateInput |
The input fields for updating a metaobject capability. |
MetaobjectConnection |
An auto-generated type for paginating through multiple Metaobjects. |
MetaobjectCreateInput |
The input fields for creating a metaobject. |
MetaobjectCreatePayload |
Return type for metaobjectCreate mutation. |
MetaobjectDefinition |
Provides the definition of a generic object structure composed of metafields. |
MetaobjectDefinitionConnection |
An auto-generated type for paginating through multiple MetaobjectDefinitions. |
MetaobjectDefinitionCreateInput |
The input fields for creating a metaobject definition. |
MetaobjectDefinitionCreatePayload |
Return type for metaobjectDefinitionCreate mutation. |
MetaobjectDefinitionDeletePayload |
Return type for metaobjectDefinitionDelete mutation. |
MetaobjectDefinitionEdge |
An auto-generated type which holds one MetaobjectDefinition and a cursor during pagination. |
MetaobjectDefinitionMetaobjectsArgs |
Provides the definition of a generic object structure composed of metafields. |
MetaobjectDefinitionUpdateInput |
The input fields for updating a metaobject definition. |
MetaobjectDefinitionUpdatePayload |
Return type for metaobjectDefinitionUpdate mutation. |
MetaobjectDeletePayload |
Return type for metaobjectDelete mutation. |
MetaobjectEdge |
An auto-generated type which holds one Metaobject and a cursor during pagination. |
MetaobjectField |
Provides a field definition and the data value assigned to it. |
MetaobjectFieldArgs |
Provides an object instance represented by a MetaobjectDefinition. |
MetaobjectFieldDefinition |
Defines a field for a MetaobjectDefinition with properties such as the field’s data type and validations. |
MetaobjectFieldDefinitionCreateInput |
The input fields for creating a metaobject field definition. |
MetaobjectFieldDefinitionDeleteInput |
The input fields for deleting a metaobject field definition. |
MetaobjectFieldDefinitionOperationInput |
The input fields for possible operations for modifying field definitions. Exactly one option is required. |
MetaobjectFieldDefinitionUpdateInput |
The input fields for updating a metaobject field definition. |
MetaobjectFieldInput |
The input fields for a metaobject field value. |
MetaobjectFieldReferencesArgs |
Provides a field definition and the data value assigned to it. |
MetaobjectHandleInput |
The input fields for retrieving a metaobject by handle. |
MetaobjectReferencedByArgs |
Provides an object instance represented by a MetaobjectDefinition. |
MetaobjectUpdateInput |
The input fields for updating a metaobject. |
MetaobjectUpdatePayload |
Return type for metaobjectUpdate mutation. |
MetaobjectUpsertInput |
The input fields for upserting a metaobject. |
MetaobjectUpsertPayload |
Return type for metaobjectUpsert mutation. |
MetaobjectUserError |
Defines errors encountered while managing metaobject resources. |
Model3d |
Represents a Shopify hosted 3D model. |
Model3dBoundingBox |
Bounding box information of a 3d model. |
Model3dSource |
<p>A source for a Shopify-hosted 3d model.</p><p>Types of sources include GLB and USDZ formatted 3d models, where the former is an original 3d model and the latter has been converted from the original.</p><p>If the original source is in GLB format and over 15 MBs in size, then both the original and the USDZ formatted source are optimized to reduce the file size.</p> |
MoneyBag |
A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions, when an amount in the shop’s currency is converted to the customer’s currency of choice (the presentment currency). |
MoneyInput |
The input fields for a monetary value with currency. |
MoneyV2 |
A monetary value with currency. |
MoveInput |
The input fields for a single move of an object to a specific position in a set, using a zero-based index. |
Mutation |
The schema’s entry point for all mutation operations. |
MutationAbandonmentEmailStateUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationAbandonmentUpdateActivitiesDeliveryStatusesArgs |
The schema’s entry point for all mutation operations. |
MutationAppPurchaseOneTimeCreateArgs |
The schema’s entry point for all mutation operations. |
MutationAppSubscriptionCancelArgs |
The schema’s entry point for all mutation operations. |
MutationAppSubscriptionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationAppSubscriptionLineItemUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationAppSubscriptionTrialExtendArgs |
The schema’s entry point for all mutation operations. |
MutationAppUsageRecordCreateArgs |
The schema’s entry point for all mutation operations. |
MutationBulkOperationCancelArgs |
The schema’s entry point for all mutation operations. |
MutationBulkOperationRunMutationArgs |
The schema’s entry point for all mutation operations. |
MutationBulkOperationRunQueryArgs |
The schema’s entry point for all mutation operations. |
MutationBulkProductResourceFeedbackCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCartTransformCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCartTransformDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCatalogContextUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCatalogCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCatalogDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCatalogUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCheckoutBrandingUpsertArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionAddProductsArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionAddProductsV2Args |
The schema’s entry point for all mutation operations. |
MutationCollectionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionPublishArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionRemoveProductsArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionReorderProductsArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionUnpublishArgs |
The schema’s entry point for all mutation operations. |
MutationCollectionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCompaniesDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyAddressDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyAssignCustomerAsContactArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyAssignMainContactArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactAssignRoleArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactAssignRolesArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactRemoveFromCompanyArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactRevokeRoleArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactRevokeRolesArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactsDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactSendWelcomeEmailArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyContactUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationAssignAddressArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationAssignRolesArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationAssignTaxExemptionsArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationCreateTaxRegistrationArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationRevokeRolesArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationRevokeTaxExemptionsArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationRevokeTaxRegistrationArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationsDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyLocationUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyRevokeMainContactArgs |
The schema’s entry point for all mutation operations. |
MutationCompanyUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerAddTaxExemptionsArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerEmailMarketingConsentUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerGenerateAccountActivationUrlArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerMergeArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodCreateFromDuplicationDataArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodCreditCardCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodCreditCardUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodGetDuplicationDataArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodGetUpdateUrlArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodPaypalBillingAgreementCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodPaypalBillingAgreementUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodRemoteCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodRemoteCreditCardCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodRevokeArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerPaymentMethodSendUpdateEmailArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerRemoveTaxExemptionsArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerReplaceTaxExemptionsArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerSegmentMembersQueryCreateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerSmsMarketingConsentUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationCustomerUpdateDefaultAddressArgs |
The schema’s entry point for all mutation operations. |
MutationDelegateAccessTokenCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDelegateAccessTokenDestroyArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryCustomizationActivationArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryCustomizationCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryCustomizationDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryCustomizationUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryProfileCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryProfileRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryProfileUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDeliverySettingUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDeliveryShippingOriginAssignArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticActivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticAppCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticAppUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticBasicCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticBasicUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticBxgyCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticBxgyUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticFreeShippingCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountAutomaticFreeShippingUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeActivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeAppCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeAppUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBasicCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBasicUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBulkActivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBulkDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBxgyCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeBxgyUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeFreeShippingCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeFreeShippingUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountCodeRedeemCodeBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDiscountRedeemCodeBulkAddArgs |
The schema’s entry point for all mutation operations. |
MutationDisputeEvidenceUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderBulkAddTagsArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderBulkRemoveTagsArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderCalculateArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderCompleteArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderCreateArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderCreateFromOrderArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderCreateMerchantCheckoutArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderDuplicateArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderInvoicePreviewArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderInvoiceSendArgs |
The schema’s entry point for all mutation operations. |
MutationDraftOrderUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationEventBridgeServerPixelUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationEventBridgeWebhookSubscriptionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationEventBridgeWebhookSubscriptionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationFileAcknowledgeUpdateFailedArgs |
The schema’s entry point for all mutation operations. |
MutationFileCreateArgs |
The schema’s entry point for all mutation operations. |
MutationFileDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationFileUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationFlowTriggerReceiveArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentCancelArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentConstraintRuleCreateArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentConstraintRuleDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentCreateV2Args |
The schema’s entry point for all mutation operations. |
MutationFulfillmentEventCreateArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderAcceptCancellationRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderAcceptFulfillmentRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderCancelArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderCloseArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderHoldArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderLineItemsPreparedForPickupArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderMergeArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderMoveArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderOpenArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderRejectCancellationRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderRejectFulfillmentRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderReleaseHoldArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderRescheduleArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderSplitArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrdersReleaseHoldsArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrdersSetFulfillmentDeadlineArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderSubmitCancellationRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentOrderSubmitFulfillmentRequestArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentServiceCreateArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentServiceDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentServiceUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationFulfillmentTrackingInfoUpdateV2Args |
The schema’s entry point for all mutation operations. |
MutationGiftCardCreateArgs |
The schema’s entry point for all mutation operations. |
MutationGiftCardDisableArgs |
The schema’s entry point for all mutation operations. |
MutationGiftCardUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryActivateArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryAdjustQuantitiesArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryAdjustQuantityArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryBulkAdjustQuantityAtLocationArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryBulkToggleActivationArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryItemUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationInventoryMoveQuantitiesArgs |
The schema’s entry point for all mutation operations. |
MutationInventorySetOnHandQuantitiesArgs |
The schema’s entry point for all mutation operations. |
MutationLocationActivateArgs |
The schema’s entry point for all mutation operations. |
MutationLocationAddArgs |
The schema’s entry point for all mutation operations. |
MutationLocationDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationLocationDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationLocationEditArgs |
The schema’s entry point for all mutation operations. |
MutationLocationLocalPickupDisableArgs |
The schema’s entry point for all mutation operations. |
MutationLocationLocalPickupEnableArgs |
The schema’s entry point for all mutation operations. |
MutationMarketCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketCurrencySettingsUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMarketingActivityCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketingActivityCreateExternalArgs |
The schema’s entry point for all mutation operations. |
MutationMarketingActivityUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketingActivityUpdateExternalArgs |
The schema’s entry point for all mutation operations. |
MutationMarketingEngagementCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketLocalizationsRegisterArgs |
The schema’s entry point for all mutation operations. |
MutationMarketLocalizationsRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationMarketRegionDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMarketRegionsCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketWebPresenceCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMarketWebPresenceDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMarketWebPresenceUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDefinitionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDefinitionDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDefinitionPinArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDefinitionUnpinArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDefinitionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldsSetArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldStorefrontVisibilityCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMetafieldStorefrontVisibilityDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectDefinitionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectDefinitionDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectDefinitionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationMetaobjectUpsertArgs |
The schema’s entry point for all mutation operations. |
MutationOrderCaptureArgs |
The schema’s entry point for all mutation operations. |
MutationOrderCloseArgs |
The schema’s entry point for all mutation operations. |
MutationOrderCreateMandatePaymentArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditAddCustomItemArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditAddLineItemDiscountArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditAddVariantArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditBeginArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditCommitArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditRemoveLineItemDiscountArgs |
The schema’s entry point for all mutation operations. |
MutationOrderEditSetQuantityArgs |
The schema’s entry point for all mutation operations. |
MutationOrderInvoiceSendArgs |
The schema’s entry point for all mutation operations. |
MutationOrderMarkAsPaidArgs |
The schema’s entry point for all mutation operations. |
MutationOrderOpenArgs |
The schema’s entry point for all mutation operations. |
MutationOrderUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentCustomizationActivationArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentCustomizationCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentCustomizationDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentCustomizationUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentReminderSendArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentTermsCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentTermsDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPaymentTermsUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListFixedPricesAddArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListFixedPricesByProductUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListFixedPricesDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListFixedPricesUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceListUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleActivateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleDeactivateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleDiscountCodeCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleDiscountCodeUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPriceRuleUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPrivateMetafieldDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPrivateMetafieldUpsertArgs |
The schema’s entry point for all mutation operations. |
MutationProductAppendImagesArgs |
The schema’s entry point for all mutation operations. |
MutationProductChangeStatusArgs |
The schema’s entry point for all mutation operations. |
MutationProductCreateArgs |
The schema’s entry point for all mutation operations. |
MutationProductCreateMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationProductDeleteAsyncArgs |
The schema’s entry point for all mutation operations. |
MutationProductDeleteImagesArgs |
The schema’s entry point for all mutation operations. |
MutationProductDeleteMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductDuplicateArgs |
The schema’s entry point for all mutation operations. |
MutationProductDuplicateAsyncArgs |
The schema’s entry point for all mutation operations. |
MutationProductDuplicateAsyncV2Args |
The schema’s entry point for all mutation operations. |
MutationProductFeedCreateArgs |
The schema’s entry point for all mutation operations. |
MutationProductFeedDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationProductFullSyncArgs |
The schema’s entry point for all mutation operations. |
MutationProductImageUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationProductJoinSellingPlanGroupsArgs |
The schema’s entry point for all mutation operations. |
MutationProductLeaveSellingPlanGroupsArgs |
The schema’s entry point for all mutation operations. |
MutationProductPublishArgs |
The schema’s entry point for all mutation operations. |
MutationProductReorderImagesArgs |
The schema’s entry point for all mutation operations. |
MutationProductReorderMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductUnpublishArgs |
The schema’s entry point for all mutation operations. |
MutationProductUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationProductUpdateMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantAppendMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantCreateArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantDetachMediaArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantJoinSellingPlanGroupsArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantLeaveSellingPlanGroupsArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantRelationshipBulkUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantsBulkCreateArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantsBulkDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantsBulkReorderArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantsBulkUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationProductVariantUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPublicationCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPublicationDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationPublicationUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPublishablePublishArgs |
The schema’s entry point for all mutation operations. |
MutationPublishablePublishToCurrentChannelArgs |
The schema’s entry point for all mutation operations. |
MutationPublishableUnpublishArgs |
The schema’s entry point for all mutation operations. |
MutationPublishableUnpublishToCurrentChannelArgs |
The schema’s entry point for all mutation operations. |
MutationPubSubServerPixelUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationPubSubWebhookSubscriptionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationPubSubWebhookSubscriptionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationQuantityPricingByVariantUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationQuantityRulesAddArgs |
The schema’s entry point for all mutation operations. |
MutationQuantityRulesDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationRefundCreateArgs |
The schema’s entry point for all mutation operations. |
MutationReturnApproveRequestArgs |
The schema’s entry point for all mutation operations. |
MutationReturnCancelArgs |
The schema’s entry point for all mutation operations. |
MutationReturnCloseArgs |
The schema’s entry point for all mutation operations. |
MutationReturnCreateArgs |
The schema’s entry point for all mutation operations. |
MutationReturnDeclineRequestArgs |
The schema’s entry point for all mutation operations. |
MutationReturnRefundArgs |
The schema’s entry point for all mutation operations. |
MutationReturnReopenArgs |
The schema’s entry point for all mutation operations. |
MutationReturnRequestArgs |
The schema’s entry point for all mutation operations. |
MutationReverseDeliveryCreateWithShippingArgs |
The schema’s entry point for all mutation operations. |
MutationReverseDeliveryDisposeArgs |
The schema’s entry point for all mutation operations. |
MutationReverseDeliveryShippingUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationReverseFulfillmentOrderDisposeArgs |
The schema’s entry point for all mutation operations. |
MutationSavedSearchCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSavedSearchDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSavedSearchUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationScriptTagCreateArgs |
The schema’s entry point for all mutation operations. |
MutationScriptTagDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationScriptTagUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSegmentCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSegmentDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSegmentUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupAddProductsArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupAddProductVariantsArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupRemoveProductsArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupRemoveProductVariantsArgs |
The schema’s entry point for all mutation operations. |
MutationSellingPlanGroupUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationShippingPackageDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationShippingPackageMakeDefaultArgs |
The schema’s entry point for all mutation operations. |
MutationShippingPackageUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationShopLocaleDisableArgs |
The schema’s entry point for all mutation operations. |
MutationShopLocaleEnableArgs |
The schema’s entry point for all mutation operations. |
MutationShopLocaleUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationShopPolicyUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationShopResourceFeedbackCreateArgs |
The schema’s entry point for all mutation operations. |
MutationsStagedUploadTargetGenerateUploadParameter |
<p>A signed upload parameter for uploading an asset to Shopify.</p><p>Deprecated in favor of [StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter), which is used in [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget) and returned by the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).</p> |
MutationStagedUploadsCreateArgs |
The schema’s entry point for all mutation operations. |
MutationStagedUploadTargetGenerateArgs |
The schema’s entry point for all mutation operations. |
MutationStagedUploadTargetsGenerateArgs |
The schema’s entry point for all mutation operations. |
MutationStandardMetafieldDefinitionEnableArgs |
The schema’s entry point for all mutation operations. |
MutationStandardMetaobjectDefinitionEnableArgs |
The schema’s entry point for all mutation operations. |
MutationStorefrontAccessTokenCreateArgs |
The schema’s entry point for all mutation operations. |
MutationStorefrontAccessTokenDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingAttemptCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleContractDraftCommitArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleContractDraftConcatenateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleContractEditArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleEditDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleEditsDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionBillingCycleScheduleEditArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionContractAtomicCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionContractCreateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionContractProductChangeArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionContractSetNextBillingDateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionContractUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftCommitArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftDiscountAddArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftDiscountCodeApplyArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftDiscountRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftDiscountUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftFreeShippingDiscountAddArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftFreeShippingDiscountUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftLineAddArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftLineRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftLineUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationSubscriptionDraftUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationTagsAddArgs |
The schema’s entry point for all mutation operations. |
MutationTagsRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationTaxAppConfigureArgs |
The schema’s entry point for all mutation operations. |
MutationTranslationsRegisterArgs |
The schema’s entry point for all mutation operations. |
MutationTranslationsRemoveArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectBulkDeleteByIdsArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectBulkDeleteBySavedSearchArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectBulkDeleteBySearchArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectCreateArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectImportCreateArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectImportSubmitArgs |
The schema’s entry point for all mutation operations. |
MutationUrlRedirectUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationWebhookSubscriptionCreateArgs |
The schema’s entry point for all mutation operations. |
MutationWebhookSubscriptionDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationWebhookSubscriptionUpdateArgs |
The schema’s entry point for all mutation operations. |
MutationWebPixelCreateArgs |
The schema’s entry point for all mutation operations. |
MutationWebPixelDeleteArgs |
The schema’s entry point for all mutation operations. |
MutationWebPixelUpdateArgs |
The schema’s entry point for all mutation operations. |
Navigable |
<p>A default cursor that you can use in queries to paginate your results. Each edge in a connection can return a cursor, which is a reference to the edge’s position in the connection. You can use an edge’s cursor as the starting point to retrieve the nodes before or after it in a connection.</p><p>To learn more about using cursor-based pagination, refer to [Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql).</p> |
NavigationItem |
A navigation item, holding basic link attributes. |
Node |
An object with an ID field to support global identification, in accordance with the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. |
ObjectDimensionsInput |
The input fields for dimensions of an object. |
OnlineStoreArticle |
An article in the blogging system. You can query articles from [the REST API](https://shopify.dev/api/admin-rest/latest/resources/article) if you need to access more information about an article. Currently, OnlineStoreArticle is only useful to pass an article id to the tagsAdd mutation. For more information, refer to the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. |
OnlineStoreArticleTranslationsArgs |
An article in the blogging system. You can query articles from [the REST API](https://shopify.dev/api/admin-rest/latest/resources/article) if you need to access more information about an article. Currently, OnlineStoreArticle is only useful to pass an article id to the tagsAdd mutation. For more information, refer to the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. |
OnlineStoreBlog |
Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time. |
OnlineStoreBlogTranslationsArgs |
Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time. |
OnlineStorePage |
A custom page on the Online Store. |
OnlineStorePageTranslationsArgs |
A custom page on the Online Store. |
OnlineStorePreviewable |
Online Store preview URL of the object. |
Order |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderAgreement |
An agreement associated with an order placement. |
OrderAgreementSalesArgs |
An agreement associated with an order placement. |
OrderAgreementsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderApp |
The [application](https://shopify.dev/apps) that created the order. |
OrderCancellation |
Details about the order cancellation. |
OrderCaptureInput |
The input fields for the authorized transaction to capture and the total amount to capture from it. |
OrderCapturePayload |
Return type for orderCapture mutation. |
OrderCloseInput |
The input fields for specifying an open order to close. |
OrderClosePayload |
Return type for orderClose mutation. |
OrderConnection |
An auto-generated type for paginating through multiple Orders. |
OrderCreateMandatePaymentPayload |
Return type for orderCreateMandatePayment mutation. |
OrderCreateMandatePaymentUserError |
An error that occurs during the execution of OrderCreateMandatePayment . |
OrderDiscountApplicationsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderDisputeSummary |
A summary of the important details for a dispute on an order. |
OrderEdge |
An auto-generated type which holds one Order and a cursor during pagination. |
OrderEditAddCustomItemPayload |
Return type for orderEditAddCustomItem mutation. |
OrderEditAddLineItemDiscountPayload |
Return type for orderEditAddLineItemDiscount mutation. |
OrderEditAddVariantPayload |
Return type for orderEditAddVariant mutation. |
OrderEditAgreement |
An agreement associated with an edit to the order. |
OrderEditAgreementSalesArgs |
An agreement associated with an edit to the order. |
OrderEditAppliedDiscountInput |
The input fields used to add a discount during an order edit. |
OrderEditBeginPayload |
Return type for orderEditBegin mutation. |
OrderEditCommitPayload |
Return type for orderEditCommit mutation. |
OrderEditRemoveLineItemDiscountPayload |
Return type for orderEditRemoveLineItemDiscount mutation. |
OrderEditSetQuantityPayload |
Return type for orderEditSetQuantity mutation. |
OrderEventsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderExchangeV2sArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderFulfillmentOrdersArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderFulfillmentsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderInput |
The input fields for specifying the information to be updated on an order when using the orderUpdate mutation. |
OrderInvoiceSendPayload |
Return type for orderInvoiceSend mutation. |
OrderInvoiceSendUserError |
An error that occurs during the execution of OrderInvoiceSend . |
OrderLineItemsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderLineItemsMutableArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderLocalizationExtensionsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderMarkAsPaidInput |
The input fields for specifying the order to mark as paid. |
OrderMarkAsPaidPayload |
Return type for orderMarkAsPaid mutation. |
OrderMetafieldArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderMetafieldDefinitionsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderMetafieldsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderNonFulfillableLineItemsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderOpenInput |
The input fields for specifying a closed order to open. |
OrderOpenPayload |
Return type for orderOpen mutation. |
OrderPaymentCollectionDetails |
The payment collection details for an order that requires additional payment following an edit to the order. |
OrderPaymentStatus |
The status of a customer’s payment for an order. |
OrderPrivateMetafieldArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderPrivateMetafieldsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderRefundsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderReturnsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderRisk |
Represents a fraud check on an order. |
OrderRisksArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderShippingLinesArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderStagedChangeAddCustomItem |
A change to the order representing the addition of a custom line item. For example, you might want to add gift wrapping service as a custom line item. |
OrderStagedChangeAddLineItemDiscount |
The discount applied to an item that was added during the current order edit. |
OrderStagedChangeAddShippingLine |
A new [shipping line](https://shopify.dev/api/admin-graphql/latest/objects/shippingline) added as part of an order edit. |
OrderStagedChangeAddVariant |
A change to the order representing the addition of an existing product variant. |
OrderStagedChangeConnection |
An auto-generated type for paginating through multiple OrderStagedChanges. |
OrderStagedChangeDecrementItem |
An removal of items from an existing line item on the order. |
OrderStagedChangeEdge |
An auto-generated type which holds one OrderStagedChange and a cursor during pagination. |
OrderStagedChangeIncrementItem |
An addition of items to an existing line item on the order. |
OrderSuggestedRefundArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderTransaction |
A payment transaction in the context of an order. |
OrderTransactionConnection |
An auto-generated type for paginating through multiple OrderTransactions. |
OrderTransactionEdge |
An auto-generated type which holds one OrderTransaction and a cursor during pagination. |
OrderTransactionInput |
The input fields for the information needed to create an order transaction. |
OrderTransactionsArgs |
<p>An order is a customer’s request to purchase one or more products from a shop. You can retrieve and update orders using the Order object. Learn more about [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).</p><p>Only the last 60 days’ worth of orders from a store are accessible from the Order object by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the read_all_orders scope to your app along with read_orders or write_orders . [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.</p><p>**Caution:** Only use this data if it’s required for your app’s functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don’t have a legitimate use for the associated data.</p> |
OrderUpdatePayload |
Return type for orderUpdate mutation. |
PageInfo |
Returns information about pagination in a connection, in accordance with the [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). |
ParseError |
A ShopifyQL parsing error. |
ParseErrorRange |
A range of ShopifyQL parsing errors. |
PaymentCustomization |
A payment customization. |
PaymentCustomizationActivationPayload |
Return type for paymentCustomizationActivation mutation. |
PaymentCustomizationConnection |
An auto-generated type for paginating through multiple PaymentCustomizations. |
PaymentCustomizationCreatePayload |
Return type for paymentCustomizationCreate mutation. |
PaymentCustomizationDeletePayload |
Return type for paymentCustomizationDelete mutation. |
PaymentCustomizationEdge |
An auto-generated type which holds one PaymentCustomization and a cursor during pagination. |
PaymentCustomizationError |
An error that occurs during the execution of a payment customization mutation. |
PaymentCustomizationInput |
The input fields to create and update a payment customization. |
PaymentCustomizationMetafieldArgs |
A payment customization. |
PaymentCustomizationMetafieldDefinitionsArgs |
A payment customization. |
PaymentCustomizationMetafieldsArgs |
A payment customization. |
PaymentCustomizationPrivateMetafieldArgs |
A payment customization. |
PaymentCustomizationPrivateMetafieldsArgs |
A payment customization. |
PaymentCustomizationUpdatePayload |
Return type for paymentCustomizationUpdate mutation. |
PaymentMandate |
A payment instrument and the permission the owner of the instrument gives to the merchant to debit it. |
PaymentReminderSendPayload |
Return type for paymentReminderSend mutation. |
PaymentReminderSendUserError |
An error that occurs during the execution of PaymentReminderSend . |
PaymentSchedule |
Represents the payment schedule for a single payment defined in the payment terms. |
PaymentScheduleConnection |
An auto-generated type for paginating through multiple PaymentSchedules. |
PaymentScheduleEdge |
An auto-generated type which holds one PaymentSchedule and a cursor during pagination. |
PaymentScheduleInput |
The input fields used to create a payment schedule for payment terms. |
PaymentSettings |
Settings related to payments. |
PaymentTerms |
Represents the payment terms for an order or draft order. |
PaymentTermsCreateInput |
The input fields used to create a payment terms. |
PaymentTermsCreatePayload |
Return type for paymentTermsCreate mutation. |
PaymentTermsCreateUserError |
An error that occurs during the execution of PaymentTermsCreate . |
PaymentTermsDeleteInput |
The input fields used to delete the payment terms. |
PaymentTermsDeletePayload |
Return type for paymentTermsDelete mutation. |
PaymentTermsDeleteUserError |
An error that occurs during the execution of PaymentTermsDelete . |
PaymentTermsInput |
The input fields to create payment terms. Payment terms set the date that payment is due. |
PaymentTermsPaymentSchedulesArgs |
Represents the payment terms for an order or draft order. |
PaymentTermsTemplate |
Represents the payment terms template object. |
PaymentTermsUpdateInput |
The input fields used to update the payment terms. |
PaymentTermsUpdatePayload |
Return type for paymentTermsUpdate mutation. |
PaymentTermsUpdateUserError |
An error that occurs during the execution of PaymentTermsUpdate . |
PolarisVizDataPoint |
A PolarisViz data point structure for ShopifyQL query. |
PolarisVizDataSeries |
The data series used for PolarisViz visualization. |
PolarisVizResponse |
A PolarisViz response to a ShopifyQL query. |
PreparedFulfillmentOrderLineItemsInput |
The input fields used to include the line items of a specified fulfillment order that should be marked as prepared for pickup by a customer. |
PriceInput |
The input fields for updating the price of a parent product variant. |
PriceList |
<p>Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.</p><p>For more information on price lists, refer to [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).</p> |
PriceListAdjustment |
<p>The type and value of a price list adjustment.</p><p>For more information on price lists, refer to [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).</p> |
PriceListAdjustmentInput |
The input fields to set a price list adjustment. |
PriceListAdjustmentSettings |
Represents the settings of price list adjustments. |
PriceListAdjustmentSettingsInput |
The input fields to set a price list’s adjustment settings. |
PriceListConnection |
An auto-generated type for paginating through multiple PriceLists. |
PriceListCreateInput |
The input fields to create a price list. |
PriceListCreatePayload |
Return type for priceListCreate mutation. |
PriceListDeletePayload |
Return type for priceListDelete mutation. |
PriceListEdge |
An auto-generated type which holds one PriceList and a cursor during pagination. |
PriceListFixedPricesAddPayload |
Return type for priceListFixedPricesAdd mutation. |
PriceListFixedPricesByProductBulkUpdateUserError |
Error codes for failed price list fixed prices by product bulk update operations. |
PriceListFixedPricesByProductUpdatePayload |
Return type for priceListFixedPricesByProductUpdate mutation. |
PriceListFixedPricesDeletePayload |
Return type for priceListFixedPricesDelete mutation. |
PriceListFixedPricesUpdatePayload |
Return type for priceListFixedPricesUpdate mutation. |
PriceListParent |
<p>Represents relative adjustments from one price list to other prices. You can use a PriceListParent to specify an adjusted relative price using a percentage-based adjustment. Adjusted prices work in conjunction with exchange rules and rounding.</p><p>[Adjustment types](https://shopify.dev/api/admin-graphql/latest/enums/pricelistadjustmenttype) support both percentage increases and decreases.</p> |
PriceListParentCreateInput |
The input fields to create a price list adjustment. |
PriceListParentUpdateInput |
The input fields used to update a price list’s adjustment. |
PriceListPrice |
Represents information about pricing for a product variant as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant. |
PriceListPriceConnection |
An auto-generated type for paginating through multiple PriceListPrices. |
PriceListPriceEdge |
An auto-generated type which holds one PriceListPrice and a cursor during pagination. |
PriceListPriceInput |
The input fields for providing the fields and values to use when creating or updating a fixed price list price. |
PriceListPriceQuantityPriceBreaksArgs |
Represents information about pricing for a product variant as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant. |
PriceListPricesArgs |
<p>Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.</p><p>For more information on price lists, refer to [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).</p> |
PriceListPriceUserError |
An error for a failed price list price operation. |
PriceListProductPriceInput |
The input fields representing the price for all variants of a product. |
PriceListQuantityRulesArgs |
<p>Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.</p><p>For more information on price lists, refer to [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).</p> |
PriceListUpdateInput |
The input fields used to update a price list. |
PriceListUpdatePayload |
Return type for priceListUpdate mutation. |
PriceListUserError |
Error codes for failed contextual pricing operations. |
PriceRule |
<p>Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.</p><p>We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.</p> |
PriceRuleActivatePayload |
Return type for priceRuleActivate mutation. |
PriceRuleConnection |
An auto-generated type for paginating through multiple PriceRules. |
PriceRuleCreatePayload |
Return type for priceRuleCreate mutation. |
PriceRuleCustomerSelection |
A selection of customers for whom the price rule applies. |
PriceRuleCustomerSelectionCustomersArgs |
A selection of customers for whom the price rule applies. |
PriceRuleCustomerSelectionInput |
The input fields to update a price rule customer selection. |
PriceRuleDeactivatePayload |
Return type for priceRuleDeactivate mutation. |
PriceRuleDeletePayload |
Return type for priceRuleDelete mutation. |
PriceRuleDiscountCode |
A discount code of a price rule. |
PriceRuleDiscountCodeConnection |
An auto-generated type for paginating through multiple PriceRuleDiscountCodes. |
PriceRuleDiscountCodeCreatePayload |
Return type for priceRuleDiscountCodeCreate mutation. |
PriceRuleDiscountCodeEdge |
An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination. |
PriceRuleDiscountCodeInput |
The input fields to manipulate a discount code. |
PriceRuleDiscountCodesArgs |
<p>Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.</p><p>We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.</p> |
PriceRuleDiscountCodeUpdatePayload |
Return type for priceRuleDiscountCodeUpdate mutation. |
PriceRuleEdge |
An auto-generated type which holds one PriceRule and a cursor during pagination. |
PriceRuleEntitlementToPrerequisiteQuantityRatio |
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. |
PriceRuleEntitlementToPrerequisiteQuantityRatioInput |
Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. |
PriceRuleEventsArgs |
<p>Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.</p><p>We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.</p> |
PriceRuleFixedAmountValue |
The value of a fixed amount price rule. |
PriceRuleInput |
The input fields to manipulate a price rule. |
PriceRuleItemEntitlements |
The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. |
PriceRuleItemEntitlementsCollectionsArgs |
The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. |
PriceRuleItemEntitlementsInput |
The input fields to update a price rule line item entitlement. |
PriceRuleItemEntitlementsProductsArgs |
The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. |
PriceRuleItemEntitlementsProductVariantsArgs |
The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. |
PriceRuleItemPrerequisitesInput |
The input fields to update a price rule’s item prerequisites. |
PriceRuleLineItemPrerequisites |
Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. |
PriceRuleLineItemPrerequisitesCollectionsArgs |
Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. |
PriceRuleLineItemPrerequisitesProductsArgs |
Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. |
PriceRuleLineItemPrerequisitesProductVariantsArgs |
Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. |
PriceRuleMoneyRange |
A money range within which the price rule is applicable. |
PriceRuleMoneyRangeInput |
The input fields to update the money range within which the price rule is applicable. |
PriceRulePercentValue |
The value of a percent price rule. |
PriceRulePrerequisiteToEntitlementQuantityRatio |
Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. |
PriceRulePrerequisiteToEntitlementQuantityRatioInput |
Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. |
PriceRuleQuantityRange |
A quantity range within which the price rule is applicable. |
PriceRuleQuantityRangeInput |
The input fields to update the quantity range within which the price rule is applicable. |
PriceRuleShareableUrl |
Shareable URL for the discount code associated with the price rule. |
PriceRuleShippingEntitlementsInput |
The input fields to update a price rule shipping entitlement. |
PriceRuleShippingLineEntitlements |
The shipping lines to which the price rule applies to. |
PriceRuleUpdatePayload |
Return type for priceRuleUpdate mutation. |
PriceRuleUserError |
Represents an error that happens during execution of a price rule mutation. |
PriceRuleValidityPeriod |
A time period during which a price rule is applicable. |
PriceRuleValidityPeriodInput |
The input fields to update the validity period of a price rule. |
PriceRuleValueInput |
The input fields to update a price rule. |
PricingPercentageValue |
One type of value given to a customer when a discount is applied to an order. The application of a discount with this value gives the customer the specified percentage off a specified item. |
PrivateMetafield |
<p>Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.</p><p>An application can create a maximum of 10 private metafields per shop resource.</p> |
PrivateMetafieldConnection |
An auto-generated type for paginating through multiple PrivateMetafields. |
PrivateMetafieldDeleteInput |
The input fields for the private metafield to delete. |
PrivateMetafieldDeletePayload |
Return type for privateMetafieldDelete mutation. |
PrivateMetafieldEdge |
An auto-generated type which holds one PrivateMetafield and a cursor during pagination. |
PrivateMetafieldInput |
The input fields for a private metafield. |
PrivateMetafieldUpsertPayload |
Return type for privateMetafieldUpsert mutation. |
PrivateMetafieldValueInput |
The input fields for the value and value type of the private metafield. |
Product |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductAppendImagesInput |
The input fields for specifying product images to append. |
ProductAppendImagesPayload |
Return type for productAppendImages mutation. |
ProductCategory |
The details of a specific product category within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt). |
ProductCategoryInput |
The input fields to use when adding a product category to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values. |
ProductChangeStatusPayload |
Return type for productChangeStatus mutation. |
ProductChangeStatusUserError |
An error that occurs during the execution of ProductChangeStatus . |
ProductClaimOwnershipInput |
The input fields to claim ownership for Product features such as Bundles. |
ProductCollectionsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductCompareAtPriceRange |
The compare-at price range of the product. |
ProductConnection |
An auto-generated type for paginating through multiple Products. |
ProductContextualPricing |
The price of a product in a specific country. Prices vary between countries. |
ProductContextualPricingArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductCreateMediaPayload |
Return type for productCreateMedia mutation. |
ProductCreatePayload |
Return type for productCreate mutation. |
ProductDeleteAsyncPayload |
Return type for productDeleteAsync mutation. |
ProductDeleteImagesPayload |
Return type for productDeleteImages mutation. |
ProductDeleteInput |
The input fields for specifying the product to delete. |
ProductDeleteMediaPayload |
Return type for productDeleteMedia mutation. |
ProductDeletePayload |
Return type for productDelete mutation. |
ProductDeleteUserError |
An error that occurred while setting the activation status of an inventory item. |
ProductDescriptionArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductDuplicateAsyncInput |
The input fields for the product async duplicate mutation. |
ProductDuplicateAsyncPayload |
Return type for productDuplicateAsync mutation. |
ProductDuplicateAsyncV2Payload |
Return type for productDuplicateAsyncV2 mutation. |
ProductDuplicateJob |
Represents a product duplication job. |
ProductDuplicatePayload |
Return type for productDuplicate mutation. |
ProductDuplicateUserError |
An error that occurred while duplicating the product. |
ProductEdge |
An auto-generated type which holds one Product and a cursor during pagination. |
ProductFeed |
A product feed. |
ProductFeedConnection |
An auto-generated type for paginating through multiple ProductFeeds. |
ProductFeedCreatePayload |
Return type for productFeedCreate mutation. |
ProductFeedCreateUserError |
An error that occurs during the execution of ProductFeedCreate . |
ProductFeedDeletePayload |
Return type for productFeedDelete mutation. |
ProductFeedDeleteUserError |
An error that occurs during the execution of ProductFeedDelete . |
ProductFeedEdge |
An auto-generated type which holds one ProductFeed and a cursor during pagination. |
ProductFeedInput |
The input fields required to create a product feed. |
ProductFullSyncPayload |
Return type for productFullSync mutation. |
ProductFullSyncUserError |
An error that occurs during the execution of ProductFullSync . |
ProductImagesArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductImageUpdatePayload |
Return type for productImageUpdate mutation. |
ProductInCollectionArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductInput |
The input fields required to create a product. |
ProductJoinSellingPlanGroupsPayload |
Return type for productJoinSellingPlanGroups mutation. |
ProductLeaveSellingPlanGroupsPayload |
Return type for productLeaveSellingPlanGroups mutation. |
ProductMediaArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductMetafieldArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductMetafieldDefinitionsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductMetafieldsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductOption |
The product property names. For example, “Size”, “Color”, and “Material”. Variants are selected based on permutations of these options. The limit for each product property name is 255 characters. |
ProductOptionsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductOptionTranslationsArgs |
The product property names. For example, “Size”, “Color”, and “Material”. Variants are selected based on permutations of these options. The limit for each product property name is 255 characters. |
ProductPriceRange |
The price range of the product. |
ProductPriceRangeV2 |
The price range of the product. |
ProductPrivateMetafieldArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPrivateMetafieldsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductProductPublicationsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublication |
Represents the channels where a product is published. |
ProductPublicationConnection |
An auto-generated type for paginating through multiple ProductPublications. |
ProductPublicationCountArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublicationEdge |
An auto-generated type which holds one ProductPublication and a cursor during pagination. |
ProductPublicationInput |
The input fields for specifying a publication to which a product will be published. |
ProductPublicationsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublishedInContextArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublishedOnChannelArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublishedOnPublicationArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductPublishInput |
The input fields for specifying a product to publish and the channels to publish it to. |
ProductPublishPayload |
Return type for productPublish mutation. |
ProductReorderImagesPayload |
Return type for productReorderImages mutation. |
ProductReorderMediaPayload |
Return type for productReorderMedia mutation. |
ProductResourceFeedback |
Reports the status of product for a Sales Channel or Storefront API. This might include why a product is not available in a Sales Channel and how a merchant might fix this. |
ProductResourceFeedbackInput |
The input fields used to create a product feedback. |
ProductResourcePublicationsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductResourcePublicationsV2Args |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductSale |
A sale associated with a product. |
ProductSellingPlanGroupsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductTaxonomyNode |
Represents a [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) node. |
ProductTranslationsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductUnpublishedChannelsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductUnpublishedPublicationsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductUnpublishInput |
The input fields for specifying a product to unpublish from a channel and the sales channels to unpublish it from. |
ProductUnpublishPayload |
Return type for productUnpublish mutation. |
ProductUpdateMediaPayload |
Return type for productUpdateMedia mutation. |
ProductUpdatePayload |
Return type for productUpdate mutation. |
ProductVariant |
Represents a product variant. |
ProductVariantAppendMediaInput |
The input fields required to append media to a single variant. |
ProductVariantAppendMediaPayload |
Return type for productVariantAppendMedia mutation. |
ProductVariantComponent |
A product variant component associated with a product variant. |
ProductVariantComponentConnection |
An auto-generated type for paginating through multiple ProductVariantComponents. |
ProductVariantComponentEdge |
An auto-generated type which holds one ProductVariantComponent and a cursor during pagination. |
ProductVariantConnection |
An auto-generated type for paginating through multiple ProductVariants. |
ProductVariantContextualPricing |
The price of a product variant in a specific country. Prices vary between countries. |
ProductVariantContextualPricingArgs |
Represents a product variant. |
ProductVariantContextualPricingQuantityPriceBreaksArgs |
The price of a product variant in a specific country. Prices vary between countries. |
ProductVariantCreatePayload |
Return type for productVariantCreate mutation. |
ProductVariantDeletePayload |
Return type for productVariantDelete mutation. |
ProductVariantDetachMediaInput |
The input fields required to detach media from a single variant. |
ProductVariantDetachMediaPayload |
Return type for productVariantDetachMedia mutation. |
ProductVariantEdge |
An auto-generated type which holds one ProductVariant and a cursor during pagination. |
ProductVariantGroupRelationshipInput |
The input fields for the bundle components for core. |
ProductVariantInput |
The input fields for specifying a product variant to create or update. |
ProductVariantJoinSellingPlanGroupsPayload |
Return type for productVariantJoinSellingPlanGroups mutation. |
ProductVariantLeaveSellingPlanGroupsPayload |
Return type for productVariantLeaveSellingPlanGroups mutation. |
ProductVariantMediaArgs |
Represents a product variant. |
ProductVariantMetafieldArgs |
Represents a product variant. |
ProductVariantMetafieldDefinitionsArgs |
Represents a product variant. |
ProductVariantMetafieldsArgs |
Represents a product variant. |
ProductVariantPositionInput |
The input fields representing a product variant position. |
ProductVariantPresentmentPricesArgs |
Represents a product variant. |
ProductVariantPricePair |
The compare-at price and price of a variant sharing a currency. |
ProductVariantPricePairConnection |
An auto-generated type for paginating through multiple ProductVariantPricePairs. |
ProductVariantPricePairEdge |
An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. |
ProductVariantPrivateMetafieldArgs |
Represents a product variant. |
ProductVariantPrivateMetafieldsArgs |
Represents a product variant. |
ProductVariantProductVariantComponentsArgs |
Represents a product variant. |
ProductVariantRelationshipBulkUpdatePayload |
Return type for productVariantRelationshipBulkUpdate mutation. |
ProductVariantRelationshipBulkUpdateUserError |
An error that occurs during the execution of ProductVariantRelationshipBulkUpdate . |
ProductVariantRelationshipUpdateInput |
The input fields for updating a composite product variant. |
ProductVariantsArgs |
The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). |
ProductVariantsBulkCreatePayload |
Return type for productVariantsBulkCreate mutation. |
ProductVariantsBulkCreateUserError |
Error codes for failed product variant bulk create mutations. |
ProductVariantsBulkDeletePayload |
Return type for productVariantsBulkDelete mutation. |
ProductVariantsBulkDeleteUserError |
Error codes for failed bulk variant delete mutations. |
ProductVariantsBulkInput |
The input fields for specifying a product variant to create as part of a variant bulk mutation. |
ProductVariantsBulkReorderPayload |
Return type for productVariantsBulkReorder mutation. |
ProductVariantsBulkReorderUserError |
Error codes for failed bulk product variants reorder operation. |
ProductVariantsBulkUpdatePayload |
Return type for productVariantsBulkUpdate mutation. |
ProductVariantsBulkUpdateUserError |
Error codes for failed variant bulk update mutations. |
ProductVariantSellingPlanGroupsArgs |
Represents a product variant. |
ProductVariantTranslationsArgs |
Represents a product variant. |
ProductVariantUpdatePayload |
Return type for productVariantUpdate mutation. |
Publication |
A publication is a group of products and collections that is published to an app. |
PublicationCollectionPublicationsV3Args |
A publication is a group of products and collections that is published to an app. |
PublicationCollectionsArgs |
A publication is a group of products and collections that is published to an app. |
PublicationConnection |
An auto-generated type for paginating through multiple Publications. |
PublicationCreateInput |
The input fields for creating a publication. |
PublicationCreatePayload |
Return type for publicationCreate mutation. |
PublicationDeletePayload |
Return type for publicationDelete mutation. |
PublicationEdge |
An auto-generated type which holds one Publication and a cursor during pagination. |
PublicationHasCollectionArgs |
A publication is a group of products and collections that is published to an app. |
PublicationInput |
The input fields required to publish a resource. |
PublicationProductPublicationsV3Args |
A publication is a group of products and collections that is published to an app. |
PublicationProductsArgs |
A publication is a group of products and collections that is published to an app. |
PublicationResourceOperation |
A bulk update operation on a publication. |
PublicationUpdateInput |
The input fields for updating a publication. |
PublicationUpdatePayload |
Return type for publicationUpdate mutation. |
PublicationUserError |
Defines errors encountered while managing a publication. |
Publishable |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishablePublicationCountArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishablePublishedOnChannelArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishablePublishedOnPublicationArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishablePublishPayload |
Return type for publishablePublish mutation. |
PublishablePublishToCurrentChannelPayload |
Return type for publishablePublishToCurrentChannel mutation. |
PublishableResourcePublicationsArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishableResourcePublicationsV2Args |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishableUnpublishedChannelsArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishableUnpublishedPublicationsArgs |
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection. |
PublishableUnpublishPayload |
Return type for publishableUnpublish mutation. |
PublishableUnpublishToCurrentChannelPayload |
Return type for publishableUnpublishToCurrentChannel mutation. |
PubSubServerPixelUpdatePayload |
Return type for pubSubServerPixelUpdate mutation. |
PubSubWebhookSubscriptionCreatePayload |
Return type for pubSubWebhookSubscriptionCreate mutation. |
PubSubWebhookSubscriptionCreateUserError |
An error that occurs during the execution of PubSubWebhookSubscriptionCreate . |
PubSubWebhookSubscriptionInput |
The input fields for a PubSub webhook subscription. |
PubSubWebhookSubscriptionUpdatePayload |
Return type for pubSubWebhookSubscriptionUpdate mutation. |
PubSubWebhookSubscriptionUpdateUserError |
An error that occurs during the execution of PubSubWebhookSubscriptionUpdate . |
PurchasingCompany |
Represents information about the purchasing company for the order or draft order. |
PurchasingCompanyInput |
The input fields for a purchasing company, which is a combination of company, company contact, and company location. |
PurchasingEntityInput |
The input fields for a purchasing entity. Can either be a customer or a purchasing company. |
QuantityPriceBreak |
Quantity price breaks lets you offer different rates that are based on the amount of a specific variant being ordered. |
QuantityPriceBreakConnection |
An auto-generated type for paginating through multiple QuantityPriceBreaks. |
QuantityPriceBreakEdge |
An auto-generated type which holds one QuantityPriceBreak and a cursor during pagination. |
QuantityPriceBreakInput |
The input fields and values to use when creating quantity price breaks. |
QuantityPricingByVariantUpdateInput |
The input fields used to update quantity pricing. |
QuantityPricingByVariantUpdatePayload |
Return type for quantityPricingByVariantUpdate mutation. |
QuantityPricingByVariantUserError |
Error codes for failed volume pricing operations. |
QuantityRule |
The quantity rule for the product variant in a given context. |
QuantityRuleConnection |
An auto-generated type for paginating through multiple QuantityRules. |
QuantityRuleEdge |
An auto-generated type which holds one QuantityRule and a cursor during pagination. |
QuantityRuleInput |
The input fields for the per-order quantity rule to be applied on the product variant. |
QuantityRulesAddPayload |
Return type for quantityRulesAdd mutation. |
QuantityRulesDeletePayload |
Return type for quantityRulesDelete mutation. |
QuantityRuleUserError |
An error for a failed quantity rule operation. |
QueryRoot |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAbandonmentArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAbandonmentByAbandonedCheckoutIdArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppByHandleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppByKeyArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppDiscountTypeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppInstallationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAppInstallationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAutomaticDiscountArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAutomaticDiscountNodeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAutomaticDiscountNodesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAutomaticDiscountsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootAutomaticDiscountSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCarrierServiceArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCartTransformsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCatalogArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCatalogsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootChannelArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootChannelsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCheckoutBrandingArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCheckoutProfileArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCheckoutProfilesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCodeDiscountNodeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCodeDiscountNodeByCodeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCodeDiscountNodesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCodeDiscountSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCollectionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCollectionByHandleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCollectionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCollectionSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompaniesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompanyArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompanyContactArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompanyContactRoleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompanyLocationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCompanyLocationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCurrentBulkOperationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerMergeJobStatusArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerMergePreviewArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerPaymentMethodArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerSegmentMembersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerSegmentMembershipArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootCustomerSegmentMembersQueryArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDeletionEventsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDeliveryCustomizationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDeliveryCustomizationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDeliveryProfileArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDeliveryProfilesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDiscountCodeCountArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDiscountNodeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDiscountNodesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDiscountRedeemCodeBulkCreationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDiscountRedeemCodeSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDisputeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDisputeEvidenceArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDomainArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDraftOrderArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDraftOrdersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDraftOrderSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootDraftOrderTagArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFilesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFileSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFulfillmentArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFulfillmentOrderArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFulfillmentOrdersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootFulfillmentServiceArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootGiftCardArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootGiftCardsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootGiftCardsCountArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootInventoryItemArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootInventoryItemsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootInventoryLevelArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootJobArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootLocationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootLocationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootLocationsAvailableForDeliveryProfilesConnectionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootManualHoldsFulfillmentOrdersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketByGeographyArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketingActivitiesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketingActivityArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketingEventArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketingEventsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketLocalizableResourceArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketLocalizableResourcesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketLocalizableResourcesByIdsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMarketsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetafieldDefinitionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetafieldDefinitionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetafieldStorefrontVisibilitiesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetafieldStorefrontVisibilityArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectByHandleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectDefinitionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectDefinitionByTypeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectDefinitionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootMetaobjectsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootNodeArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootNodesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootOrderArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootOrderPaymentStatusArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootOrdersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootOrderSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPaymentCustomizationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPaymentCustomizationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPaymentTermsTemplatesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPriceListArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPriceListsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPriceRuleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPriceRulesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPriceRuleSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPrivateMetafieldArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPrivateMetafieldsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductByHandleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductDuplicateJobArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductFeedArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductFeedsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductResourceFeedbackArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductVariantArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootProductVariantsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPublicationArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootPublicationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootRefundArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootReturnableFulfillmentArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootReturnableFulfillmentsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootReturnArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootReverseDeliveryArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootReverseFulfillmentOrderArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootScriptTagArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootScriptTagsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentFiltersArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentFilterSuggestionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentMigrationsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSegmentValueSuggestionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSellingPlanGroupArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSellingPlanGroupsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootShopifyFunctionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootShopifyFunctionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootShopifyqlQueryArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootShopLocalesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootStaffMemberArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootStandardMetafieldDefinitionTemplatesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionBillingAttemptArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionBillingAttemptsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionBillingCycleArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionBillingCyclesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionContractArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionContractsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootSubscriptionDraftArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootTenderTransactionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootTranslatableResourceArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootTranslatableResourcesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootTranslatableResourcesByIdsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootUrlRedirectArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootUrlRedirectImportArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootUrlRedirectsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootUrlRedirectSavedSearchesArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootWebhookSubscriptionArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootWebhookSubscriptionsArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
QueryRootWebPixelArgs |
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. |
Refund |
The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. |
RefundAgreement |
An agreement between the merchant and customer to refund all or a portion of the order. |
RefundAgreementSalesArgs |
An agreement between the merchant and customer to refund all or a portion of the order. |
RefundConnection |
An auto-generated type for paginating through multiple Refunds. |
RefundCreatePayload |
Return type for refundCreate mutation. |
RefundDuty |
Represents a refunded duty. |
RefundDutyInput |
The input fields required to reimburse duties on a refund. |
RefundEdge |
An auto-generated type which holds one Refund and a cursor during pagination. |
RefundInput |
The input fields to create a refund. |
RefundLineItem |
A line item that’s included in a refund. |
RefundLineItemConnection |
An auto-generated type for paginating through multiple RefundLineItems. |
RefundLineItemEdge |
An auto-generated type which holds one RefundLineItem and a cursor during pagination. |
RefundLineItemInput |
The input fields required to reimburse line items on a refund. |
RefundRefundLineItemsArgs |
The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. |
RefundShippingInput |
The input fields for the shipping cost to refund. |
RefundTransactionsArgs |
The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. |
RemoteAuthorizeNetCustomerPaymentProfileInput |
The input fields for a remote Authorize.net customer payment profile. |
RemoteBraintreePaymentMethodInput |
The input fields for a remote Braintree customer payment profile. |
RemoteStripePaymentMethodInput |
The input fields for a remote stripe payment method. |
ResourceAlert |
An alert message that appears in the Shopify admin about a problem with a store resource, with 1 or more actions to take. For example, you could use an alert to indicate that you’re not charging taxes on some product variants. They can optionally have a specific icon and be dismissed by merchants. |
ResourceAlertAction |
An action associated to a resource alert, such as editing variants. |
ResourceFeedback |
Represents feedback from apps about a resource, and the steps required to set up the apps on the shop. |
ResourceFeedbackCreateInput |
The input fields for a resource feedback object. |
ResourceOperation |
Represents a merchandising background operation interface. |
ResourcePublication |
<p>A resource publication represents information about the publication of a resource. An instance of ResourcePublication , unlike ResourcePublicationV2 , can be neither published or scheduled to be published.</p><p>See [ResourcePublicationV2](/api/admin-graphql/latest/objects/ResourcePublicationV2) for more context.</p> |
ResourcePublicationConnection |
An auto-generated type for paginating through multiple ResourcePublications. |
ResourcePublicationEdge |
An auto-generated type which holds one ResourcePublication and a cursor during pagination. |
ResourcePublicationV2 |
<p>A resource publication represents information about the publication of a resource. Unlike ResourcePublication , an instance of ResourcePublicationV2 can’t be unpublished. It must either be published or scheduled to be published.</p><p>See [ResourcePublication](/api/admin-graphql/latest/objects/ResourcePublication) for more context.</p> |
ResourcePublicationV2Connection |
An auto-generated type for paginating through multiple ResourcePublicationV2s. |
ResourcePublicationV2Edge |
An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination. |
Return |
Represents a return. |
ReturnableFulfillment |
A returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant. |
ReturnableFulfillmentConnection |
An auto-generated type for paginating through multiple ReturnableFulfillments. |
ReturnableFulfillmentEdge |
An auto-generated type which holds one ReturnableFulfillment and a cursor during pagination. |
ReturnableFulfillmentLineItem |
A returnable fulfillment line item. |
ReturnableFulfillmentLineItemConnection |
An auto-generated type for paginating through multiple ReturnableFulfillmentLineItems. |
ReturnableFulfillmentLineItemEdge |
An auto-generated type which holds one ReturnableFulfillmentLineItem and a cursor during pagination. |
ReturnableFulfillmentReturnableFulfillmentLineItemsArgs |
A returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant. |
ReturnApproveRequestInput |
The input fields for approving a customer’s return request. |
ReturnApproveRequestPayload |
Return type for returnApproveRequest mutation. |
ReturnCancelPayload |
Return type for returnCancel mutation. |
ReturnClosePayload |
Return type for returnClose mutation. |
ReturnConnection |
An auto-generated type for paginating through multiple Returns. |
ReturnCreatePayload |
Return type for returnCreate mutation. |
ReturnDecline |
Additional information about why a merchant declined the customer’s return request. |
ReturnDeclineRequestInput |
The input fields for declining a customer’s return request. |
ReturnDeclineRequestPayload |
Return type for returnDeclineRequest mutation. |
ReturnEdge |
An auto-generated type which holds one Return and a cursor during pagination. |
ReturnInput |
The input fields for a return. |
ReturnLineItem |
A return line item. |
ReturnLineItemConnection |
An auto-generated type for paginating through multiple ReturnLineItems. |
ReturnLineItemEdge |
An auto-generated type which holds one ReturnLineItem and a cursor during pagination. |
ReturnLineItemInput |
The input fields for a return line item. |
ReturnRefundInput |
The input fields to refund a return. |
ReturnRefundLineItemInput |
The input fields for a return refund line item. |
ReturnRefundOrderTransactionInput |
The input fields to create order transactions when refunding a return. |
ReturnRefundPayload |
Return type for returnRefund mutation. |
ReturnRefundsArgs |
Represents a return. |
ReturnReopenPayload |
Return type for returnReopen mutation. |
ReturnRequestInput |
The input fields for requesting a return. |
ReturnRequestLineItemInput |
The input fields for a return line item. |
ReturnRequestPayload |
Return type for returnRequest mutation. |
ReturnReturnLineItemsArgs |
Represents a return. |
ReturnReverseFulfillmentOrdersArgs |
Represents a return. |
ReturnSuggestedRefundArgs |
Represents a return. |
ReturnUserError |
An error that occurs during the execution of a return mutation. |
ReverseDelivery |
A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. For example, a buyer requests a return, and a merchant sends the buyer a shipping label. The reverse delivery contains the context of the items sent back, how they’re being sent back (for example, a shipping label), and the current state of the delivery (tracking information). |
ReverseDeliveryConnection |
An auto-generated type for paginating through multiple ReverseDeliveries. |
ReverseDeliveryCreateWithShippingPayload |
Return type for reverseDeliveryCreateWithShipping mutation. |
ReverseDeliveryDisposeInput |
The input fields to dispose a reverse delivery line item. |
ReverseDeliveryDisposePayload |
Return type for reverseDeliveryDispose mutation. |
ReverseDeliveryEdge |
An auto-generated type which holds one ReverseDelivery and a cursor during pagination. |
ReverseDeliveryLabelInput |
The input fields for a reverse label. |
ReverseDeliveryLabelV2 |
The return label file information for a reverse delivery. |
ReverseDeliveryLineItem |
The details about a reverse delivery line item. |
ReverseDeliveryLineItemConnection |
An auto-generated type for paginating through multiple ReverseDeliveryLineItems. |
ReverseDeliveryLineItemEdge |
An auto-generated type which holds one ReverseDeliveryLineItem and a cursor during pagination. |
ReverseDeliveryLineItemInput |
The input fields for a reverse delivery line item. |
ReverseDeliveryReverseDeliveryLineItemsArgs |
A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. For example, a buyer requests a return, and a merchant sends the buyer a shipping label. The reverse delivery contains the context of the items sent back, how they’re being sent back (for example, a shipping label), and the current state of the delivery (tracking information). |
ReverseDeliveryShippingDeliverable |
A reverse shipping deliverable that may include a label and tracking information. |
ReverseDeliveryShippingUpdatePayload |
Return type for reverseDeliveryShippingUpdate mutation. |
ReverseDeliveryTrackingInput |
The input fields for tracking information about a return delivery. |
ReverseDeliveryTrackingV2 |
Represents the information used to track a reverse delivery. |
ReverseFulfillmentOrder |
A group of one or more items in a return that will be processed at a fulfillment service. There can be more than one reverse fulfillment order for a return at a given location. |
ReverseFulfillmentOrderConnection |
An auto-generated type for paginating through multiple ReverseFulfillmentOrders. |
ReverseFulfillmentOrderDisposeInput |
The input fields to dispose a reverse fulfillment order line item. |
ReverseFulfillmentOrderDisposePayload |
Return type for reverseFulfillmentOrderDispose mutation. |
ReverseFulfillmentOrderDisposition |
The details of the arrangement of an item. |
ReverseFulfillmentOrderEdge |
An auto-generated type which holds one ReverseFulfillmentOrder and a cursor during pagination. |
ReverseFulfillmentOrderLineItem |
The details about a reverse fulfillment order line item. |
ReverseFulfillmentOrderLineItemConnection |
An auto-generated type for paginating through multiple ReverseFulfillmentOrderLineItems. |
ReverseFulfillmentOrderLineItemEdge |
An auto-generated type which holds one ReverseFulfillmentOrderLineItem and a cursor during pagination. |
ReverseFulfillmentOrderLineItemsArgs |
A group of one or more items in a return that will be processed at a fulfillment service. There can be more than one reverse fulfillment order for a return at a given location. |
ReverseFulfillmentOrderReverseDeliveriesArgs |
A group of one or more items in a return that will be processed at a fulfillment service. There can be more than one reverse fulfillment order for a return at a given location. |
ReverseFulfillmentOrderThirdPartyConfirmation |
The third-party confirmation of a reverse fulfillment order. |
RowCount |
A row count represents rows on background operation. |
Sale |
An individual sale record associated with a sales agreement. Every money value in an order’s sales data is represented in the currency’s smallest unit. When amounts are divided across multiple line items, such as taxes or order discounts, the amounts might not divide evenly across all of the line items on the order. To address this, the remaining currency units that couldn’t be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for. In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts. This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items. |
SaleAdditionalFee |
The additional fee details for a line item. |
SaleConnection |
An auto-generated type for paginating through multiple Sales. |
SaleEdge |
An auto-generated type which holds one Sale and a cursor during pagination. |
SalesAgreement |
A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. |
SalesAgreementConnection |
An auto-generated type for paginating through multiple SalesAgreements. |
SalesAgreementEdge |
An auto-generated type which holds one SalesAgreement and a cursor during pagination. |
SalesAgreementSalesArgs |
A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. |
SaleTax |
The tax allocated to a sale from a single tax line. |
SavedSearch |
A saved search is a representation of a search query saved in the admin. |
SavedSearchConnection |
An auto-generated type for paginating through multiple SavedSearches. |
SavedSearchCreateInput |
The input fields to create a saved search. |
SavedSearchCreatePayload |
Return type for savedSearchCreate mutation. |
SavedSearchDeleteInput |
The input fields to delete a saved search. |
SavedSearchDeletePayload |
Return type for savedSearchDelete mutation. |
SavedSearchEdge |
An auto-generated type which holds one SavedSearch and a cursor during pagination. |
SavedSearchUpdateInput |
The input fields to update a saved search. |
SavedSearchUpdatePayload |
Return type for savedSearchUpdate mutation. |
Scalars |
All built-in and custom scalars, mapped to their actual values |
ScriptDiscountApplication |
<p>Script discount applications capture the intentions of a discount that was created by a Shopify Script for an order’s line item or shipping line.</p><p>Discount applications don’t represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.</p> |
ScriptTag |
<p><div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.</p></div></p><p>A script tag represents remote JavaScript code that is loaded into the pages of a shop’s storefront or the order status page of checkout.</p> |
ScriptTagConnection |
An auto-generated type for paginating through multiple ScriptTags. |
ScriptTagCreatePayload |
Return type for scriptTagCreate mutation. |
ScriptTagDeletePayload |
Return type for scriptTagDelete mutation. |
ScriptTagEdge |
An auto-generated type which holds one ScriptTag and a cursor during pagination. |
ScriptTagInput |
The input fields for a script tag. This input object is used when creating or updating a script tag to specify its URL, where it should be included, and how it will be cached. |
ScriptTagUpdatePayload |
Return type for scriptTagUpdate mutation. |
SearchFilter |
A filter in a search query represented by a key value pair. |
SearchFilterOptions |
A list of search filters along with their specific options in value and label pair for filtering. |
SearchResult |
Represents an individual result returned from a search. |
SearchResultConnection |
The connection type for SearchResult. |
SearchResultEdge |
An auto-generated type which holds one SearchResult and a cursor during pagination. |
Segment |
A dynamic collection of customers based on specific criteria. |
SegmentAssociationFilter |
A filter that takes a value that’s associated with an object. For example, the tags field is associated with the [Customer ](/api/admin-graphql/latest/objects/Customer) object. |
SegmentAttributeStatistics |
The statistics of a given attribute. |
SegmentBooleanFilter |
A filter with a Boolean value that’s been added to a segment query. |
SegmentConnection |
An auto-generated type for paginating through multiple Segments. |
SegmentCreatePayload |
Return type for segmentCreate mutation. |
SegmentDateFilter |
A filter with a date value that’s been added to a segment query. |
SegmentDeletePayload |
Return type for segmentDelete mutation. |
SegmentEdge |
An auto-generated type which holds one Segment and a cursor during pagination. |
SegmentEnumFilter |
A filter with a set of possible values that’s been added to a segment query. |
SegmentEventFilter |
A filter that’s used to segment customers based on the date that an event occured. For example, the product_bought event filter allows you to segment customers based on what products they’ve bought. |
SegmentEventFilterParameter |
The parameters for an event segment filter. |
SegmentFilter |
The filters used in segment queries associated with a shop. |
SegmentFilterConnection |
An auto-generated type for paginating through multiple SegmentFilters. |
SegmentFilterEdge |
An auto-generated type which holds one SegmentFilter and a cursor during pagination. |
SegmentFloatFilter |
A filter with a double-precision, floating-point value that’s been added to a segment query. |
SegmentIntegerFilter |
A filter with an integer that’s been added to a segment query. |
SegmentMembership |
The response type for the segmentMembership object. |
SegmentMembershipResponse |
A list of maps that contain segmentId IDs and isMember Booleans. The maps represent segment memberships. |
SegmentMigration |
A segment and its corresponding saved search. For example, you can use SegmentMigration to retrieve the segment ID that corresponds to a saved search ID. |
SegmentMigrationConnection |
An auto-generated type for paginating through multiple SegmentMigrations. |
SegmentMigrationEdge |
An auto-generated type which holds one SegmentMigration and a cursor during pagination. |
SegmentStatistics |
The statistics of a given segment. |
SegmentStatisticsAttributeStatisticsArgs |
The statistics of a given segment. |
SegmentStringFilter |
A filter with a string that’s been added to a segment query. |
SegmentUpdatePayload |
Return type for segmentUpdate mutation. |
SegmentValue |
A list of suggested values associated with an individual segment. A segment is a group of members, such as customers, that meet specific criteria. |
SegmentValueConnection |
An auto-generated type for paginating through multiple SegmentValues. |
SegmentValueEdge |
An auto-generated type which holds one SegmentValue and a cursor during pagination. |
SelectedOption |
Properties used by customers to select a product variant. Products can have multiple options, like different sizes or colors. |
SellingPlan |
<p>Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.</p><p>For more information on selling plans, refer to [*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans).</p> |
SellingPlanAnchor |
Represents a selling plan policy anchor. |
SellingPlanAnchorInput |
The input fields required to create or update a selling plan anchor. |
SellingPlanBillingPolicyInput |
The input fields that are required to create or update a billing policy type. |
SellingPlanCheckoutCharge |
The amount charged at checkout when the full amount isn’t charged at checkout. |
SellingPlanCheckoutChargeInput |
The input fields that are required to create or update a checkout charge. |
SellingPlanCheckoutChargePercentageValue |
The percentage value of the price used for checkout charge. |
SellingPlanCheckoutChargeValueInput |
The input fields required to create or update an checkout charge value. |
SellingPlanConnection |
An auto-generated type for paginating through multiple SellingPlans. |
SellingPlanDeliveryPolicyInput |
The input fields that are required to create or update a delivery policy. |
SellingPlanEdge |
An auto-generated type which holds one SellingPlan and a cursor during pagination. |
SellingPlanFixedBillingPolicy |
The fixed selling plan billing policy defines how much of the price of the product will be billed to customer at checkout. If there is an outstanding balance, it determines when it will be paid. |
SellingPlanFixedBillingPolicyInput |
The input fields required to create or update a fixed billing policy. |
SellingPlanFixedDeliveryPolicy |
Represents a fixed selling plan delivery policy. |
SellingPlanFixedDeliveryPolicyInput |
The input fields required to create or update a fixed delivery policy. |
SellingPlanFixedPricingPolicy |
Represents the pricing policy of a subscription or deferred purchase option selling plan. The selling plan fixed pricing policy works with the billing and delivery policy to determine the final price. Discounts are divided among fulfillments. For example, a subscription with a $10 discount and two deliveries will have a $5 discount applied to each delivery. |
SellingPlanFixedPricingPolicyInput |
The input fields required to create or update a fixed selling plan pricing policy. |
SellingPlanGroup |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupAddProductsPayload |
Return type for sellingPlanGroupAddProducts mutation. |
SellingPlanGroupAddProductVariantsPayload |
Return type for sellingPlanGroupAddProductVariants mutation. |
SellingPlanGroupAppliesToProductArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupAppliesToProductVariantArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupAppliesToProductVariantsArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupConnection |
An auto-generated type for paginating through multiple SellingPlanGroups. |
SellingPlanGroupCreatePayload |
Return type for sellingPlanGroupCreate mutation. |
SellingPlanGroupDeletePayload |
Return type for sellingPlanGroupDelete mutation. |
SellingPlanGroupEdge |
An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. |
SellingPlanGroupInput |
The input fields required to create or update a selling plan group. |
SellingPlanGroupProductsArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupProductVariantCountArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupProductVariantsArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupRemoveProductsPayload |
Return type for sellingPlanGroupRemoveProducts mutation. |
SellingPlanGroupRemoveProductVariantsPayload |
Return type for sellingPlanGroupRemoveProductVariants mutation. |
SellingPlanGroupResourceInput |
The input fields for resource association with a Selling Plan Group. |
SellingPlanGroupSellingPlansArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupTranslationsArgs |
Represents a selling method (for example, “Subscribe and save” or “Pre-paid”). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. |
SellingPlanGroupUpdatePayload |
Return type for sellingPlanGroupUpdate mutation. |
SellingPlanGroupUserError |
Represents a selling plan group custom error. |
SellingPlanInput |
The input fields to create or update a selling plan. |
SellingPlanInventoryPolicy |
The selling plan inventory policy. |
SellingPlanInventoryPolicyInput |
The input fields required to create or update an inventory policy. |
SellingPlanPricingPolicyBase |
Represents selling plan pricing policy common fields. |
SellingPlanPricingPolicyInput |
The input fields required to create or update a selling plan pricing policy. |
SellingPlanPricingPolicyPercentageValue |
The percentage value of a selling plan pricing policy percentage type. |
SellingPlanPricingPolicyValueInput |
The input fields required to create or update a pricing policy adjustment value. |
SellingPlanRecurringBillingPolicy |
Represents a recurring selling plan billing policy. |
SellingPlanRecurringBillingPolicyInput |
The input fields required to create or update a recurring billing policy. |
SellingPlanRecurringDeliveryPolicy |
Represents a recurring selling plan delivery policy. |
SellingPlanRecurringDeliveryPolicyInput |
The input fields to create or update a recurring delivery policy. |
SellingPlanRecurringPricingPolicy |
Represents a recurring selling plan pricing policy. |
SellingPlanRecurringPricingPolicyInput |
The input fields required to create or update a recurring selling plan pricing policy. |
SellingPlanTranslationsArgs |
<p>Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.</p><p>For more information on selling plans, refer to [*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans).</p> |
Seo |
SEO information. |
SeoInput |
The input fields for SEO information. |
ServerPixel |
A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint. |
ServerPixelCreatePayload |
Return type for serverPixelCreate mutation. |
ServerPixelDeletePayload |
Return type for serverPixelDelete mutation. |
ShippingLine |
Represents the shipping details that the customer chose for their order. |
ShippingLineConnection |
An auto-generated type for paginating through multiple ShippingLines. |
ShippingLineEdge |
An auto-generated type which holds one ShippingLine and a cursor during pagination. |
ShippingLineInput |
The input fields for specifying the shipping details for the order. |
ShippingLineSale |
A sale associated with a shipping charge. |
ShippingMethod |
The shipping method for the delivery. Customers will see applicable shipping methods in the shipping section of checkout. |
ShippingPackageDeletePayload |
Return type for shippingPackageDelete mutation. |
ShippingPackageMakeDefaultPayload |
Return type for shippingPackageMakeDefault mutation. |
ShippingPackageUpdatePayload |
Return type for shippingPackageUpdate mutation. |
ShippingRate |
A shipping rate is an additional cost added to the cost of the products that were ordered. |
ShippingRefund |
Represents the shipping costs refunded on the Refund. |
ShippingRefundInput |
The input fields that are required to reimburse shipping costs. |
Shop |
Represents a collection of general settings and information about the shop. |
ShopAddress |
The shop’s billing address. |
ShopAddressFormattedArgs |
The shop’s billing address. |
ShopAlert |
An alert message that appears in the Shopify admin about a problem with a store setting, with an action to take. For example, you could show an alert to ask the merchant to enter their billing information to activate Shopify Plus. |
ShopAlertAction |
An action associated to a shop alert, such as adding a credit card. |
ShopAssignedFulfillmentOrdersArgs |
Represents a collection of general settings and information about the shop. |
ShopAvailableChannelAppsArgs |
Represents a collection of general settings and information about the shop. |
ShopBillingPreferences |
Billing preferences for the shop. |
ShopChannelsArgs |
Represents a collection of general settings and information about the shop. |
ShopCollectionByHandleArgs |
Represents a collection of general settings and information about the shop. |
ShopCollectionsArgs |
Represents a collection of general settings and information about the shop. |
ShopCollectionSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopCurrencySettingsArgs |
Represents a collection of general settings and information about the shop. |
ShopCustomersArgs |
Represents a collection of general settings and information about the shop. |
ShopCustomerSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopCustomerTagsArgs |
Represents a collection of general settings and information about the shop. |
ShopDraftOrdersArgs |
Represents a collection of general settings and information about the shop. |
ShopDraftOrderSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopDraftOrderTagsArgs |
Represents a collection of general settings and information about the shop. |
ShopFeatures |
Represents the feature set available to the shop. Most fields specify whether a feature is enabled for a shop, and some fields return information related to specific features. |
ShopFulfillmentOrdersArgs |
Represents a collection of general settings and information about the shop. |
ShopifyFunction |
A Shopify Function. |
ShopifyFunctionConnection |
An auto-generated type for paginating through multiple ShopifyFunctions. |
ShopifyFunctionEdge |
An auto-generated type which holds one ShopifyFunction and a cursor during pagination. |
ShopifyPaymentsAccount |
Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. |
ShopifyPaymentsAccountBankAccountsArgs |
Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. |
ShopifyPaymentsAccountDisputesArgs |
Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. |
ShopifyPaymentsAccountPayoutsArgs |
Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. |
ShopifyPaymentsBankAccount |
A bank account that can receive payouts. |
ShopifyPaymentsBankAccountConnection |
An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts. |
ShopifyPaymentsBankAccountEdge |
An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination. |
ShopifyPaymentsBankAccountPayoutsArgs |
A bank account that can receive payouts. |
ShopifyPaymentsChargeStatementDescriptor |
The charge descriptors for a payments account. |
ShopifyPaymentsDefaultChargeStatementDescriptor |
The charge descriptors for a payments account. |
ShopifyPaymentsDispute |
A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution. |
ShopifyPaymentsDisputeConnection |
An auto-generated type for paginating through multiple ShopifyPaymentsDisputes. |
ShopifyPaymentsDisputeEdge |
An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination. |
ShopifyPaymentsDisputeEvidence |
The evidence associated with the dispute. |
ShopifyPaymentsDisputeEvidenceUpdateInput |
The input fields required to update a dispute evidence object. |
ShopifyPaymentsDisputeFileUpload |
The file upload associated with the dispute evidence. |
ShopifyPaymentsDisputeFileUploadUpdateInput |
The input fields required to update a dispute file upload object. |
ShopifyPaymentsDisputeFulfillment |
The fulfillment associated with dispute evidence. |
ShopifyPaymentsDisputeReasonDetails |
Details regarding a dispute reason. |
ShopifyPaymentsExtendedAuthorization |
Presents all Shopify Payments information related to an extended authorization. |
ShopifyPaymentsFraudSettings |
The fraud settings of a payments account. |
ShopifyPaymentsJpChargeStatementDescriptor |
The charge descriptors for a Japanese payments account. |
ShopifyPaymentsNotificationSettings |
The notification settings for the account. |
ShopifyPaymentsPayout |
Payouts represent the movement of money between a merchant’s Shopify Payments balance and their bank account. |
ShopifyPaymentsPayoutConnection |
An auto-generated type for paginating through multiple ShopifyPaymentsPayouts. |
ShopifyPaymentsPayoutEdge |
An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination. |
ShopifyPaymentsPayoutSchedule |
The payment schedule for a payments account. |
ShopifyPaymentsPayoutSummary |
Breakdown of the total fees and gross of each of the different types of transactions associated with the payout. |
ShopifyPaymentsRefundSet |
Presents all Shopify Payments specific information related to an order refund. |
ShopifyPaymentsTransactionSet |
Presents all Shopify Payments specific information related to an order transaction. |
ShopifyPaymentsVerification |
Each subject (individual) of an account has a verification object giving information about the verification state. |
ShopifyPaymentsVerificationDocument |
A document which can be used to verify an individual. |
ShopifyPaymentsVerificationSubject |
The verification subject represents an individual that has to be verified. |
ShopifyProtectOrderEligibility |
The eligibility details of an order’s protection against fraudulent chargebacks by Shopify Protect. |
ShopifyProtectOrderSummary |
A summary of Shopify Protect details for an order. |
ShopifyqlResponse |
A response to a ShopifyQL query. |
ShopInventoryItemsArgs |
Represents a collection of general settings and information about the shop. |
ShopLocale |
A locale that’s been enabled on a shop. |
ShopLocaleDisablePayload |
Return type for shopLocaleDisable mutation. |
ShopLocaleEnablePayload |
Return type for shopLocaleEnable mutation. |
ShopLocaleInput |
The input fields for a shop locale. |
ShopLocaleUpdatePayload |
Return type for shopLocaleUpdate mutation. |
ShopLocationsArgs |
Represents a collection of general settings and information about the shop. |
ShopMarketingEventsArgs |
Represents a collection of general settings and information about the shop. |
ShopMetafieldArgs |
Represents a collection of general settings and information about the shop. |
ShopMetafieldsArgs |
Represents a collection of general settings and information about the shop. |
ShopOrdersArgs |
Represents a collection of general settings and information about the shop. |
ShopOrderSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopOrderTagsArgs |
Represents a collection of general settings and information about the shop. |
ShopPayInstallmentsPaymentDetails |
Shop Pay Installments payment details related to a transaction. |
ShopPlan |
The billing plan of the shop. |
ShopPolicy |
Policy that a merchant has configured for their store, such as their refund or privacy policy. |
ShopPolicyInput |
The input fields required to update a policy. |
ShopPolicyTranslationsArgs |
Policy that a merchant has configured for their store, such as their refund or privacy policy. |
ShopPolicyUpdatePayload |
Return type for shopPolicyUpdate mutation. |
ShopPolicyUserError |
An error that occurs during the execution of a shop policy mutation. |
ShopPriceRulesArgs |
Represents a collection of general settings and information about the shop. |
ShopPriceRuleSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopPrivateMetafieldArgs |
Represents a collection of general settings and information about the shop. |
ShopPrivateMetafieldsArgs |
Represents a collection of general settings and information about the shop. |
ShopProductByHandleArgs |
Represents a collection of general settings and information about the shop. |
ShopProductImagesArgs |
Represents a collection of general settings and information about the shop. |
ShopProductsArgs |
Represents a collection of general settings and information about the shop. |
ShopProductSavedSearchesArgs |
Represents a collection of general settings and information about the shop. |
ShopProductTagsArgs |
Represents a collection of general settings and information about the shop. |
ShopProductTypesArgs |
Represents a collection of general settings and information about the shop. |
ShopProductVariantsArgs |
Represents a collection of general settings and information about the shop. |
ShopProductVendorsArgs |
Represents a collection of general settings and information about the shop. |
ShopResourceFeedbackCreatePayload |
Return type for shopResourceFeedbackCreate mutation. |
ShopResourceFeedbackCreateUserError |
An error that occurs during the execution of ShopResourceFeedbackCreate . |
ShopResourceLimits |
Resource limits of a shop. |
ShopSearchArgs |
Represents a collection of general settings and information about the shop. |
ShopStaffMembersArgs |
Represents a collection of general settings and information about the shop. |
ShopStorefrontAccessTokensArgs |
Represents a collection of general settings and information about the shop. |
ShopTranslationsArgs |
Represents a collection of general settings and information about the shop. |
ShopUploadedImagesByIdsArgs |
Represents a collection of general settings and information about the shop. |
StaffMember |
Represents the data about a staff member’s Shopify account. Merchants can use staff member data to get more information about the staff members in their store. |
StaffMemberAvatarArgs |
Represents the data about a staff member’s Shopify account. Merchants can use staff member data to get more information about the staff members in their store. |
StaffMemberConnection |
An auto-generated type for paginating through multiple StaffMembers. |
StaffMemberEdge |
An auto-generated type which holds one StaffMember and a cursor during pagination. |
StaffMemberPrivateData |
Represents the data used to customize the Shopify admin experience for a logged-in staff member. |
StagedMediaUploadTarget |
<p>Information about a staged upload target, which should be used to send a request to upload the file.</p><p>For more information on the upload process, refer to [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).</p> |
StagedUploadInput |
The input fields for generating staged upload targets. |
StagedUploadParameter |
<p>The parameters required to authenticate a file upload request using a [StagedMediaUploadTarget’s url field](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-stagedmediauploadtarget-url).</p><p>For more information on the upload process, refer to [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).</p> |
StagedUploadsCreatePayload |
Return type for stagedUploadsCreate mutation. |
StagedUploadTarget |
<p>Information about the staged target.</p><p>Deprecated in favor of [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget), which is returned by the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).</p> |
StagedUploadTargetGenerateInput |
<p>The required fields and parameters to generate the URL upload an” asset to Shopify.</p><p>Deprecated in favor of [StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput), which is used by the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).</p> |
StagedUploadTargetGeneratePayload |
Return type for stagedUploadTargetGenerate mutation. |
StagedUploadTargetsGeneratePayload |
Return type for stagedUploadTargetsGenerate mutation. |
StageImageInput |
<p>An image to be uploaded.</p><p>Deprecated in favor of [StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput), which is used by the [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).</p> |
StandardizedProductType |
Represents the details of a specific type of product within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt). |
StandardizedProductTypeInput |
Provides the fields and values to use when adding a standard product type to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values. |
StandardMetafieldDefinitionEnablePayload |
Return type for standardMetafieldDefinitionEnable mutation. |
StandardMetafieldDefinitionEnableUserError |
An error that occurs during the execution of StandardMetafieldDefinitionEnable . |
StandardMetafieldDefinitionTemplate |
<p>Standard metafield definition templates provide preset configurations to create metafield definitions. Each template has a specific namespace and key that we’ve reserved to have specific meanings for common use cases.</p><p>Refer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions).</p> |
StandardMetafieldDefinitionTemplateConnection |
An auto-generated type for paginating through multiple StandardMetafieldDefinitionTemplates. |
StandardMetafieldDefinitionTemplateEdge |
An auto-generated type which holds one StandardMetafieldDefinitionTemplate and a cursor during pagination. |
StandardMetaobjectDefinitionEnablePayload |
Return type for standardMetaobjectDefinitionEnable mutation. |
StorefrontAccessToken |
A token that’s used to delegate unauthenticated access scopes to clients that need to access the unauthenticated Storefront API. An app can have a maximum of 100 active storefront access tokens for each shop. |
StorefrontAccessTokenConnection |
An auto-generated type for paginating through multiple StorefrontAccessTokens. |
StorefrontAccessTokenCreatePayload |
Return type for storefrontAccessTokenCreate mutation. |
StorefrontAccessTokenDeleteInput |
The input fields to delete a storefront access token. |
StorefrontAccessTokenDeletePayload |
Return type for storefrontAccessTokenDelete mutation. |
StorefrontAccessTokenEdge |
An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination. |
StorefrontAccessTokenInput |
The input fields for a storefront access token. |
StringConnection |
An auto-generated type for paginating through a list of Strings. |
StringEdge |
An auto-generated type which holds one String and a cursor during pagination. |
SubscriptionAppliedCodeDiscount |
Represents an applied code discount. |
SubscriptionAtomicLineInput |
The input fields for mapping a subscription line to a discount. |
SubscriptionAtomicManualDiscountInput |
The input fields for mapping a subscription line to a discount. |
SubscriptionBillingAttempt |
A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation. A successful billing attempt will create an order. |
SubscriptionBillingAttemptConnection |
An auto-generated type for paginating through multiple SubscriptionBillingAttempts. |
SubscriptionBillingAttemptCreatePayload |
Return type for subscriptionBillingAttemptCreate mutation. |
SubscriptionBillingAttemptEdge |
An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination. |
SubscriptionBillingAttemptInput |
The input fields required to complete a subscription billing attempt. |
SubscriptionBillingCycle |
A subscription billing cycle. |
SubscriptionBillingCycleBillingAttemptsArgs |
A subscription billing cycle. |
SubscriptionBillingCycleConnection |
An auto-generated type for paginating through multiple SubscriptionBillingCycles. |
SubscriptionBillingCycleContractDraftCommitPayload |
Return type for subscriptionBillingCycleContractDraftCommit mutation. |
SubscriptionBillingCycleContractDraftConcatenatePayload |
Return type for subscriptionBillingCycleContractDraftConcatenate mutation. |
SubscriptionBillingCycleContractEditPayload |
Return type for subscriptionBillingCycleContractEdit mutation. |
SubscriptionBillingCycleEdge |
An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination. |
SubscriptionBillingCycleEditDeletePayload |
Return type for subscriptionBillingCycleEditDelete mutation. |
SubscriptionBillingCycleEditedContract |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditedContractBillingCyclesArgs |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditedContractCustomerPaymentMethodArgs |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditedContractDiscountsArgs |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditedContractLinesArgs |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditedContractOrdersArgs |
Represents a subscription contract with billing cycles. |
SubscriptionBillingCycleEditsDeletePayload |
Return type for subscriptionBillingCycleEditsDelete mutation. |
SubscriptionBillingCycleInput |
The input fields for specifying the subscription contract and selecting the associated billing cycle. |
SubscriptionBillingCycleScheduleEditInput |
The input fields for parameters to modify the schedule of a specific billing cycle. |
SubscriptionBillingCycleScheduleEditPayload |
Return type for subscriptionBillingCycleScheduleEdit mutation. |
SubscriptionBillingCyclesDateRangeSelector |
The input fields to select a subset of subscription billing cycles within a date range. |
SubscriptionBillingCycleSelector |
The input fields to select SubscriptionBillingCycle by either date or index. |
SubscriptionBillingCyclesIndexRangeSelector |
The input fields to select a subset of subscription billing cycles within an index range. |
SubscriptionBillingCycleUserError |
The possible errors for a subscription billing cycle. |
SubscriptionBillingPolicy |
Represents a Subscription Billing Policy. |
SubscriptionBillingPolicyInput |
The input fields for a Subscription Billing Policy. |
SubscriptionContract |
Represents a Subscription Contract. |
SubscriptionContractAtomicCreateInput |
The input fields required to create a Subscription Contract. |
SubscriptionContractAtomicCreatePayload |
Return type for subscriptionContractAtomicCreate mutation. |
SubscriptionContractBase |
Represents subscription contract common fields. |
SubscriptionContractBaseCustomerPaymentMethodArgs |
Represents subscription contract common fields. |
SubscriptionContractBaseDiscountsArgs |
Represents subscription contract common fields. |
SubscriptionContractBaseLinesArgs |
Represents subscription contract common fields. |
SubscriptionContractBaseOrdersArgs |
Represents subscription contract common fields. |
SubscriptionContractBillingAttemptsArgs |
Represents a Subscription Contract. |
SubscriptionContractConnection |
An auto-generated type for paginating through multiple SubscriptionContracts. |
SubscriptionContractCreateInput |
The input fields required to create a Subscription Contract. |
SubscriptionContractCreatePayload |
Return type for subscriptionContractCreate mutation. |
SubscriptionContractCustomerPaymentMethodArgs |
Represents a Subscription Contract. |
SubscriptionContractDiscountsArgs |
Represents a Subscription Contract. |
SubscriptionContractEdge |
An auto-generated type which holds one SubscriptionContract and a cursor during pagination. |
SubscriptionContractLinesArgs |
Represents a Subscription Contract. |
SubscriptionContractOrdersArgs |
Represents a Subscription Contract. |
SubscriptionContractProductChangeInput |
The input fields required to create a Subscription Contract. |
SubscriptionContractProductChangePayload |
Return type for subscriptionContractProductChange mutation. |
SubscriptionContractSetNextBillingDatePayload |
Return type for subscriptionContractSetNextBillingDate mutation. |
SubscriptionContractUpdatePayload |
Return type for subscriptionContractUpdate mutation. |
SubscriptionContractUserError |
Represents a Subscription Contract error. |
SubscriptionCyclePriceAdjustment |
Represents a Subscription Line Pricing Cycle Adjustment. |
SubscriptionDeliveryMethodInput |
Specifies delivery method fields for a subscription draft. This is an input union: one, and only one, field can be provided. The field provided will determine which delivery method is to be used. |
SubscriptionDeliveryMethodLocalDelivery |
A subscription delivery method for local delivery. The other subscription delivery methods can be found in the SubscriptionDeliveryMethod union type. |
SubscriptionDeliveryMethodLocalDeliveryInput |
<p>The input fields for a local delivery method.</p><p>This input accepts partial input. When a field is not provided, its prior value is left unchanged.</p> |
SubscriptionDeliveryMethodLocalDeliveryOption |
The selected delivery option on a subscription contract. |
SubscriptionDeliveryMethodLocalDeliveryOptionInput |
The input fields for local delivery option. |
SubscriptionDeliveryMethodPickup |
A delivery method with a pickup option. |
SubscriptionDeliveryMethodPickupInput |
<p>The input fields for a pickup delivery method.</p><p>This input accepts partial input. When a field is not provided, its prior value is left unchanged.</p> |
SubscriptionDeliveryMethodPickupOption |
Represents the selected pickup option on a subscription contract. |
SubscriptionDeliveryMethodPickupOptionInput |
The input fields for pickup option. |
SubscriptionDeliveryMethodShipping |
Represents a shipping delivery method: a mailing address and a shipping option. |
SubscriptionDeliveryMethodShippingInput |
<p>Specifies shipping delivery method fields.</p><p>This input accepts partial input. When a field is not provided, its prior value is left unchanged.</p> |
SubscriptionDeliveryMethodShippingOption |
Represents the selected shipping option on a subscription contract. |
SubscriptionDeliveryMethodShippingOptionInput |
The input fields for shipping option. |
SubscriptionDeliveryOptionResultFailure |
A failure to find the available delivery options for a subscription contract. |
SubscriptionDeliveryOptionResultSuccess |
The delivery option for a subscription contract. |
SubscriptionDeliveryPolicy |
Represents a Subscription Delivery Policy. |
SubscriptionDeliveryPolicyInput |
The input fields for a Subscription Delivery Policy. |
SubscriptionDiscountAllocation |
Represents what a particular discount reduces from a line price. |
SubscriptionDiscountConnection |
An auto-generated type for paginating through multiple SubscriptionDiscounts. |
SubscriptionDiscountEdge |
An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination. |
SubscriptionDiscountEntitledLines |
Represents the subscription lines the discount applies on. |
SubscriptionDiscountEntitledLinesLinesArgs |
Represents the subscription lines the discount applies on. |
SubscriptionDiscountFixedAmountValue |
The value of the discount and how it will be applied. |
SubscriptionDiscountPercentageValue |
The percentage value of the discount. |
SubscriptionDraft |
Represents a Subscription Draft. |
SubscriptionDraftCommitPayload |
Return type for subscriptionDraftCommit mutation. |
SubscriptionDraftConcatenatedBillingCyclesArgs |
Represents a Subscription Draft. |
SubscriptionDraftCustomerPaymentMethodArgs |
Represents a Subscription Draft. |
SubscriptionDraftDeliveryOptionsArgs |
Represents a Subscription Draft. |
SubscriptionDraftDiscountAddPayload |
Return type for subscriptionDraftDiscountAdd mutation. |
SubscriptionDraftDiscountCodeApplyPayload |
Return type for subscriptionDraftDiscountCodeApply mutation. |
SubscriptionDraftDiscountRemovePayload |
Return type for subscriptionDraftDiscountRemove mutation. |
SubscriptionDraftDiscountsAddedArgs |
Represents a Subscription Draft. |
SubscriptionDraftDiscountsArgs |
Represents a Subscription Draft. |
SubscriptionDraftDiscountsRemovedArgs |
Represents a Subscription Draft. |
SubscriptionDraftDiscountsUpdatedArgs |
Represents a Subscription Draft. |
SubscriptionDraftDiscountUpdatePayload |
Return type for subscriptionDraftDiscountUpdate mutation. |
SubscriptionDraftFreeShippingDiscountAddPayload |
Return type for subscriptionDraftFreeShippingDiscountAdd mutation. |
SubscriptionDraftFreeShippingDiscountUpdatePayload |
Return type for subscriptionDraftFreeShippingDiscountUpdate mutation. |
SubscriptionDraftInput |
The input fields required to create a Subscription Draft. |
SubscriptionDraftLineAddPayload |
Return type for subscriptionDraftLineAdd mutation. |
SubscriptionDraftLineRemovePayload |
Return type for subscriptionDraftLineRemove mutation. |
SubscriptionDraftLinesAddedArgs |
Represents a Subscription Draft. |
SubscriptionDraftLinesArgs |
Represents a Subscription Draft. |
SubscriptionDraftLinesRemovedArgs |
Represents a Subscription Draft. |
SubscriptionDraftLineUpdatePayload |
Return type for subscriptionDraftLineUpdate mutation. |
SubscriptionDraftShippingOptionsArgs |
Represents a Subscription Draft. |
SubscriptionDraftUpdatePayload |
Return type for subscriptionDraftUpdate mutation. |
SubscriptionDraftUserError |
Represents a Subscription Draft error. |
SubscriptionFreeShippingDiscountInput |
The input fields for a subscription free shipping discount on a contract. |
SubscriptionLine |
Represents a Subscription Line. |
SubscriptionLineConnection |
An auto-generated type for paginating through multiple SubscriptionLines. |
SubscriptionLineEdge |
An auto-generated type which holds one SubscriptionLine and a cursor during pagination. |
SubscriptionLineInput |
The input fields required to add a new subscription line to a contract. |
SubscriptionLineUpdateInput |
The input fields required to update a subscription line on a contract. |
SubscriptionLocalDeliveryOption |
A local delivery option for a subscription contract. |
SubscriptionMailingAddress |
Represents a Mailing Address on a Subscription. |
SubscriptionManualDiscount |
Custom subscription discount. |
SubscriptionManualDiscountConnection |
An auto-generated type for paginating through multiple SubscriptionManualDiscounts. |
SubscriptionManualDiscountEdge |
An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination. |
SubscriptionManualDiscountEntitledLinesInput |
The input fields for the subscription lines the discount applies on. |
SubscriptionManualDiscountFixedAmountInput |
The input fields for the fixed amount value of the discount and distribution on the lines. |
SubscriptionManualDiscountInput |
The input fields for a subscription discount on a contract. |
SubscriptionManualDiscountLinesInput |
The input fields for line items that the discount refers to. |
SubscriptionManualDiscountValueInput |
The input fields for the discount value and its distribution. |
SubscriptionPickupOption |
A pickup option to deliver a subscription contract. |
SubscriptionPricingPolicy |
Represents a Subscription Line Pricing Policy. |
SubscriptionPricingPolicyCycleDiscountsInput |
The input fields for an array containing all pricing changes for each billing cycle. |
SubscriptionPricingPolicyInput |
The input fields for expected price changes of the subscription line over time. |
SubscriptionShippingOption |
A shipping option to deliver a subscription contract. |
SubscriptionShippingOptionResultFailure |
Failure determining available shipping options for delivery of a subscription contract. |
SubscriptionShippingOptionResultSuccess |
A shipping option for delivery of a subscription contract. |
SuggestedOrderTransaction |
A suggested transaction. Suggested transaction are usually used in the context of refunds and exchanges. |
SuggestedRefund |
Represents a refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund. |
SuggestedReturnRefund |
Represents a return refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund for the return. |
TableData |
The result in a tabular format with schema information and formatted and unformatted row data. |
TableDataColumn |
A nested array representation of the data. An index in an array represents a row number. |
TableResponse |
The default table response structure for a ShopifyQL query. |
TagsAddPayload |
Return type for tagsAdd mutation. |
TagsRemovePayload |
Return type for tagsRemove mutation. |
TaxAppConfiguration |
Tax app configuration of a merchant. |
TaxAppConfigurePayload |
Return type for taxAppConfigure mutation. |
TaxAppConfigureUserError |
An error that occurs during the execution of TaxAppConfigure . |
TaxLine |
Represents a single tax applied to the associated line item. |
TenderTransaction |
A TenderTransaction represents a transaction with financial impact on a shop’s balance sheet. A tender transaction always represents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions for reconciling a shop’s cash flow. A TenderTransaction is immutable once created. |
TenderTransactionConnection |
An auto-generated type for paginating through multiple TenderTransactions. |
TenderTransactionCreditCardDetails |
Information about the credit card used for this transaction. |
TenderTransactionEdge |
An auto-generated type which holds one TenderTransaction and a cursor during pagination. |
TipSale |
A sale associated with a tip. |
TransactionFee |
Transaction fee related to an order transaction. |
TranslatableContent |
Translatable content of a resource’s field. |
TranslatableResource |
A resource that has translatable fields. |
TranslatableResourceConnection |
An auto-generated type for paginating through multiple TranslatableResources. |
TranslatableResourceEdge |
An auto-generated type which holds one TranslatableResource and a cursor during pagination. |
TranslatableResourceTranslationsArgs |
A resource that has translatable fields. |
Translation |
Translation of a field of a resource. |
TranslationInput |
The input fields and values for creating or updating a translation. |
TranslationsRegisterPayload |
Return type for translationsRegister mutation. |
TranslationsRemovePayload |
Return type for translationsRemove mutation. |
TranslationUserError |
Represents an error that happens during the execution of a translation mutation. |
TypedAttribute |
Represents a typed custom attribute. |
UnknownSale |
This is represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale. |
UpdateMediaInput |
The input fields required to update a media object. |
UrlRedirect |
The URL redirect for the online store. |
UrlRedirectBulkDeleteAllPayload |
Return type for urlRedirectBulkDeleteAll mutation. |
UrlRedirectBulkDeleteByIdsPayload |
Return type for urlRedirectBulkDeleteByIds mutation. |
UrlRedirectBulkDeleteByIdsUserError |
An error that occurs during the execution of UrlRedirectBulkDeleteByIds . |
UrlRedirectBulkDeleteBySavedSearchPayload |
Return type for urlRedirectBulkDeleteBySavedSearch mutation. |
UrlRedirectBulkDeleteBySavedSearchUserError |
An error that occurs during the execution of UrlRedirectBulkDeleteBySavedSearch . |
UrlRedirectBulkDeleteBySearchPayload |
Return type for urlRedirectBulkDeleteBySearch mutation. |
UrlRedirectBulkDeleteBySearchUserError |
An error that occurs during the execution of UrlRedirectBulkDeleteBySearch . |
UrlRedirectConnection |
An auto-generated type for paginating through multiple UrlRedirects. |
UrlRedirectCreatePayload |
Return type for urlRedirectCreate mutation. |
UrlRedirectDeletePayload |
Return type for urlRedirectDelete mutation. |
UrlRedirectEdge |
An auto-generated type which holds one UrlRedirect and a cursor during pagination. |
UrlRedirectImport |
<p>A request to import a [URLRedirect ](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object into the Online Store channel. Apps can use this to query the state of an UrlRedirectImport request.</p><p>For more information, see [url-redirect ](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect)s.</p> |
UrlRedirectImportCreatePayload |
Return type for urlRedirectImportCreate mutation. |
UrlRedirectImportPreview |
A preview of a URL redirect import row. |
UrlRedirectImportSubmitPayload |
Return type for urlRedirectImportSubmit mutation. |
UrlRedirectImportUserError |
Represents an error that happens during execution of a redirect import mutation. |
UrlRedirectInput |
The input fields to create or update a URL redirect. |
UrlRedirectUpdatePayload |
Return type for urlRedirectUpdate mutation. |
UrlRedirectUserError |
Represents an error that happens during execution of a redirect mutation. |
UserError |
Represents an error in the input of a mutation. |
UtmInput |
Specifies the [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) that are associated with a related marketing campaign. |
UtmParameters |
Represents a set of UTM parameters. |
VaultCreditCard |
Represents a credit card payment instrument. |
VaultPaypalBillingAgreement |
Represents a paypal billing agreement payment instrument. |
Vector3 |
Representation of 3d vectors and points. It can represent either the coordinates of a point in space, a direction, or size. Presented as an object with three floating-point values. |
Video |
Represents a Shopify hosted video. |
VideoSource |
<p>Represents a source for a Shopify hosted video.</p><p>Types of sources include the original video, lower resolution versions of the original video, and an m3u8 playlist file.</p><p>Only [videos](https://shopify.dev/api/admin-graphql/latest/objects/video) with a status field of [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready) have sources.</p> |
WebhookEventBridgeEndpoint |
An Amazon EventBridge partner event source to which webhook subscriptions publish events. |
WebhookHttpEndpoint |
An HTTPS endpoint to which webhook subscriptions send POST requests. |
WebhookPubSubEndpoint |
A Google Cloud Pub/Sub topic to which webhook subscriptions publish events. |
WebhookSubscription |
A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API. It describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic. When an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination. Learn more about the [webhooks system](https://shopify.dev/apps/webhooks). |
WebhookSubscriptionConnection |
An auto-generated type for paginating through multiple WebhookSubscriptions. |
WebhookSubscriptionCreatePayload |
Return type for webhookSubscriptionCreate mutation. |
WebhookSubscriptionDeletePayload |
Return type for webhookSubscriptionDelete mutation. |
WebhookSubscriptionEdge |
An auto-generated type which holds one WebhookSubscription and a cursor during pagination. |
WebhookSubscriptionInput |
The input fields for a webhook subscription. |
WebhookSubscriptionUpdatePayload |
Return type for webhookSubscriptionUpdate mutation. |
WebPixel |
A web pixel settings. |
WebPixelCreatePayload |
Return type for webPixelCreate mutation. |
WebPixelDeletePayload |
Return type for webPixelDelete mutation. |
WebPixelInput |
The input fields to use to update a web pixel. |
WebPixelUpdatePayload |
Return type for webPixelUpdate mutation. |
Weight |
A weight, which includes a numeric value and a unit of measurement. |
WeightInput |
The input fields for the weight unit and value inputs. |