{ "data": { "__schema": { "queryType": { "name": "QueryRoot" }, "mutationType": { "name": "Mutation" }, "subscriptionType": null, "types": [ { "kind": "SCALAR", "name": "ARN", "description": "An Amazon Web Services Amazon Resource Name (ARN), including the Region and account ID.\nFor more information, refer to [Amazon Resource Names](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonedCheckout", "description": "A checkout that was abandoned by the customer.", "fields": [ { "name": "abandonedCheckoutUrl", "description": "The URL for the buyer to recover their checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "A list of the line items in this checkout.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonedCheckoutLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItemsQuantity", "description": "The number of products in the checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "The sum of all items in the checkout, including discounts, shipping, taxes, and tips.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonedCheckoutLineItem", "description": "A single line item in an abandoned checkout.", "fields": [ { "name": "customAttributes", "description": "A list of extra information that has been added to the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotalPriceSet", "description": "Final total price for the entire quantity of this line item, including discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotalPriceWithCodeDiscount", "description": "The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceSet", "description": "The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceWithCodeDiscount", "description": "The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated with the line item's variant or product.\nNULL if the line item has no product, or if neither the variant nor the product have an image.\n", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalPriceSet", "description": "Original total price for the entire quantity of this line item, before discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "Original price for a single unit of this line item, before discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product for this line item.\nNULL for custom line items and products that were deleted after checkout began.\n", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "SKU for the inventory item associated with the variant, if any.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Title of the line item. Defaults to the product's title.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "Product variant for this line item.\nNULL for custom line items and variants that were deleted after checkout began.\n", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "Title of the variant for this line item.\nNULL for custom line items and products that don't have distinct variants.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonedCheckoutLineItemConnection", "description": "An auto-generated type for paginating through multiple AbandonedCheckoutLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonedCheckoutLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AbandonedCheckoutLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonedCheckoutLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonedCheckoutLineItemEdge", "description": "An auto-generated type which holds one AbandonedCheckoutLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AbandonedCheckoutLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonedCheckoutLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Abandonment", "description": "A browse, cart, or checkout that was abandoned by a customer.", "fields": [ { "name": "abandonedCheckoutPayload", "description": "The abandonment payload for the abandoned checkout.", "args": [], "type": { "kind": "OBJECT", "name": "AbandonedCheckout", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "abandonmentType", "description": "The abandonment type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AbandonmentAbandonmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "The app associated with an abandoned checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartUrl", "description": "Permalink to the cart page.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the abandonment was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer who abandoned this event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerHasNoDraftOrderSinceAbandonment", "description": "Whether the customer has a draft order since this abandonment has been abandoned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerHasNoOrderSinceAbandonment", "description": "Whether the customer has completed an order since this checkout has been abandoned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "daysSinceLastAbandonmentEmail", "description": "The number of days since the last abandonment email was sent to the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "emailSentAt", "description": "When the email was sent, if that's the case.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "emailState", "description": "The email state (e.g., sent or not sent).", "args": [], "type": { "kind": "ENUM", "name": "AbandonmentEmailState", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hoursSinceLastAbandonedCheckout", "description": "The number of hours since the customer has last abandoned a checkout.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryAvailable", "description": "Whether the products in abandonment are available.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isFromCustomStorefront", "description": "Whether the abandonment event comes from a custom storefront channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isFromOnlineStore", "description": "Whether the abandonment event comes from the Online Store sales channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isFromShopApp", "description": "Whether the abandonment event comes from the Shop app sales channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isFromShopPay", "description": "Whether the abandonment event comes from Shop Pay.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isMostSignificantAbandonment", "description": "Whether the customer didn't complete another most significant step since this abandonment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastBrowseAbandonmentDate", "description": "The date for the latest browse abandonment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastCartAbandonmentDate", "description": "The date for the latest cart abandonment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastCheckoutAbandonmentDate", "description": "The date for the latest checkout abandonment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mostRecentStep", "description": "The most recent step type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AbandonmentAbandonmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsAddedToCart", "description": "The products added to the cart during the customer abandoned visit.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisitProductInfoConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsViewed", "description": "The products viewed during the customer abandoned visit.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisitProductInfoConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "visitStartedAt", "description": "The date and time when the visit started.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AbandonmentAbandonmentType", "description": "Specifies the abandonment type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BROWSE", "description": "The abandonment event is an abandoned browse.", "isDeprecated": false, "deprecationReason": null }, { "name": "CART", "description": "The abandonment event is an abandoned cart.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHECKOUT", "description": "The abandonment event is an abandoned checkout.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AbandonmentDeliveryState", "description": "Specifies the delivery state of a marketing activity.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_SENT", "description": "The marketing activity action has not yet been sent.", "isDeprecated": false, "deprecationReason": null }, { "name": "SENT", "description": "The marketing activity action has been sent.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "The marketing activity action has been scheduled for later delivery.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AbandonmentEmailState", "description": "Specifies the email state.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_SENT", "description": "The email has not yet been sent.", "isDeprecated": false, "deprecationReason": null }, { "name": "SENT", "description": "The email has been sent.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "The email has been scheduled for later delivery.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonmentEmailStateUpdatePayload", "description": "Return type for `abandonmentEmailStateUpdate` mutation.", "fields": [ { "name": "abandonment", "description": "The updated abandonment.", "args": [], "type": { "kind": "OBJECT", "name": "Abandonment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonmentEmailStateUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonmentEmailStateUpdateUserError", "description": "An error that occurs during the execution of `AbandonmentEmailStateUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "AbandonmentEmailStateUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AbandonmentEmailStateUpdateUserErrorCode", "description": "Possible error codes that can be returned by `AbandonmentEmailStateUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ABANDONMENT_NOT_FOUND", "description": "Unable to find an Abandonment for the provided ID.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonmentUpdateActivitiesDeliveryStatusesPayload", "description": "Return type for `abandonmentUpdateActivitiesDeliveryStatuses` mutation.", "fields": [ { "name": "abandonment", "description": "The updated abandonment.", "args": [], "type": { "kind": "OBJECT", "name": "Abandonment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", "description": "An error that occurs during the execution of `AbandonmentUpdateActivitiesDeliveryStatuses`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode", "description": "Possible error codes that can be returned by `AbandonmentUpdateActivitiesDeliveryStatusesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ABANDONMENT_NOT_FOUND", "description": "Unable to find an Abandonment for the provided ID.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING_ACTIVITY_NOT_FOUND", "description": "Unable to find a marketing activity for the provided ID.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_STATUS_INFO_NOT_FOUND", "description": "Unable to find delivery status info for the provided ID.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AccessScope", "description": "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.\n", "fields": [ { "name": "description", "description": "A description of the actions that the access scope allows an app to perform.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "A readable string that represents the access scope. The string usually follows the format `{action}_{resource}`. `{action}` is `read` or `write`, and `{resource}` is the resource that the action can be performed on. `{action}` and `{resource}` are separated by an underscore. For example, `read_orders` or `write_products`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddAllProductsOperation", "description": "Represents an operation publishing all products to a publication.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "processedRowCount", "description": "The count of processed rows, summing imported, failed, and skipped rows.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rowCount", "description": "Represents a rows objects within this background operation.", "args": [], "type": { "kind": "OBJECT", "name": "RowCount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AdditionalFee", "description": "The additional fees that have been applied to the order.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "A list of taxes charged on the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AdditionalFeeSale", "description": "A sale associated with an additional fee charge.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "additionalFee", "description": "The additional fees for the associated sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleAdditionalFee", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AdjustmentSale", "description": "A sale associated with an order price adjustment.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AdjustmentsSortKeys", "description": "The set of valid sort keys for the Adjustments query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TIME", "description": "Sort by the `time` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AllDiscountItems", "description": "Targets all items the cart for a specified discount.", "fields": [ { "name": "allItems", "description": "Whether all items are eligible for the discount. This value always returns `true`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ApiVersion", "description": "A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).\nVersions are commonly referred to by their handle (for example, `2021-10`).\n", "fields": [ { "name": "displayName", "description": "The human-readable name of the version.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "supported", "description": "Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "App", "description": "A Shopify application.", "fields": [ { "name": "apiKey", "description": "A unique application API identifier.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appStoreAppUrl", "description": "App store page URL of the app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appStoreDeveloperUrl", "description": "App store page URL of the developer who created the app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "availableAccessScopes", "description": "The access scopes available to the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AccessScope", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "banner", "description": "Banner image for the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Description of the app.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "developerName", "description": "The name of the app developer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "developerType", "description": "The type of app developer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppDeveloperType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "developerUrl", "description": "Website of the developer who created the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `appStoreDeveloperUrl` instead." }, { "name": "embedded", "description": "Whether the app uses the Embedded App SDK.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "failedRequirements", "description": "Requirements that must be met before the app can be installed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FailedRequirement", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "features", "description": "A list of app features that are shown in the Shopify App Store listing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "feedback", "description": "Feedback from this app about the store.", "args": [], "type": { "kind": "OBJECT", "name": "AppFeedback", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "Handle of the app.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "Icon that represents the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "installUrl", "description": "Webpage where you can install the app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "installation", "description": "Corresponding AppInstallation for this shop and App.\nReturns null if the App is not installed.\n", "args": [], "type": { "kind": "OBJECT", "name": "AppInstallation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPostPurchaseAppInUse", "description": "Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "launchUrl", "description": "Webpage that the app starts in.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use AppInstallation.launchUrl instead" }, { "name": "navigationItems", "description": "Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "NavigationItem", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use AppInstallation.navigationItems instead" }, { "name": "previouslyInstalled", "description": "Whether the app was previously installed on the current shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricingDetails", "description": "Detailed information about the app pricing.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricingDetailsSummary", "description": "Summary of the app pricing details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privacyPolicyUrl", "description": "Link to app privacy policy.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicCategory", "description": "The public category for the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppPublicCategory", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "published", "description": "Whether the app is published to the Shopify App Store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requestedAccessScopes", "description": "The access scopes requested by the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AccessScope", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "screenshots", "description": "Screenshots of the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyDeveloped", "description": "Whether the app was developed by Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Name of the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uninstallMessage", "description": "Message that appears when the app is uninstalled. For example:\nBy removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uninstallUrl", "description": "Webpage where you can uninstall the app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AppInstallation.uninstallUrl instead" }, { "name": "webhookApiVersion", "description": "The webhook API version for the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppCatalog", "description": "A catalog that defines the publication associated with an app.\n", "fields": [ { "name": "apps", "description": "The apps associated with the catalog.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "operations", "description": "Most recent catalog operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list associated with the catalog.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "A group of products and collections that's published to a catalog.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppConnection", "description": "An auto-generated type for paginating through multiple Apps.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppCredit", "description": "App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify.", "fields": [ { "name": "amount", "description": "The amount that can be used towards future app purchases in Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the app credit was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the app credit.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the app credit is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppCreditConnection", "description": "An auto-generated type for paginating through multiple AppCredits.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppCreditEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppCreditEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppCredit", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppCreditEdge", "description": "An auto-generated type which holds one AppCredit and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppCreditEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppCredit", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppDeveloperType", "description": "Possible types of app developer.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHOPIFY", "description": "Indicates the app developer is Shopify.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARTNER", "description": "Indicates the app developer is a Partner.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT", "description": "Indicates the app developer works directly for a Merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "Indicates the app developer is unknown. It is not categorized as any of the other developer types.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppDiscountType", "description": "A script that defines a discount type.", "fields": [ { "name": "app", "description": "The app providing the app discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appBridge", "description": "The App Bridge details for discount type configuration.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FunctionsAppBridge", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appKey", "description": "The client ID of the app providing the app discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "A description of the app discount type.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the app discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "functionId", "description": "The ID of the function providing the app discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "The target type of the app discount type. Possible values: `SHIPPING_LINE` and `LINE_ITEM`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the app discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppEdge", "description": "An auto-generated type which holds one App and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppFeedback", "description": "Reports the status of shops and their resources and displays this information\nwithin Shopify admin. AppFeedback is used to notify merchants about steps they need to take\nto set up an app on their store.\n", "fields": [ { "name": "app", "description": "The application associated to the feedback.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "link", "description": "A link to where merchants can resolve errors.", "args": [], "type": { "kind": "OBJECT", "name": "Link", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "messages", "description": "The feedback message presented to the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppInstallation", "description": "Represents an installed application on a shop.", "fields": [ { "name": "accessScopes", "description": "The access scopes granted to the application by a merchant during installation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AccessScope", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "activeSubscriptions", "description": "The active application subscriptions billed to the shop on a recurring basis.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "allSubscriptions", "description": "All subscriptions created for a shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppSubscriptionSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscriptionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "Application which is installed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channel", "description": "Channel associated with the installed application.", "args": [], "type": { "kind": "OBJECT", "name": "Channel", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publication` instead." }, { "name": "credits", "description": "Credits that can be used towards future app purchases.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppTransactionSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppCreditConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "launchUrl", "description": "The URL to launch the application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "oneTimePurchases", "description": "One-time purchases to a shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppTransactionSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppPurchaseOneTimeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "publication", "description": "The publication associated with the installed application.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "revenueAttributionRecords", "description": "The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppRevenueAttributionRecordSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppRevenueAttributionRecordConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptions", "description": "Subscriptions charge to a shop on a recurring basis.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `activeSubscriptions` instead." }, { "name": "uninstallUrl", "description": "The URL to uninstall the application.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppInstallationCategory", "description": "The possible categories of an app installation, based on their purpose\nor the environment they can run in.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CHANNEL", "description": "Apps that serve as channels through which sales are made, such as the online store.", "isDeprecated": false, "deprecationReason": null }, { "name": "POS_EMBEDDED", "description": "Apps that can be used in the POS mobile client.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppInstallationConnection", "description": "An auto-generated type for paginating through multiple AppInstallations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppInstallationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppInstallationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppInstallation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppInstallationEdge", "description": "An auto-generated type which holds one AppInstallation and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppInstallationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppInstallation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppInstallationPrivacy", "description": "The levels of privacy of an app installation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PUBLIC", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "PRIVATE", "description": null, "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppInstallationSortKeys", "description": "The set of valid sort keys for the AppInstallation query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INSTALLED_AT", "description": "Sort by the `installed_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_TITLE", "description": "Sort by the `app_title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AppPlanInput", "description": "The pricing model for the app subscription.\nThe pricing model input can be either `appRecurringPricingDetails` or `appUsagePricingDetails`.\n", "fields": null, "inputFields": [ { "name": "appUsagePricingDetails", "description": "The pricing details for usage-based billing.", "type": { "kind": "INPUT_OBJECT", "name": "AppUsagePricingInput", "ofType": null }, "defaultValue": null }, { "name": "appRecurringPricingDetails", "description": "The pricing details for recurring billing.", "type": { "kind": "INPUT_OBJECT", "name": "AppRecurringPricingInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppPlanV2", "description": "The app plan that the merchant is subscribed to.", "fields": [ { "name": "pricingDetails", "description": "The plan billed to a shop on a recurring basis.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "AppPricingDetails", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "AppPricingDetails", "description": "The information about the price that's charged to a shop every plan period.\nThe concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppRecurringPricing", "ofType": null }, { "kind": "OBJECT", "name": "AppUsagePricing", "ofType": null } ] }, { "kind": "ENUM", "name": "AppPricingInterval", "description": "The frequency at which the shop is billed for an app subscription.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ANNUAL", "description": "The app subscription bills the shop annually.", "isDeprecated": false, "deprecationReason": null }, { "name": "EVERY_30_DAYS", "description": "The app subscription bills the shop every 30 days.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppPublicCategory", "description": "The public-facing category for an app.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRIVATE", "description": "The app's public category is [private](https://shopify.dev/apps/distribution#deprecated-app-types).", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC", "description": "The app's public category is [public](https://shopify.dev/apps/distribution#capabilities-and-requirements).", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOM", "description": "The app's public category is [custom](https://shopify.dev/apps/distribution#capabilities-and-requirements).", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The app's public category is other. An app is in this category if it's not classified under any of the other app types (private, public, or custom).", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "AppPurchase", "description": "Services and features purchased once by the store.", "fields": [ { "name": "createdAt", "description": "The date and time when the app purchase occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The amount to be charged to the store for the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppPurchaseStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the app purchase is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppPurchaseOneTime", "ofType": null } ] }, { "kind": "OBJECT", "name": "AppPurchaseOneTime", "description": "Services and features purchased once by a store.", "fields": [ { "name": "createdAt", "description": "The date and time when the app purchase occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The amount to be charged to the store for the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the app purchase.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppPurchaseStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the app purchase is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "AppPurchase", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppPurchaseOneTimeConnection", "description": "An auto-generated type for paginating through multiple AppPurchaseOneTimes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppPurchaseOneTimeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppPurchaseOneTimeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppPurchaseOneTime", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppPurchaseOneTimeCreatePayload", "description": "Return type for `appPurchaseOneTimeCreate` mutation.", "fields": [ { "name": "appPurchaseOneTime", "description": "The newly created app one-time purchase.", "args": [], "type": { "kind": "OBJECT", "name": "AppPurchaseOneTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "confirmationUrl", "description": "The URL that the merchant can access to approve or decline the newly created app one-time purchase.\n\nIf the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined.\nIf the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`.\n\nYou get paid after the charge is activated.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppPurchaseOneTimeEdge", "description": "An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppPurchaseOneTimeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppPurchaseOneTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppPurchaseStatus", "description": "The approval status of the app purchase.\n\nThe merchant is charged for the purchase immediately after approval, and the status changes to `active`.\nIf the payment fails, then the app purchase remains `pending`.\n\nPurchases start as `pending` and can change to: `active`, `declined`, `expired`. After a purchase changes, it\nremains in that final state.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACCEPTED", "description": "The app purchase has been approved by the merchant and is ready to be activated by the app. App purchases created through the GraphQL Admin API are activated upon approval.", "isDeprecated": true, "deprecationReason": "As of API version 2021-01, when a merchant accepts an app purchase, the status immediately changes from `pending` to `active`." }, { "name": "ACTIVE", "description": "The app purchase was approved by the merchant and has been activated by the app. Active app purchases are charged to the merchant and are paid out to the partner.", "isDeprecated": false, "deprecationReason": null }, { "name": "DECLINED", "description": "The app purchase was declined by the merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The app purchase was not accepted within two days of being created.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The app purchase is pending approval by the merchant.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppRecurringPricing", "description": "The pricing information about a subscription app.\nThe object contains an interval (the frequency at which the shop is billed for an app subscription) and\na price (the amount to be charged to the subscribing shop at each interval).\n", "fields": [ { "name": "discount", "description": "The discount applied to the subscription for a given number of billing intervals.", "args": [], "type": { "kind": "OBJECT", "name": "AppSubscriptionDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The frequency at which the subscribing shop is billed for an app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppPricingInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The amount and currency to be charged to the subscribing shop every billing interval.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AppRecurringPricingInput", "description": "Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval.", "fields": null, "inputFields": [ { "name": "interval", "description": "How often the app subscription generates a charge.", "type": { "kind": "ENUM", "name": "AppPricingInterval", "ofType": null }, "defaultValue": "EVERY_30_DAYS" }, { "name": "price", "description": "The amount to be charged to the store every billing interval.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "discount", "description": "The discount applied to the subscription for a given number of billing intervals.", "type": { "kind": "INPUT_OBJECT", "name": "AppSubscriptionDiscountInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppRevenueAttributionRecord", "description": "Represents app revenue that was captured externally by the partner.", "fields": [ { "name": "amount", "description": "The financial amount captured in this attribution.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "capturedAt", "description": "The timestamp when the financial amount was captured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The timestamp at which this revenue attribution was issued.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "idempotencyKey", "description": "The unique value submitted during the creation of the app revenue attribution record.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Indicates whether this is a test submission.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of revenue attribution.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppRevenueAttributionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppRevenueAttributionRecordConnection", "description": "An auto-generated type for paginating through multiple AppRevenueAttributionRecords.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppRevenueAttributionRecordEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppRevenueAttributionRecordEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppRevenueAttributionRecord", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppRevenueAttributionRecordEdge", "description": "An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppRevenueAttributionRecordEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppRevenueAttributionRecord", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppRevenueAttributionRecordSortKeys", "description": "The set of valid sort keys for the AppRevenueAttributionRecord query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppRevenueAttributionType", "description": "Represents the billing types of revenue attribution.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APPLICATION_PURCHASE", "description": "App purchase related revenue collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "APPLICATION_SUBSCRIPTION", "description": "App subscription revenue collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "APPLICATION_USAGE", "description": "App usage-based revenue collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "Other app revenue collection type.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscription", "description": "Provides users access to services and/or features for a duration of time.", "fields": [ { "name": "createdAt", "description": "The date and time when the app subscription was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentPeriodEnd", "description": "The date and time when the current app subscription period ends. Returns `null` if the subscription isn't active.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "The plans attached to the app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscriptionLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnUrl", "description": "The URL that the merchant is redirected to after approving the app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppSubscriptionStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Specifies whether the app subscription is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "trialDays", "description": "The number of free trial days, starting at the subscription's creation date, by which billing is delayed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionCancelPayload", "description": "Return type for `appSubscriptionCancel` mutation.", "fields": [ { "name": "appSubscription", "description": "The cancelled app subscription.", "args": [], "type": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionConnection", "description": "An auto-generated type for paginating through multiple AppSubscriptions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscriptionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppSubscriptionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionCreatePayload", "description": "Return type for `appSubscriptionCreate` mutation.", "fields": [ { "name": "appSubscription", "description": "The newly-created app subscription.", "args": [], "type": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "confirmationUrl", "description": "The URL pointing to the page where the merchant approves or declines the charges for an app subscription.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionDiscount", "description": "Discount applied to the recurring pricing portion of a subscription.", "fields": [ { "name": "durationLimitInIntervals", "description": "The total number of billing intervals to which the discount will be applied.\nThe discount will be applied to an indefinite number of billing intervals if this value is blank.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceAfterDiscount", "description": "The price of the subscription after the discount is applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingDurationInIntervals", "description": "The remaining number of billing intervals to which the discount will be applied.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount applied every billing interval.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "AppSubscriptionDiscountValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionDiscountAmount", "description": "The fixed amount value of a discount.", "fields": [ { "name": "amount", "description": "The fixed amount value of a discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AppSubscriptionDiscountInput", "description": "The input fields to specify a discount to the recurring pricing portion of a subscription over a number of billing intervals.\n", "fields": null, "inputFields": [ { "name": "value", "description": "The value to be discounted every billing interval.", "type": { "kind": "INPUT_OBJECT", "name": "AppSubscriptionDiscountValueInput", "ofType": null }, "defaultValue": null }, { "name": "durationLimitInIntervals", "description": "The total number of billing intervals to which the discount will be applied. Must be greater than 0.\nThe discount will be applied to an indefinite number of billing intervals if this value is left blank.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionDiscountPercentage", "description": "The percentage value of a discount.", "fields": [ { "name": "percentage", "description": "The percentage value of a discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "AppSubscriptionDiscountValue", "description": "The value of the discount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppSubscriptionDiscountAmount", "ofType": null }, { "kind": "OBJECT", "name": "AppSubscriptionDiscountPercentage", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "AppSubscriptionDiscountValueInput", "description": "The input fields to specify the value discounted every billing interval.", "fields": null, "inputFields": [ { "name": "percentage", "description": "The percentage value of a discount.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "amount", "description": "The monetary value of a discount.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionEdge", "description": "An auto-generated type which holds one AppSubscription and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppSubscriptionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionLineItem", "description": "The plan attached to an app subscription.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "plan", "description": "The pricing model for the app subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppPlanV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageRecords", "description": "A list of the store's usage records for a usage pricing plan.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppUsageRecordSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppUsageRecordConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AppSubscriptionLineItemInput", "description": "The input fields to add more than one pricing plan to an app subscription.", "fields": null, "inputFields": [ { "name": "plan", "description": "The pricing model for the app subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AppPlanInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionLineItemUpdatePayload", "description": "Return type for `appSubscriptionLineItemUpdate` mutation.", "fields": [ { "name": "appSubscription", "description": "The updated app subscription.", "args": [], "type": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "confirmationUrl", "description": "The URL where the merchant approves or declines the updated app subscription line item.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppSubscriptionReplacementBehavior", "description": "The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APPLY_IMMEDIATELY", "description": "Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription.", "isDeprecated": false, "deprecationReason": null }, { "name": "APPLY_ON_NEXT_BILLING_CYCLE", "description": "Defers canceling the merchant's current app subscription and applying the newly created app subscription until the start of the next billing cycle. This value is ignored if the new app subscription is using a different currency than the current app subscription, in which case the new app subscription is applied immediately.", "isDeprecated": false, "deprecationReason": null }, { "name": "STANDARD", "description": "Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription, with the exception of\nthe following scenarios where replacing the current app subscription will be deferred until the start of the next billing cycle.\n1) The current app subscription is annual and the newly created app subscription is annual, using the same currency, but is of a lesser value.\n2) The current app subscription is annual and the newly created app subscription is monthly and using the same currency.\n3) The current app subscription and the newly created app subscription are identical except for the `discount` value.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppSubscriptionSortKeys", "description": "The set of valid sort keys for the AppSubscription query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppSubscriptionStatus", "description": "The status of the app subscription.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "The app subscription is pending approval by the merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACCEPTED", "description": "The app subscription has been approved by the merchant and is ready to be activated by the app.", "isDeprecated": true, "deprecationReason": "As of API version 2021-01, when a merchant approves an app subscription, the status immediately transitions from `pending` to `active`." }, { "name": "ACTIVE", "description": "The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop. After payment, partners receive payouts.", "isDeprecated": false, "deprecationReason": null }, { "name": "DECLINED", "description": "The app subscription was declined by the merchant. This is a terminal state.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The app subscription wasn't approved by the merchant within two days of being created. This is a terminal state.", "isDeprecated": false, "deprecationReason": null }, { "name": "FROZEN", "description": "The app subscription is on hold due to non-payment. The subscription re-activates after payments resume.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLED", "description": "The app subscription was cancelled by the app. This could be caused by the app being uninstalled, a new app subscription being activated, or a direct cancellation by the app. This is a terminal state.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionTrialExtendPayload", "description": "Return type for `appSubscriptionTrialExtend` mutation.", "fields": [ { "name": "appSubscription", "description": "The app subscription that had its trial extended.", "args": [], "type": { "kind": "OBJECT", "name": "AppSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscriptionTrialExtendUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppSubscriptionTrialExtendUserError", "description": "An error that occurs during the execution of `AppSubscriptionTrialExtend`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "AppSubscriptionTrialExtendUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppSubscriptionTrialExtendUserErrorCode", "description": "Possible error codes that can be returned by `AppSubscriptionTrialExtendUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUBSCRIPTION_NOT_FOUND", "description": "The app subscription wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRIAL_NOT_ACTIVE", "description": "The trial isn't active.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_NOT_ACTIVE", "description": "The app subscription isn't active.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "AppTransactionSortKeys", "description": "The set of valid sort keys for the AppTransaction query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AppUsagePricing", "description": "Defines a usage pricing model for the app subscription.\nThese charges are variable based on how much the merchant uses the app.\n", "fields": [ { "name": "balanceUsed", "description": "The total usage records for interval.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cappedAmount", "description": "The capped amount prevents the merchant from being charged for any usage over that amount during a billing period.\nThis prevents billing from exceeding a maximum threshold over the duration of the billing period.\nFor the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The frequency with which the app usage records are billed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AppPricingInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "terms", "description": "The terms and conditions for app usage pricing.\nMust be present in order to create usage charges.\nThe terms are presented to the merchant when they approve an app's usage charges.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AppUsagePricingInput", "description": "The input fields to issue arbitrary charges for app usage associated with a subscription.", "fields": null, "inputFields": [ { "name": "cappedAmount", "description": "The maximum amount of usage charges that can be incurred within a subscription billing interval.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "terms", "description": "The terms and conditions for app usage. These terms stipulate the pricing model for the charges that an app creates.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppUsageRecord", "description": "Store usage for app subscriptions with usage pricing.", "fields": [ { "name": "createdAt", "description": "The date and time when the usage record was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the app usage record.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "idempotencyKey", "description": "A unique key generated by the client to avoid duplicate charges.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the usage record.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionLineItem", "description": "Defines the usage pricing plan the merchant is subscribed to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppSubscriptionLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppUsageRecordConnection", "description": "An auto-generated type for paginating through multiple AppUsageRecords.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppUsageRecordEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in AppUsageRecordEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppUsageRecord", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppUsageRecordCreatePayload", "description": "Return type for `appUsageRecordCreate` mutation.", "fields": [ { "name": "appUsageRecord", "description": "The newly created app usage record.", "args": [], "type": { "kind": "OBJECT", "name": "AppUsageRecord", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppUsageRecordEdge", "description": "An auto-generated type which holds one AppUsageRecord and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of AppUsageRecordEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppUsageRecord", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AppUsageRecordSortKeys", "description": "The set of valid sort keys for the AppUsageRecord query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Attribute", "description": "Represents a generic custom attribute.", "fields": [ { "name": "key", "description": "Key or name of the attribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Value of the attribute.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AttributeInput", "description": "The input fields for an attribute.", "fields": null, "inputFields": [ { "name": "key", "description": "Key or name of the attribute.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "Value of the attribute.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AutomaticDiscountApplication", "description": "Automatic discount applications capture the intentions of a discount that was automatically applied.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "index", "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "AutomaticDiscountSortKeys", "description": "The set of valid sort keys for the AutomaticDiscount query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "AvailableChannelDefinitionsByChannel", "description": "Represents an object containing all information for channels available to a shop.\n", "fields": [ { "name": "channelDefinitions", "description": "The channel definitions for channels installed on a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelDefinition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelName", "description": "The name of the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BadgeType", "description": "The possible types for a badge.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "This badge has type `default`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUCCESS", "description": "This badge has type `success`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ATTENTION", "description": "This badge has type `attention`.", "isDeprecated": false, "deprecationReason": null }, { "name": "WARNING", "description": "This badge has type `warning`.", "isDeprecated": false, "deprecationReason": null }, { "name": "INFO", "description": "This badge has type `info`.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "BalanceTransactionSortKeys", "description": "The set of valid sort keys for the BalanceTransaction query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYOUT_DATE", "description": "Sort by the `payout_date` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYOUT_STATUS", "description": "Sort by the `payout_status` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSED_AT", "description": "Sort by the `processed_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMOUNT", "description": "Sort by the `amount` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "FEE", "description": "Sort by the `fee` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NET", "description": "Sort by the `net` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSACTION_TYPE", "description": "Sort by the `transaction_type` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_NAME", "description": "Sort by the `order_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_METHOD_NAME", "description": "Sort by the `payment_method_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "BasePaymentDetails", "description": "Generic payment details that are related to a transaction.", "fields": [ { "name": "paymentMethodName", "description": "The name of payment method used by the buyer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CardPaymentDetails", "ofType": null }, { "kind": "OBJECT", "name": "ShopPayInstallmentsPaymentDetails", "ofType": null } ] }, { "kind": "OBJECT", "name": "BasicEvent", "description": "Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or\nthe addition of a product.\n", "fields": [ { "name": "appTitle", "description": "The name of the app that created the event.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToApp", "description": "Whether the event was created by an app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToUser", "description": "Whether the event was caused by an admin user.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the event was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "criticalAlert", "description": "Whether the event is critical.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Human readable text that describes the event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Event", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BillingAttemptUserError", "description": "Represents an error that happens during the execution of a billing attempt mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "BillingAttemptUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BillingAttemptUserErrorCode", "description": "Possible error codes that can be returned by `BillingAttemptUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTRACT_NOT_FOUND", "description": "Subscription contract does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORIGIN_TIME_BEFORE_CONTRACT_CREATION", "description": "Origin time cannot be before the contract creation time.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_INDEX_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of index range.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_START_DATE_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of start date range.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORIGIN_TIME_OUT_OF_RANGE", "description": "Origin time needs to be within the selected billing cycle's start and end at date.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTRACT_UNDER_REVIEW", "description": "Subscription contract is under review.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTRACT_TERMINATED", "description": "Subscription contract cannot be billed once terminated.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "SCALAR", "name": "Boolean", "description": "Represents `true` or `false` values.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BulkMutationErrorCode", "description": "Possible error codes that can be returned by `BulkMutationUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OPERATION_IN_PROGRESS", "description": "The operation did not run because another bulk mutation is already running. [Wait for the operation to finish](https://shopify.dev/api/usage/bulk-operations/imports#wait-for-the-operation-to-finish) before retrying this operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MUTATION", "description": "The operation did not run because the mutation is invalid. Check your mutation syntax and try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_STAGED_UPLOAD_FILE", "description": "The JSONL file submitted via the `stagedUploadsCreate` mutation is invalid. Update the file and try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_SUCH_FILE", "description": "The JSONL file could not be found. Try [uploading the file](https://shopify.dev/api/usage/bulk-operations/imports#generate-the-uploaded-url-and-parameters) again, and check that you've entered the URL correctly for the `stagedUploadPath` mutation argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_FILE_SERVER_ERROR", "description": "There was a problem reading the JSONL file. This error might be intermittent, so you can try performing the same query again.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkMutationUserError", "description": "Represents an error that happens during execution of a bulk mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "BulkMutationErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkOperation", "description": "An asynchronous long-running operation to fetch data in bulk or to bulk import data.\n\nBulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After\nthey are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains\na link to the data in [JSONL](http://jsonlines.org/) format.\n\nRefer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.\n", "fields": [ { "name": "completedAt", "description": "When the bulk operation was successfully completed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "When the bulk operation was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorCode", "description": "Error code for failed operations.", "args": [], "type": { "kind": "ENUM", "name": "BulkOperationErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileSize", "description": "File size in bytes of the file in the `url` field.", "args": [], "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "objectCount", "description": "A running count of all the objects processed.\nFor example, when fetching all the products and their variants, this field counts both products and variants.\nThis field can be used to track operation progress.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "partialDataUrl", "description": "The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation.\nThe URL expires 7 days after the operation fails. Returns `null` when there's no data available.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "query", "description": "GraphQL query document specified in `bulkOperationRunQuery`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rootObjectCount", "description": "A running count of all the objects that are processed at the root of the query.\nFor example, when fetching all the products and their variants, this field only counts products.\nThis field can be used to track operation progress.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Status of the bulk operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "BulkOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The bulk operation's type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "BulkOperationType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL that points to the response data in [JSONL](http://jsonlines.org/) format.\nThe URL expires 7 days after the operation completes.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkOperationCancelPayload", "description": "Return type for `bulkOperationCancel` mutation.", "fields": [ { "name": "bulkOperation", "description": "The bulk operation to be canceled.", "args": [], "type": { "kind": "OBJECT", "name": "BulkOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BulkOperationErrorCode", "description": "Error codes for failed bulk operations.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACCESS_DENIED", "description": "The provided operation `query` returned access denied due to missing\n[access scopes](https://shopify.dev/api/usage/access-scopes).\nReview the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_SERVER_ERROR", "description": "The operation resulted in partial or incomplete data due to internal server errors during execution.\nThese errors might be intermittent, so you can try performing the same query again.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "TIMEOUT", "description": "The operation resulted in partial or incomplete data due to query timeouts during execution.\nIn some cases, timeouts can be avoided by modifying your `query` to select fewer fields.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkOperationRunMutationPayload", "description": "Return type for `bulkOperationRunMutation` mutation.", "fields": [ { "name": "bulkOperation", "description": "The newly created bulk operation.", "args": [], "type": { "kind": "OBJECT", "name": "BulkOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BulkMutationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkOperationRunQueryPayload", "description": "Return type for `bulkOperationRunQuery` mutation.", "fields": [ { "name": "bulkOperation", "description": "The newly created bulk operation.", "args": [], "type": { "kind": "OBJECT", "name": "BulkOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BulkOperationStatus", "description": "The valid values for the status of a bulk operation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANCELED", "description": "The bulk operation has been canceled.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELING", "description": "Cancelation has been initiated on the bulk operation. There may be a short delay from when a cancelation\nstarts until the operation is actually canceled.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPLETED", "description": "The bulk operation has successfully completed.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED", "description": "The bulk operation has been created.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The bulk operation URL has expired.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "The bulk operation has failed. For information on why the operation failed, use\n[BulkOperation.errorCode](https://shopify.dev/api/admin-graphql/latest/enums/bulkoperationerrorcode).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "RUNNING", "description": "The bulk operation is runnning.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "BulkOperationType", "description": "The valid values for the bulk operation's type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "QUERY", "description": "The bulk operation is a query.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUTATION", "description": "The bulk operation is a mutation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkProductResourceFeedbackCreatePayload", "description": "Return type for `bulkProductResourceFeedbackCreate` mutation.", "fields": [ { "name": "feedback", "description": "The feedback that's created.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductResourceFeedback", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BulkProductResourceFeedbackCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BulkProductResourceFeedbackCreateUserError", "description": "An error that occurs during the execution of `BulkProductResourceFeedbackCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "BulkProductResourceFeedbackCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BulkProductResourceFeedbackCreateUserErrorCode", "description": "Possible error codes that can be returned by `BulkProductResourceFeedbackCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MAXIMUM_FEEDBACK_LIMIT_EXCEEDED", "description": "The operation was attempted on too many feedback objects. The maximum number of feedback objects that you can operate on is 50.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUTDATED_FEEDBACK", "description": "The feedback for a later version of this resource was already accepted.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_NOT_FOUND", "description": "The product wasn't found or isn't available to the channel.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BundlesFeature", "description": "Represents the Bundles feature configuration for the shop.\n", "fields": [ { "name": "eligibleForBundles", "description": "Whether a shop is configured properly to sell bundles.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ineligibilityReason", "description": "The reason why a shop is not eligible for bundles.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellsBundles", "description": "Whether a shop has any fixed bundle products or has a cartTransform function installed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "BusinessCustomerErrorCode", "description": "Possible error codes that can be returned by `BusinessCustomerUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_NOT_FOUND", "description": "The resource wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_DELETE", "description": "Deleting the resource failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRED", "description": "Missing a required field.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_INPUT", "description": "The input is empty.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INPUT", "description": "The input is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNEXPECTED_TYPE", "description": "Unexpected type.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The field value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIMIT_REACHED", "description": "The number of resources exceeded the limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BusinessCustomerUserError", "description": "An error that happens during the execution of a business customer mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "BusinessCustomerErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BuyerExperienceConfiguration", "description": "Settings describing the behavior of checkout for a B2B buyer.", "fields": [ { "name": "checkoutToDraft", "description": "Whether to checkout to draft order for merchant review.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editableShippingAddress", "description": "Whether to allow customers to use editable shipping addresses.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "payNowOnly", "description": "Whether a buyer must pay at checkout or they can also choose to pay\nlater using net terms.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsTemplate", "description": "Represents the merchant configured payment terms.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentTermsTemplate", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BuyerExperienceConfigurationInput", "description": "The input fields specifying the behavior of checkout for a B2B buyer.", "fields": null, "inputFields": [ { "name": "checkoutToDraft", "description": "Whether to checkout to draft order for merchant review.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "paymentTermsTemplateId", "description": "Represents the merchant configured payment terms.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "editableShippingAddress", "description": "Whether to allow customers to edit their shipping address at checkout.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedAutomaticDiscountApplication", "description": "A discount that is automatically applied to an order that is being edited.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliedTo", "description": "The level at which the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of discount application. Indicates the reason why the discount was applied.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedDiscountAllocation", "description": "An amount discounting the line that has been allocated by an associated discount application.\n", "fields": [ { "name": "allocatedAmountSet", "description": "The money amount that's allocated by the discount application in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountApplication", "description": "The discount that the allocated amount originated from.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "description": "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.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliedTo", "description": "The level at which the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of discount application. Indicates the reason why the discount was applied.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CalculatedAutomaticDiscountApplication", "ofType": null }, { "kind": "OBJECT", "name": "CalculatedDiscountCodeApplication", "ofType": null }, { "kind": "OBJECT", "name": "CalculatedManualDiscountApplication", "ofType": null }, { "kind": "OBJECT", "name": "CalculatedScriptDiscountApplication", "ofType": null } ] }, { "kind": "OBJECT", "name": "CalculatedDiscountApplicationConnection", "description": "An auto-generated type for paginating through multiple CalculatedDiscountApplications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedDiscountApplicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CalculatedDiscountApplicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedDiscountApplicationEdge", "description": "An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CalculatedDiscountApplicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedDiscountCodeApplication", "description": "A discount code that is applied to an order that is being edited.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliedTo", "description": "The level at which the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "The string identifying the discount code that was used at the time of application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of discount application. Indicates the reason why the discount was applied.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedDraftOrder", "description": "The computed properties for a draft order.", "fields": [ { "name": "appliedDiscount", "description": "Order-level discount applied to the draft order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrderAppliedDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "availableShippingRates", "description": "The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingRate", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddressMatchesShippingAddress", "description": "Whether the billing address matches the shipping address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The currency of the store for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "Customer who will be sent an invoice for the draft order, if there's one.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "Line items in the draft order with their computed properties.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedDraftOrderLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItemsSubtotalPrice", "description": "A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketName", "description": "The name of the selected market.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketRegionCountryCode", "description": "The selected country code that determines the pricing of the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "Phone number assigned to draft order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentCurrencyCode", "description": "The payment currency of the customer for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "purchasingEntity", "description": "The purchasing entity for the draft order.", "args": [], "type": { "kind": "UNION", "name": "PurchasingEntity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLine", "description": "Line item that contains the shipping costs.", "args": [], "type": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPrice", "description": "Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPriceSet", "description": "Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "Total amount of taxes charged for each line item and shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountsSet", "description": "Total discounts for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalLineItemsPriceSet", "description": "Total price of line items for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPrice", "description": "Total amount of the draft order (includes taxes, shipping charges, and discounts).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "Total amount of the draft order(includes taxes, shipping charges, and discounts).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalShippingPrice", "description": "Total shipping charge for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalShippingPriceSet", "description": "Total shipping charge for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTax", "description": "Total amount of taxes for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxSet", "description": "Total amount of taxes for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedDraftOrderLineItem", "description": "The computed line items for a draft order.", "fields": [ { "name": "appliedDiscount", "description": "The discount applied to the line item.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrderAppliedDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "custom", "description": "Whether the line item is a custom line item (`true`) or a product variant line item (`false`).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributesV2", "description": "Additional information (metafields) about the line item with the associated types.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TypedAttribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotal", "description": "Total price with discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotalSet", "description": "The total price with discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPrice", "description": "The unit price with discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceSet", "description": "Unit price with discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated with the draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the line item represents the purchase of a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotal", "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalSet", "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPrice", "description": "The variant price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "The variant price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product associated with the draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of variant items requested in the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The SKU number of the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product or variant. This field only applies to custom line items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscount", "description": "The total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountSet", "description": "The total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The variant associated with the draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The name of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who created the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The weight unit and value for a draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "Weight", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedLineItem", "description": "A line item involved in order editing that may be newly added or have new changes applied.\n", "fields": [ { "name": "calculatedDiscountAllocations", "description": "The discounts that have been allocated onto the line item by discount applications.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedDiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "The discounts that have been allocated onto the line item by discount applications.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAllocation", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `calculatedDiscountAllocations` instead." }, { "name": "discountedUnitPriceSet", "description": "The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editableQuantity", "description": "The total number of items that can be edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editableQuantityBeforeChanges", "description": "The editable quantity prior to any changes made in the current edit.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editableSubtotalSet", "description": "The total price of editable lines in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasStagedLineItemDiscount", "description": "Whether the calculated line item has a staged discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image object associated to the line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "The variant unit price in shop and presentment currencies, without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The total number of items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockable", "description": "Whether the line item can be restocked or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restocking", "description": "Whether the changes on the line item will result in a restock.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The variant SKU number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "stagedChanges", "description": "A list of changes that affect this line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "OrderStagedChange", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uneditableSubtotalSet", "description": "The total price of uneditable lines in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant associated with this line item. The value is null for custom line items and items where\nthe variant has been deleted.\n", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The title of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedLineItemConnection", "description": "An auto-generated type for paginating through multiple CalculatedLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CalculatedLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedLineItemEdge", "description": "An auto-generated type which holds one CalculatedLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CalculatedLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedManualDiscountApplication", "description": "Represents a discount that was manually created for an order that is being edited.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliedTo", "description": "The level at which the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of discount application. Indicates the reason why the discount was applied.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedOrder", "description": "An order with edits applied but not saved.\n", "fields": [ { "name": "addedDiscountApplications", "description": "Returns only the new discount applications being added to the order in the current edit.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedDiscountApplicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "addedLineItems", "description": "Returns only the new line items being added to the order during the current edit.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartDiscountAmountSet", "description": "Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "committed", "description": "Whether the changes have been applied and saved to the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "Returns all items on the order that existed before starting the edit.\nWill include any changes that have been made.\nWill not include line items added during the current edit.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| editable |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "notificationPreviewHtml", "description": "The HTML of the customer notification for the order edit.", "args": [], "type": { "kind": "SCALAR", "name": "HTML", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "notificationPreviewTitle", "description": "The customer notification title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order without any changes applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalOrder` instead." }, { "name": "originalOrder", "description": "The order without any changes applied.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLines", "description": "Returns the shipping lines on the order that existed before starting the edit.\nWill include any changes that have been made as well as shipping lines added during the current edit.\nReturns only the first 250 shipping lines.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CalculatedShippingLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stagedChanges", "description": "List of changes made to the order during the current edit.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderStagedChangeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalLineItemsQuantity", "description": "The sum of the quantities for the line items that contribute to the order's subtotal.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPriceSet", "description": "The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal doesn't include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "Taxes charged for the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalOutstandingSet", "description": "Total price of the order less the total amount received from the customer in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "Total amount of the order (includes taxes and discounts) in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedScriptDiscountApplication", "description": "A discount created by a Shopify script for an order that is being edited.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliedTo", "description": "The level at which the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of discount application. Indicates the reason why the discount was applied.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CalculatedDiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CalculatedShippingLine", "description": "A shipping line item involved in order editing that may be newly added or have new changes applied.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stagedStatus", "description": "The staged status of the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CalculatedShippingLineStagedStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CalculatedShippingLineStagedStatus", "description": "Represents the staged status of a CalculatedShippingLine on a CalculatedOrder.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The shipping line has no staged changes associated with it.", "isDeprecated": false, "deprecationReason": null }, { "name": "ADDED", "description": "The shipping line was added as part of the current order edit.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMOVED", "description": "The shipping line was removed as part of the current order edit.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CardPaymentDetails", "description": "Card payment details related to a transaction.", "fields": [ { "name": "avsResultCode", "description": "The response code from the address verification system (AVS). The code is always a single letter.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bin", "description": "The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The name of the company that issued the customer's credit card.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cvvResultCode", "description": "The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expirationMonth", "description": "The month in which the used credit card expires.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expirationYear", "description": "The year in which the used credit card expires.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The holder of the credit card.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The customer's credit card number, with most of the leading digits redacted.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentMethodName", "description": "The name of payment method used by the buyer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "wallet", "description": "Digital wallet used for the payment.", "args": [], "type": { "kind": "ENUM", "name": "DigitalWallet", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "BasePaymentDetails", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransform", "description": "A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle).\n", "fields": [ { "name": "blockOnFailure", "description": "Whether a run failure will block cart and checkout operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "functionId", "description": "The ID for the Cart Transform function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformConnection", "description": "An auto-generated type for paginating through multiple CartTransforms.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CartTransformEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransform", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformCreatePayload", "description": "Return type for `cartTransformCreate` mutation.", "fields": [ { "name": "cartTransform", "description": "The newly created cart transform function.", "args": [], "type": { "kind": "OBJECT", "name": "CartTransform", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformCreateUserError", "description": "An error that occurs during the execution of `CartTransformCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CartTransformCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CartTransformCreateUserErrorCode", "description": "Possible error codes that can be returned by `CartTransformCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INPUT_INVALID", "description": "Failed to create cart transform due to invalid input.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "No Shopify Function found for provided function_id.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_ALREADY_REGISTERED", "description": "A cart transform function already exists for the provided function_id.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_DOES_NOT_IMPLEMENT", "description": "Function does not implement the required interface for this cart_transform function.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformDeletePayload", "description": "Return type for `cartTransformDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The globally-unique ID for the deleted cart transform.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformDeleteUserError", "description": "An error that occurs during the execution of `CartTransformDelete`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CartTransformDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CartTransformDeleteUserErrorCode", "description": "Possible error codes that can be returned by `CartTransformDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "Could not find cart transform for provided id.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNAUTHORIZED_APP_SCOPE", "description": "Unauthorized app scope.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformEdge", "description": "An auto-generated type which holds one CartTransform and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CartTransformEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransform", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformEligibleOperations", "description": "Represents the cart transform feature configuration for the shop.\n", "fields": [ { "name": "expandOperation", "description": "The shop is eligible for expand operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mergeOperation", "description": "The shop is eligible for merge operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateOperation", "description": "The shop is eligible for update operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTransformFeature", "description": "Represents the cart transform feature configuration for the shop.\n", "fields": [ { "name": "eligibleOperations", "description": "The cart transform operations eligible for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformEligibleOperations", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingAdjustment", "description": "Tracks an adjustment to the cash in a cash tracking session for a point of sale device over the course of a shift.", "fields": [ { "name": "cash", "description": "The amount of cash being added or removed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note entered when the adjustment was made.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The staff member who made the adjustment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMember", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "time", "description": "The time when the adjustment was made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingAdjustmentConnection", "description": "An auto-generated type for paginating through multiple CashTrackingAdjustments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingAdjustmentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CashTrackingAdjustmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingAdjustment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingAdjustmentEdge", "description": "An auto-generated type which holds one CashTrackingAdjustment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CashTrackingAdjustmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingAdjustment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingSession", "description": "Tracks the balance in a cash drawer for a point of sale device over the course of a shift.", "fields": [ { "name": "adjustments", "description": "The adjustments made to the cash drawer during this session.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AdjustmentsSortKeys", "ofType": null }, "defaultValue": "TIME" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingAdjustmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cashTrackingEnabled", "description": "Whether this session is tracking cash payments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "closingBalance", "description": "The counted cash balance when the session was closed.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "closingNote", "description": "The note entered when the session was closed.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "closingStaffMember", "description": "The user who closed the session.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "closingTime", "description": "When the session was closed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expectedBalance", "description": "The expected balance at the end of the session or the expected current balance for sessions that are still open.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expectedClosingBalance", "description": "The amount that was expected to be in the cash drawer at the end of the session, calculated after the session was closed.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expectedOpeningBalance", "description": "The amount expected to be in the cash drawer based on the previous session.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location of the point of sale device during this session.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "netCashSales", "description": "The net cash sales made for the duration of this cash tracking session.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "openingBalance", "description": "The counted cash balance when the session was opened.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "openingNote", "description": "The note entered when the session was opened.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "openingStaffMember", "description": "The user who opened the session.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "openingTime", "description": "When the session was opened.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "registerName", "description": "The register name for the point of sale device that this session is tracking cash for.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAdjustments", "description": "The sum of all adjustments made during the session, excluding the final adjustment.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCashRefunds", "description": "The sum of all cash refunds for the duration of this cash tracking session.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCashSales", "description": "The sum of all cash sales for the duration of this cash tracking session.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscrepancy", "description": "The total discrepancy for the session including starting and ending.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingSessionConnection", "description": "An auto-generated type for paginating through multiple CashTrackingSessions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingSessionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CashTrackingSessionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingSession", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CashTrackingSessionEdge", "description": "An auto-generated type which holds one CashTrackingSession and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CashTrackingSessionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingSession", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CashTrackingSessionsSortKeys", "description": "The set of valid sort keys for the CashTrackingSessions query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OPENING_TIME_DESC", "description": "Sort by the `opening_time_desc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPENING_TIME_ASC", "description": "Sort by the `opening_time_asc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSING_TIME_DESC", "description": "Sort by the `closing_time_desc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSING_TIME_ASC", "description": "Sort by the `closing_time_asc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_DISCREPANCY_DESC", "description": "Sort by the `total_discrepancy_desc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_DISCREPANCY_ASC", "description": "Sort by the `total_discrepancy_asc` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "Catalog", "description": "A list of products with publishing and pricing information.\nA 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).\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "operations", "description": "Most recent catalog operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list associated with the catalog.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "A group of products and collections that's published to a catalog.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppCatalog", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocationCatalog", "ofType": null }, { "kind": "OBJECT", "name": "MarketCatalog", "ofType": null } ] }, { "kind": "OBJECT", "name": "CatalogConnection", "description": "An auto-generated type for paginating through multiple Catalogs.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CatalogEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Catalog", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CatalogContextInput", "description": "The input fields for the context in which the catalog's publishing and pricing rules apply.", "fields": null, "inputFields": [ { "name": "companyLocationIds", "description": "The IDs of the company locations to associate to the catalog.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogContextUpdatePayload", "description": "Return type for `catalogContextUpdate` mutation.", "fields": [ { "name": "catalog", "description": "The updated catalog.", "args": [], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CatalogCreateInput", "description": "The input fields required to create a catalog.", "fields": null, "inputFields": [ { "name": "title", "description": "The name of the catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "status", "description": "The status of the catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null } }, "defaultValue": null }, { "name": "context", "description": "The context associated with the catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CatalogContextInput", "ofType": null } }, "defaultValue": null }, { "name": "priceListId", "description": "The ID of the price list to associate to the catalog.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "publicationId", "description": "The ID of the publication to associate to the catalog.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogCreatePayload", "description": "Return type for `catalogCreate` mutation.", "fields": [ { "name": "catalog", "description": "The newly created catalog.", "args": [], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogCsvOperation", "description": "A catalog csv operation represents a CSV file import.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "processedRowCount", "description": "The count of processed rows, summing imported, failed, and skipped rows.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rowCount", "description": "Represents a rows objects within this background operation.", "args": [], "type": { "kind": "OBJECT", "name": "RowCount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogDeletePayload", "description": "Return type for `catalogDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted catalog.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogEdge", "description": "An auto-generated type which holds one Catalog and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CatalogEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Catalog", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CatalogSortKeys", "description": "The set of valid sort keys for the Catalog query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CatalogStatus", "description": "The state of a catalog.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The catalog is active.", "isDeprecated": false, "deprecationReason": null }, { "name": "ARCHIVED", "description": "The catalog is archived.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT", "description": "The catalog is in draft.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CatalogType", "description": "The associated catalog's type.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "Not associated to a catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP", "description": "Catalogs belonging to apps.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATION", "description": "Catalogs belonging to company locations.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET", "description": "Catalogs belonging to markets.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CatalogUpdateInput", "description": "The input fields used to update a catalog.", "fields": null, "inputFields": [ { "name": "title", "description": "The name of the catalog.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The status of the catalog.", "type": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null }, "defaultValue": null }, { "name": "context", "description": "The context associated with the catalog.", "type": { "kind": "INPUT_OBJECT", "name": "CatalogContextInput", "ofType": null }, "defaultValue": null }, { "name": "priceListId", "description": "The ID of the price list to associate to the catalog.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "publicationId", "description": "The ID of the publication to associate to the catalog.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogUpdatePayload", "description": "Return type for `catalogUpdate` mutation.", "fields": [ { "name": "catalog", "description": "The updated catalog.", "args": [], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CatalogUserError", "description": "Defines errors encountered while managing a catalog.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CatalogUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CatalogUserErrorCode", "description": "Possible error codes that can be returned by `CatalogUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APP_CATALOG_PRICE_LIST_ASSIGNMENT", "description": "An app catalog cannot be assigned to a price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_FAILED_TO_SAVE", "description": "Catalog failed to save.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_NOT_FOUND", "description": "The catalog wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET", "description": "A price list cannot be assigned to the primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", "description": "Quantity rules can be associated only with company location catalogs.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_PRICE_BREAKS", "description": "Quantity price breaks can be associated only with company location catalogs.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_ADD_MORE_THAN_ONE_MARKET", "description": "The catalog can't be associated with more than one market.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATION_CATALOG_STATUS_PLAN", "description": "A company location catalog outside of a supported plan can only have an archived status.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_ALREADY_ASSIGNED_TO_CATALOG", "description": "Context driver already assigned to this catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_CATALOG_LIMIT_REACHED", "description": "Cannot save the catalog because the catalog limit for the context was reached.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATION_NOT_FOUND", "description": "The company location could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_DRIVER_MISMATCH", "description": "The arguments `contextsToAdd` and `contextsToRemove` must match existing catalog context type.", "isDeprecated": false, "deprecationReason": null }, { "name": "COUNTRY_PRICE_LIST_ASSIGNMENT", "description": "A country price list cannot be assigned to a catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CATALOG_CONTEXT_TYPE", "description": "The catalog context type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_CATALOG_STATUS", "description": "A market catalog must have an active status.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_NOT_FOUND", "description": "Market not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH", "description": "The catalog's market and price list currencies do not match.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_TAKEN", "description": "Market already belongs to another catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUST_PROVIDE_EXACTLY_ONE_CONTEXT_TYPE", "description": "Must provide exactly one context type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_FAILED_TO_SAVE", "description": "Price list failed to save.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_FOUND", "description": "Price list not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_LOCKED", "description": "The price list is currently being modified. Please try again later.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLICATION_NOT_FOUND", "description": "Publication not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRES_CONTEXTS_TO_ADD_OR_REMOVE", "description": "Must have `contexts_to_add` or `contexts_to_remove` argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_CATALOG_ACTION", "description": "Can't perform this action on a catalog of this type.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_CREATE_APP_CATALOG", "description": "Cannot create a catalog for an app.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_APP_CATALOG", "description": "Cannot modify a catalog for an app.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_APP_CATALOG", "description": "Cannot delete a catalog for an app.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_CREATE_MARKET_CATALOG", "description": "Cannot create a catalog for a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_MARKET_CATALOG", "description": "Cannot modify a catalog for a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_MARKET_CATALOG", "description": "Cannot delete a catalog for a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Channel", "description": "A channel represents an app where you sell a group of products and collections.\nA channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.\n", "fields": [ { "name": "app", "description": "The underlying app used by the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionPublicationsV3", "description": "The collection publications for the list of collections published to the channel.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collections", "description": "The list of collections published to the channel.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "The unique identifier for the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `id` instead." }, { "name": "hasCollection", "description": "Whether the collection is available to the channel.", "args": [ { "name": "id", "description": "The collection ID to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "navigationItems", "description": "The menu items for the channel, which also appear as submenu items in the left navigation sidebar in the Shopify admin.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "NavigationItem", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use [AppInstallation.navigationItems](\n https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-navigationitems) instead." }, { "name": "overviewPath", "description": "Home page for the channel.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use [AppInstallation.launchUrl](\n https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-launchurl) instead." }, { "name": "productPublications", "description": "The product publications for the products published to the channel.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublicationConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `productPublicationsV3` instead." }, { "name": "productPublicationsV3", "description": "The product publications for the list of products published to the channel.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The list of products published to the channel.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsCount", "description": "The count of products published to the channel. Limited to a maximum of 10000.", "args": [ { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| bundles |\n| created_at |\n| delivery_profile_id |\n| error_feedback |\n| gift_card |\n| has_only_composites |\n| has_only_default_variant |\n| has_variant_with_components |\n| id |\n| inventory_total |\n| is_price_reduced |\n| out_of_stock_somewhere |\n| price |\n| product_configuration_owner |\n| product_publication_status |\n| product_type |\n| publishable_status |\n| published_status |\n| sku |\n| status |\n| tag |\n| tag_not |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "supportsFuturePublishing", "description": "Whether the channel supports future publishing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ChannelConnection", "description": "An auto-generated type for paginating through multiple Channels.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ChannelEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Channel", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ChannelDefinition", "description": "A channel definition represents channels surfaces on the platform.\nA channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat.\n", "fields": [ { "name": "channelName", "description": "Name of the channel that this sub channel belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "Unique string used as a public identifier for the channel definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the channel definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isMarketplace", "description": "Whether this channel definition represents a marketplace.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subChannelName", "description": "Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "svgIcon", "description": "Icon displayed when showing the channel in admin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ChannelEdge", "description": "An auto-generated type which holds one Channel and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ChannelEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Channel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ChannelInformation", "description": "Contains the information for a given sales channel.\n", "fields": [ { "name": "app", "description": "The app associated with the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelDefinition", "description": "The channel definition associated with the channel.", "args": [], "type": { "kind": "OBJECT", "name": "ChannelDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelId", "description": "The unique ID for the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBranding", "description": "The settings of checkout visual customizations.\n\nTo learn more about updating checkout branding settings, refer to the\n[checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert) mutation.\n", "fields": [ { "name": "customizations", "description": "The customizations that apply to specific components or areas of the user interface.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingCustomizations", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "designSystem", "description": "The design system allows you to set values that represent specific attributes\nof your brand like color and font. These attributes are used throughout the user\ninterface. This brings consistency and allows you to easily make broad design changes.\n", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingDesignSystem", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingBackground", "description": "The container background style.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BASE", "description": "The Base background style.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBDUED", "description": "The Subdued background style.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSPARENT", "description": "The Transparent background style.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingBackgroundStyle", "description": "Possible values for the background style.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SOLID", "description": "The Solid background style.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "The None background style.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingBorder", "description": "Possible values for the border.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The None border.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLOCK_END", "description": "The Block End border.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULL", "description": "The Full border.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingBorderStyle", "description": "The container border style.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BASE", "description": "The Base border style.", "isDeprecated": false, "deprecationReason": null }, { "name": "DASHED", "description": "The Dashed border style.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOTTED", "description": "The Dotted border style.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingBorderWidth", "description": "The container border width.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BASE", "description": "The Base border width.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_100", "description": "The Large 100 border width.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_200", "description": "The Large 200 border width.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingButton", "description": "The buttons customizations.", "fields": [ { "name": "background", "description": "The background style used for buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBackgroundStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "blockPadding", "description": "The block padding used for buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacing", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The border used for buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius used for buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inlinePadding", "description": "The inline padding used for buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacing", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "typography", "description": "The typography used for buttons.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingButtonColorRoles", "description": "Colors for buttons.", "fields": [ { "name": "accent", "description": "The color of accented objects (links and focused state).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "background", "description": "The color of the background.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The color of borders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hover", "description": "The colors of the button on hover.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "The color of icons.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "text", "description": "The color of text.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonColorRolesInput", "description": "The input fields to set colors for buttons.", "fields": null, "inputFields": [ { "name": "background", "description": "The color of the background.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "text", "description": "The color of text.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The color of borders.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "icon", "description": "The color of icons.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "accent", "description": "The color of accented objects (links and focused state).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "hover", "description": "The colors of the button on hover.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorRolesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonInput", "description": "The input fields used to update the buttons customizations.", "fields": null, "inputFields": [ { "name": "background", "description": "The background style used for buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBackgroundStyle", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The border used for buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius used for buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null }, { "name": "blockPadding", "description": "The block padding used for buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacing", "ofType": null }, "defaultValue": null }, { "name": "inlinePadding", "description": "The inline padding used for buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacing", "ofType": null }, "defaultValue": null }, { "name": "typography", "description": "The typography style used for buttons.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingBuyerJourney", "description": "The customizations for the breadcrumbs that represent a buyer's journey to the checkout.", "fields": [ { "name": "visibility", "description": "An option to display or hide the breadcrumbs that represent the buyer's journey on 3-page checkout.\n", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingBuyerJourneyInput", "description": "The input fields for updating breadcrumb customizations, which represent the buyer's journey to checkout.\n", "fields": null, "inputFields": [ { "name": "visibility", "description": "The visibility customizations for updating breadcrumbs, which represent the buyer's journey to checkout.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingCartLink", "description": "The customizations that you can make to cart links at checkout.", "fields": [ { "name": "visibility", "description": "Whether the cart link is visible at checkout.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingCartLinkContentType", "description": "Possible values for the cart link content type for the header.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ICON", "description": "The checkout header content type icon value.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE", "description": "The checkout header content type image value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TEXT", "description": "The checkout header content type text value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCartLinkInput", "description": "The input fields for updating the cart link customizations at checkout.", "fields": null, "inputFields": [ { "name": "visibility", "description": "The input to update the visibility of cart links in checkout. This hides the cart icon on one-page and the cart link in the breadcrumbs/buyer journey on three-page checkout.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingCheckbox", "description": "The checkboxes customizations.", "fields": [ { "name": "cornerRadius", "description": "The corner radius used for checkboxes.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCheckboxInput", "description": "The input fields used to update the checkboxes customizations.", "fields": null, "inputFields": [ { "name": "cornerRadius", "description": "The corner radius used for checkboxes.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingChoiceList", "description": "The choice list customizations.", "fields": [ { "name": "group", "description": "The settings that apply to the 'group' variant of ChoiceList.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingChoiceListGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingChoiceListGroup", "description": "The settings that apply to the 'group' variant of ChoiceList.", "fields": [ { "name": "spacing", "description": "The spacing between UI elements in the list.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingChoiceListGroupInput", "description": "The input fields to update the settings that apply to the 'group' variant of ChoiceList.", "fields": null, "inputFields": [ { "name": "spacing", "description": "The spacing between UI elements in the list.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingChoiceListInput", "description": "The input fields to use to update the choice list customizations.", "fields": null, "inputFields": [ { "name": "group", "description": "The settings that apply to the 'group' variant of ChoiceList.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingChoiceListGroupInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingColorGlobal", "description": "A set of colors for customizing the overall look and feel of the checkout.", "fields": [ { "name": "accent", "description": "A color used for interaction, like links and focus states.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "brand", "description": "A color strongly associated with the merchant, currently used for elements\nlike primary and secondary buttons.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "critical", "description": "A semantic color used for components that communicate critical content.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "decorative", "description": "A color used to highlight certain areas of the user interface.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "info", "description": "A semantic color used for components that communicate informative content.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "success", "description": "A semantic color used for components that communicate successful actions.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "warning", "description": "A semantic color used for components that display content that requires attention.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorGlobalInput", "description": "The input fields to customize the overall look and feel of the checkout.", "fields": null, "inputFields": [ { "name": "info", "description": "A semantic color used for components that communicate informative content.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "success", "description": "A semantic color used for components that communicate successful actions.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "warning", "description": "A semantic color used for components that display content that requires attention.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "critical", "description": "A semantic color used for components that communicate critical content.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "brand", "description": "A color strongly associated with the merchant, currently used for elements\nlike primary and secondary buttons.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "accent", "description": "A color used for interaction, like links and focus states.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "decorative", "description": "A color used to highlight certain areas of the user interface.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingColorRoles", "description": "A group of colors used together on a surface.", "fields": [ { "name": "accent", "description": "The color of accented objects (links and focused state).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "background", "description": "The color of the background.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The color of borders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "The color of icons.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "text", "description": "The color of text.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorRolesInput", "description": "The input fields for a group of colors used together on a surface.", "fields": null, "inputFields": [ { "name": "background", "description": "The color of the background.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "text", "description": "The color of text.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The color of borders.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "icon", "description": "The color of icons.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "accent", "description": "The color of accented objects (links and focused state).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingColorScheme", "description": "A base set of color customizations that is applied to an area of Checkout, from which every component\npulls its colors from.\n", "fields": [ { "name": "base", "description": "The main colors of a scheme.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "control", "description": "The colors of form controls.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingControlColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "primaryButton", "description": "The colors of the primary button.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingButtonColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secondaryButton", "description": "The colors of the secondary button.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingButtonColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemeInput", "description": "The input fields for a base set of color customizations that is applied to an area of Checkout, from which\nevery component pulls its colors from.\n", "fields": null, "inputFields": [ { "name": "base", "description": "The main colors of a scheme.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorRolesInput", "ofType": null }, "defaultValue": null }, { "name": "control", "description": "The colors of form controls.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingControlColorRolesInput", "ofType": null }, "defaultValue": null }, { "name": "primaryButton", "description": "The colors of the primary button.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonColorRolesInput", "ofType": null }, "defaultValue": null }, { "name": "secondaryButton", "description": "The colors of the secondary button.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonColorRolesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "description": "The possible color schemes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TRANSPARENT", "description": "The TRANSPARENT color scheme selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLOR_SCHEME1", "description": "The COLOR_SCHEME1 color scheme selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLOR_SCHEME2", "description": "The COLOR_SCHEME2 color scheme selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLOR_SCHEME3", "description": "The COLOR_SCHEME3 color scheme selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLOR_SCHEME4", "description": "The COLOR_SCHEME4 color scheme selection.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingColorSchemes", "description": "The color schemes.", "fields": [ { "name": "scheme1", "description": "The primary scheme. By default, it’s used for the main area of the interface.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorScheme", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scheme2", "description": "The secondary scheme. By default, it’s used for secondary areas, like Checkout’s Order Summary.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorScheme", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scheme3", "description": "An extra scheme available to customize more surfaces, components or specific states of the user interface.\n", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorScheme", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scheme4", "description": "An extra scheme available to customize more surfaces, components or specific states of the user interface.\n", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorScheme", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemesInput", "description": "The input fields for the color schemes.", "fields": null, "inputFields": [ { "name": "scheme1", "description": "The primary scheme. By default, it’s used for the main area of the interface.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemeInput", "ofType": null }, "defaultValue": null }, { "name": "scheme2", "description": "The secondary scheme. By default, it’s used for secondary areas, like Checkout’s Order Summary.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemeInput", "ofType": null }, "defaultValue": null }, { "name": "scheme3", "description": "An extra scheme available to customize more surfaces, components or specific states of the user interface.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemeInput", "ofType": null }, "defaultValue": null }, { "name": "scheme4", "description": "An extra scheme available to customize more surfaces, components or specific states of the user interface.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingColorSelection", "description": "The possible colors.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TRANSPARENT", "description": "Transparent color selection.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingColors", "description": "The color settings for global colors and color schemes.", "fields": [ { "name": "global", "description": "A group of global colors for customizing the overall look and feel of the user interface.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorGlobal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "schemes", "description": "A set of color schemes which apply to different areas of the user interface.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorSchemes", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorsInput", "description": "The input fields used to update the color settings for global colors and color schemes.", "fields": null, "inputFields": [ { "name": "global", "description": "The input to update global colors for customizing the overall look and feel of the user interface.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorGlobalInput", "ofType": null }, "defaultValue": null }, { "name": "schemes", "description": "The input to define color schemes which apply to different areas of the user interface.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorSchemesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingControl", "description": "The form controls customizations.", "fields": [ { "name": "border", "description": "The border used for form controls.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": "Set to TRANSPARENT to define transparent form controls. If null, form controls inherit colors from their scheme settings (for example, the main section inherits from `design_system.colors.schemes.scheme1.control` by default). Note that usage of the `customizations.control.color` setting to customize the form control color is deprecated.\n", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius used for form controls.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "labelPosition", "description": "The label position used for form controls.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingLabelPosition", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingControlColorRoles", "description": "Colors for form controls.", "fields": [ { "name": "accent", "description": "The color of accented objects (links and focused state).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "background", "description": "The color of the background.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The color of borders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "The color of icons.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected", "description": "The colors of selected controls.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColorRoles", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "text", "description": "The color of text.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingControlColorRolesInput", "description": "The input fields to define colors for form controls.", "fields": null, "inputFields": [ { "name": "background", "description": "The color of the background.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "text", "description": "The color of text.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The color of borders.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "icon", "description": "The color of icons.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "accent", "description": "The color of accented objects (links and focused state).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "decorative", "description": "The decorative color for highlighting specific parts of the user interface.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "selected", "description": "The colors of selected controls.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorRolesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingControlInput", "description": "The input fields used to update the form controls customizations.", "fields": null, "inputFields": [ { "name": "color", "description": "Set to TRANSPARENT to define transparent form controls. If null, form controls inherit colors from their scheme settings (for example, the main section inherits from `design_system.colors.schemes.scheme1.control` by default). Note that usage of the `customizations.control.color` setting to customize the form control color is deprecated.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSelection", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius used for form controls.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The border used for form controls.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "defaultValue": null }, { "name": "labelPosition", "description": "The label position used for form controls.", "type": { "kind": "ENUM", "name": "CheckoutBrandingLabelPosition", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "description": "The options for customizing the corner radius of checkout-related objects. Examples include the primary\nbutton, the name text fields and the sections within the main area (if they have borders).\nRefer to this complete [list](https://shopify.dev/docs/api/admin-graphql/latest/enums/CheckoutBrandingCornerRadius#fieldswith)\nfor objects with customizable corner radii.\n\nThe design system defines the corner radius pixel size for each option. Modify the defaults by setting the\n[designSystem.cornerRadius](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CheckoutBrandingDesignSystemInput#field-checkoutbrandingdesignsysteminput-cornerradius)\ninput fields.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The 0px corner radius (square corners).", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL", "description": "The corner radius with a pixel value defined by designSystem.cornerRadius.small.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "BASE", "description": "The corner radius with a pixel value defined by designSystem.cornerRadius.base.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE", "description": "The corner radius with a pixel value defined by designSystem.cornerRadius.large.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingCornerRadiusVariables", "description": "Define the pixel size of corner radius options.\n", "fields": [ { "name": "base", "description": "The value in pixels for base corner radii. Example: 5.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "large", "description": "The value in pixels for large corner radii. Example: 10.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small", "description": "The value in pixels for small corner radii. Example: 3.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCornerRadiusVariablesInput", "description": "The input fields used to update the corner radius variables.", "fields": null, "inputFields": [ { "name": "small", "description": "The value in pixels for small corner radii. It should be greater than zero. Example: 3.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "base", "description": "The value in pixels for base corner radii. It should be greater than zero. Example: 5.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "large", "description": "The value in pixels for large corner radii. It should be greater than zero. Example: 10.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingCustomFont", "description": "A custom font.", "fields": [ { "name": "genericFileId", "description": "Globally unique ID reference to the custom font file.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sources", "description": "The font sources.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The font weight.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CheckoutBrandingFont", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomFontGroupInput", "description": "The input fields required to update a custom font group.", "fields": null, "inputFields": [ { "name": "base", "description": "The base font.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomFontInput", "ofType": null } }, "defaultValue": null }, { "name": "bold", "description": "The bold font.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomFontInput", "ofType": null } }, "defaultValue": null }, { "name": "loadingStrategy", "description": "The font loading strategy.", "type": { "kind": "ENUM", "name": "CheckoutBrandingFontLoadingStrategy", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomFontInput", "description": "The input fields required to update a font.", "fields": null, "inputFields": [ { "name": "weight", "description": "The font weight. Its value should be between 100 and 900.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "genericFileId", "description": "A globally-unique ID for a font file uploaded via the Files api.\nAllowed font types are .woff and .woff2.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingCustomizations", "description": "The customizations that apply to specific components or areas of the user interface.", "fields": [ { "name": "buyerJourney", "description": "The customizations for the breadcrumbs that represent a buyer's journey to the checkout.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingBuyerJourney", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartLink", "description": "The checkout cart link customizations. For example, by setting the visibility field to `HIDDEN`, you can hide the cart icon in the header for one-page checkout, and the cart link in breadcrumbs in three-page checkout.\n", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingCartLink", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkbox", "description": "The checkboxes customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingCheckbox", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "choiceList", "description": "The choice list customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingChoiceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "control", "description": "The form controls customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingControl", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expressCheckout", "description": "The express checkout customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingExpressCheckout", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "favicon", "description": "The favicon image.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "footer", "description": "The footer customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingFooter", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "global", "description": "The global customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingGlobal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "header", "description": "The header customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingHeader", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "headingLevel1", "description": "The Heading Level 1 customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingHeadingLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "headingLevel2", "description": "The Heading Level 2 customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingHeadingLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "headingLevel3", "description": "The Heading Level 3 customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingHeadingLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "main", "description": "The main area customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingMain", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchandiseThumbnail", "description": "The merchandise thumbnails customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingMerchandiseThumbnail", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderSummary", "description": "The order summary customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingOrderSummary", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "primaryButton", "description": "The primary buttons customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingButton", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secondaryButton", "description": "The secondary buttons customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingButton", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "select", "description": "The selects customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingSelect", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "textField", "description": "The text fields customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTextField", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomizationsInput", "description": "The input fields used to update the components customizations.", "fields": null, "inputFields": [ { "name": "global", "description": "The global customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingGlobalInput", "ofType": null }, "defaultValue": null }, { "name": "header", "description": "The header customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeaderInput", "ofType": null }, "defaultValue": null }, { "name": "headingLevel1", "description": "The Heading Level 1 customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeadingLevelInput", "ofType": null }, "defaultValue": null }, { "name": "headingLevel2", "description": "The Heading Level 2 customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeadingLevelInput", "ofType": null }, "defaultValue": null }, { "name": "headingLevel3", "description": "The Heading Level 3 customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeadingLevelInput", "ofType": null }, "defaultValue": null }, { "name": "footer", "description": "The footer customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFooterInput", "ofType": null }, "defaultValue": null }, { "name": "main", "description": "The main area customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMainInput", "ofType": null }, "defaultValue": null }, { "name": "orderSummary", "description": "The order summary customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingOrderSummaryInput", "ofType": null }, "defaultValue": null }, { "name": "control", "description": "The form controls customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingControlInput", "ofType": null }, "defaultValue": null }, { "name": "textField", "description": "The text fields customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTextFieldInput", "ofType": null }, "defaultValue": null }, { "name": "checkbox", "description": "The checkboxes customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCheckboxInput", "ofType": null }, "defaultValue": null }, { "name": "select", "description": "The selects customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingSelectInput", "ofType": null }, "defaultValue": null }, { "name": "primaryButton", "description": "The primary buttons customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonInput", "ofType": null }, "defaultValue": null }, { "name": "secondaryButton", "description": "The secondary buttons customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingButtonInput", "ofType": null }, "defaultValue": null }, { "name": "favicon", "description": "The favicon image (must be of PNG format).", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null }, { "name": "choiceList", "description": "The choice list customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingChoiceListInput", "ofType": null }, "defaultValue": null }, { "name": "merchandiseThumbnail", "description": "The merchandise thumbnails customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMerchandiseThumbnailInput", "ofType": null }, "defaultValue": null }, { "name": "expressCheckout", "description": "The express checkout customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingExpressCheckoutInput", "ofType": null }, "defaultValue": null }, { "name": "buyerJourney", "description": "The customizations for the breadcrumbs that represent a buyer's journey to the checkout.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingBuyerJourneyInput", "ofType": null }, "defaultValue": null }, { "name": "cartLink", "description": "The input for checkout cart link customizations. For example, by setting the visibility field to `HIDDEN`, you can hide the cart icon in the header for one-page checkout, and the cart link in breadcrumbs in three-page checkout.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCartLinkInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingDesignSystem", "description": "The design system allows you to set values that represent specific attributes\nof your brand like color and font. These attributes are used throughout the user\ninterface. This brings consistency and allows you to easily make broad design changes.\n", "fields": [ { "name": "colors", "description": "The color settings for global colors and color schemes.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingColors", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius variables.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingCornerRadiusVariables", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "typography", "description": "The typography.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypography", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingDesignSystemInput", "description": "The input fields used to update the design system.", "fields": null, "inputFields": [ { "name": "colors", "description": "The color settings for global colors and color schemes.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingColorsInput", "ofType": null }, "defaultValue": null }, { "name": "typography", "description": "The typography.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyInput", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius variables.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCornerRadiusVariablesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingExpressCheckout", "description": "The Express Checkout customizations.", "fields": [ { "name": "button", "description": "The Express Checkout buttons customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingExpressCheckoutButton", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingExpressCheckoutButton", "description": "The Express Checkout button customizations.", "fields": [ { "name": "cornerRadius", "description": "The corner radius used for the Express Checkout buttons.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingExpressCheckoutButtonInput", "description": "The input fields to use to update the express checkout customizations.", "fields": null, "inputFields": [ { "name": "cornerRadius", "description": "The corner radius used for Express Checkout buttons.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingExpressCheckoutInput", "description": "The input fields to use to update the Express Checkout customizations.", "fields": null, "inputFields": [ { "name": "button", "description": "The Express Checkout buttons customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingExpressCheckoutButtonInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CheckoutBrandingFont", "description": "A font.", "fields": [ { "name": "sources", "description": "The font sources.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The font weight.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CheckoutBrandingCustomFont", "ofType": null }, { "kind": "OBJECT", "name": "CheckoutBrandingShopifyFont", "ofType": null } ] }, { "kind": "OBJECT", "name": "CheckoutBrandingFontGroup", "description": "A font group. To learn more about updating fonts, refer to the\n[checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert)\nmutation and the checkout branding [tutorial](https://shopify.dev/docs/apps/checkout/styling).\n", "fields": [ { "name": "base", "description": "The base font.", "args": [], "type": { "kind": "INTERFACE", "name": "CheckoutBrandingFont", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bold", "description": "The bold font.", "args": [], "type": { "kind": "INTERFACE", "name": "CheckoutBrandingFont", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "loadingStrategy", "description": "The font loading strategy.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingFontLoadingStrategy", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The font group name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFontGroupInput", "description": "The input fields used to update a font group. To learn more about updating fonts, refer to the\n[checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert)\nmutation and the checkout branding [tutorial](https://shopify.dev/docs/apps/checkout/styling).\n", "fields": null, "inputFields": [ { "name": "shopifyFontGroup", "description": "A Shopify font group.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingShopifyFontGroupInput", "ofType": null }, "defaultValue": null }, { "name": "customFontGroup", "description": "A custom font group.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomFontGroupInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingFontLoadingStrategy", "description": "The font loading strategy determines how a font face is displayed after it is loaded or failed to load.\nFor more information: https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AUTO", "description": "The font display strategy is defined by the browser user agent.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLOCK", "description": "Gives the font face a short block period and an infinite swap period.", "isDeprecated": false, "deprecationReason": null }, { "name": "SWAP", "description": "Gives the font face an extremely small block period and an infinite swap period.", "isDeprecated": false, "deprecationReason": null }, { "name": "FALLBACK", "description": "Gives the font face an extremely small block period and a short swap period.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTIONAL", "description": "Gives the font face an extremely small block period and no swap period.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingFontSize", "description": "The font size.", "fields": [ { "name": "base", "description": "The base font size.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ratio", "description": "The scale ratio used to derive all font sizes such as small and large.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFontSizeInput", "description": "The input fields used to update the font size.", "fields": null, "inputFields": [ { "name": "base", "description": "The base font size. Its value should be between 12.0 and 18.0.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "ratio", "description": "The scale ratio used to derive all font sizes such as small and large. Its value should be between 1.0 and 1.4.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingFooter", "description": "A container for the footer section customizations.", "fields": [ { "name": "alignment", "description": "The footer alignment.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingFooterAlignment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the footer container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "content", "description": "The footer content settings.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingFooterContent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "padding", "description": "The padding of the footer container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The footer position.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingFooterPosition", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingFooterAlignment", "description": "Possible values for the footer alignment.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "START", "description": "The checkout footer alignment Start value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CENTER", "description": "The checkout footer alignment Center value.", "isDeprecated": false, "deprecationReason": null }, { "name": "END", "description": "The checkout footer alignment End value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingFooterContent", "description": "The footer content customizations.", "fields": [ { "name": "visibility", "description": "The visibility settings for footer content.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFooterContentInput", "description": "The input fields for footer content customizations.\n", "fields": null, "inputFields": [ { "name": "visibility", "description": "The visibility settings for footer content.", "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFooterInput", "description": "The input fields when mutating the checkout footer settings.", "fields": null, "inputFields": [ { "name": "position", "description": "The input field for setting the footer position customizations.", "type": { "kind": "ENUM", "name": "CheckoutBrandingFooterPosition", "ofType": null }, "defaultValue": null }, { "name": "alignment", "description": "The footer alignment settings. You can set the footer native content alignment to the left, center, or right.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingFooterAlignment", "ofType": null }, "defaultValue": null }, { "name": "content", "description": "The input field for setting the footer content customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFooterContentInput", "ofType": null }, "defaultValue": null }, { "name": "colorScheme", "description": "The selected color scheme of the footer container.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "padding", "description": "The padding of the footer container.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingFooterPosition", "description": "Possible values for the footer position.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "END", "description": "The End footer position.", "isDeprecated": false, "deprecationReason": null }, { "name": "INLINE", "description": "The Inline footer position.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingGlobal", "description": "The global customizations.", "fields": [ { "name": "cornerRadius", "description": "The global corner radius setting that overrides all other [corner radius](https://shopify.dev/docs/api/admin-graphql/latest/enums/CheckoutBrandingCornerRadius)\ncustomizations.\n", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingGlobalCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "typography", "description": "The global typography customizations.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyleGlobal", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingGlobalCornerRadius", "description": "Possible choices to override corner radius customizations on all applicable objects. Note that this selection \ncan only be used to set the override to `NONE` (0px).\n\nFor more customizations options, set the [corner radius](https://shopify.dev/docs/api/admin-graphql/latest/enums/CheckoutBrandingCornerRadius)\nselection on specific objects while leaving the global corner radius unset.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "Set the global corner radius override to 0px (square corners).", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingGlobalInput", "description": "The input fields used to update the global customizations.", "fields": null, "inputFields": [ { "name": "cornerRadius", "description": "Select a global corner radius setting that overrides all other [corner radii](https://shopify.dev/docs/api/admin-graphql/latest/enums/CheckoutBrandingCornerRadius)\ncustomizations.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingGlobalCornerRadius", "ofType": null }, "defaultValue": null }, { "name": "typography", "description": "The global typography customizations.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleGlobalInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingHeader", "description": "The header customizations.", "fields": [ { "name": "alignment", "description": "The header alignment.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingHeaderAlignment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "banner", "description": "The background image of the header.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartLink", "description": "The cart link customizations for 1-page checkout. This field allows to customize the cart icon that renders by default on 1-page checkout.\n", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingHeaderCartLink", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the header container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "logo", "description": "The store logo.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingLogo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "padding", "description": "The padding of the header container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The header position.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingHeaderPosition", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingHeaderAlignment", "description": "The possible header alignments.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "START", "description": "Start alignment.", "isDeprecated": false, "deprecationReason": null }, { "name": "CENTER", "description": "Center alignment.", "isDeprecated": false, "deprecationReason": null }, { "name": "END", "description": "End alignment.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingHeaderCartLink", "description": "The header cart link customizations.", "fields": [ { "name": "contentType", "description": "The content type for the header back to cart link in 1-page checkout. Setting this to image will render the custom image provided using the image field on the header cart_link object. If no image is provided, the default cart icon will be used.\n", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCartLinkContentType", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image that's used for the header back to cart link in 1-page checkout when the content type is set to image.\n", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeaderCartLinkInput", "description": "The input fields for header cart link customizations.\n", "fields": null, "inputFields": [ { "name": "contentType", "description": "The input for the content type for the header back to cart link in 1-page checkout. Setting this to image will render the custom image provided using the image field on the header cart_link object. If no image is provided, the default cart icon will be used.\n", "type": { "kind": "ENUM", "name": "CheckoutBrandingCartLinkContentType", "ofType": null }, "defaultValue": null }, { "name": "image", "description": "The input for the image that's used for the header back to cart link in 1-page checkout when the content type is set to image.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeaderInput", "description": "The input fields used to update the header customizations.", "fields": null, "inputFields": [ { "name": "alignment", "description": "The header alignment.", "type": { "kind": "ENUM", "name": "CheckoutBrandingHeaderAlignment", "ofType": null }, "defaultValue": null }, { "name": "position", "description": "The header position.", "type": { "kind": "ENUM", "name": "CheckoutBrandingHeaderPosition", "ofType": null }, "defaultValue": null }, { "name": "logo", "description": "The store logo.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingLogoInput", "ofType": null }, "defaultValue": null }, { "name": "banner", "description": "The background image of the header (must not be of SVG format).", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null }, { "name": "cartLink", "description": "The input for cart link customizations for 1-page checkout. This field allows to customize the cart icon that renders by default on 1-page checkout.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeaderCartLinkInput", "ofType": null }, "defaultValue": null }, { "name": "colorScheme", "description": "The selected color scheme of the header container.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "padding", "description": "The padding of the header container.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingHeaderPosition", "description": "The possible header positions.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INLINE", "description": "Inline position.", "isDeprecated": false, "deprecationReason": null }, { "name": "INLINE_SECONDARY", "description": "Secondary inline position.", "isDeprecated": false, "deprecationReason": null }, { "name": "START", "description": "Start position.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingHeadingLevel", "description": "The heading level customizations.", "fields": [ { "name": "typography", "description": "The typography customizations used for headings.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingHeadingLevelInput", "description": "The input fields for heading level customizations.", "fields": null, "inputFields": [ { "name": "typography", "description": "The typography customizations used for headings.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingImage", "description": "A checkout branding image.", "fields": [ { "name": "image", "description": "The image details.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "description": "The input fields used to update a checkout branding image uploaded via the Files API.", "fields": null, "inputFields": [ { "name": "mediaImageId", "description": "A globally-unique ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingInput", "description": "The input fields used to upsert the checkout branding settings.", "fields": null, "inputFields": [ { "name": "designSystem", "description": "The design system allows you to set values that represent specific attributes\nof your brand like color and font. These attributes are used throughout the user\ninterface. This brings consistency and allows you to easily make broad design changes.\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingDesignSystemInput", "ofType": null }, "defaultValue": null }, { "name": "customizations", "description": "The customizations that apply to specific components or areas of the user interface.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingCustomizationsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingLabelPosition", "description": "Possible values for the label position.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INSIDE", "description": "The Inside label position.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUTSIDE", "description": "The Outside label position.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingLogo", "description": "The store logo customizations.", "fields": [ { "name": "image", "description": "The logo image.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxWidth", "description": "The maximum width of the logo.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibility", "description": "The visibility of the logo.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingLogoInput", "description": "The input fields used to update the logo customizations.", "fields": null, "inputFields": [ { "name": "image", "description": "The logo image (must not be of SVG format).", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null }, { "name": "maxWidth", "description": "The maximum width of the logo.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "visibility", "description": "The visibility of the logo.", "type": { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingMain", "description": "The main container customizations.", "fields": [ { "name": "backgroundImage", "description": "The background image of the main container.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the main container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "section", "description": "The settings for the main sections.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingMainSection", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMainInput", "description": "The input fields used to update the main container customizations.", "fields": null, "inputFields": [ { "name": "colorScheme", "description": "The selected color scheme for the main container of the checkout.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "backgroundImage", "description": "The background image of the main container (must not be of SVG format).", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null }, { "name": "section", "description": "The settings for the main sections.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMainSectionInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingMainSection", "description": "The main sections customizations.", "fields": [ { "name": "background", "description": "The background style of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBackground", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The border for the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "borderStyle", "description": "The border style of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "borderWidth", "description": "The border width of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderWidth", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "padding", "description": "The padding of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shadow", "description": "The shadow of the main sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingShadow", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMainSectionInput", "description": "The input fields used to update the main sections customizations.", "fields": null, "inputFields": [ { "name": "colorScheme", "description": "The selected color scheme for the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "background", "description": "The background style of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBackground", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The border for the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "defaultValue": null }, { "name": "borderStyle", "description": "The border style of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderStyle", "ofType": null }, "defaultValue": null }, { "name": "borderWidth", "description": "The border width of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderWidth", "ofType": null }, "defaultValue": null }, { "name": "shadow", "description": "The shadow of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingShadow", "ofType": null }, "defaultValue": null }, { "name": "padding", "description": "The padding of the main sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingMerchandiseThumbnail", "description": "The merchandise thumbnails customizations.", "fields": [ { "name": "border", "description": "The border used for merchandise thumbnails.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius used for merchandise thumbnails.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingMerchandiseThumbnailInput", "description": "The input fields used to update the merchandise thumbnails customizations.", "fields": null, "inputFields": [ { "name": "border", "description": "The border used for merchandise thumbnails.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius used for merchandise thumbnails.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingOrderSummary", "description": "The order summary customizations.", "fields": [ { "name": "backgroundImage", "description": "The background image of the order summary container.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the order summary container.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "section", "description": "The settings for the order summary sections.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingOrderSummarySection", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingOrderSummaryInput", "description": "The input fields used to update the order summary container customizations.", "fields": null, "inputFields": [ { "name": "colorScheme", "description": "The selected color scheme for the order summary container of the checkout.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "backgroundImage", "description": "The background image of the order summary container (must not be of SVG format).", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingImageInput", "ofType": null }, "defaultValue": null }, { "name": "section", "description": "The settings for the order summary sections.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingOrderSummarySectionInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingOrderSummarySection", "description": "The order summary sections customizations.", "fields": [ { "name": "background", "description": "The background style of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBackground", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "border", "description": "The border for the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "borderStyle", "description": "The border style of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "borderWidth", "description": "The border width of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderWidth", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "colorScheme", "description": "The selected color scheme of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cornerRadius", "description": "The corner radius of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "padding", "description": "The padding of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shadow", "description": "The shadow of the order summary sections.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingShadow", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingOrderSummarySectionInput", "description": "The input fields used to update the order summary sections customizations.", "fields": null, "inputFields": [ { "name": "colorScheme", "description": "The selected color scheme for the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingColorSchemeSelection", "ofType": null }, "defaultValue": null }, { "name": "background", "description": "The background style of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBackground", "ofType": null }, "defaultValue": null }, { "name": "cornerRadius", "description": "The corner radius of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingCornerRadius", "ofType": null }, "defaultValue": null }, { "name": "border", "description": "The border for the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "ofType": null }, "defaultValue": null }, { "name": "borderStyle", "description": "The border style of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderStyle", "ofType": null }, "defaultValue": null }, { "name": "borderWidth", "description": "The border width of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorderWidth", "ofType": null }, "defaultValue": null }, { "name": "shadow", "description": "The shadow of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingShadow", "ofType": null }, "defaultValue": null }, { "name": "padding", "description": "The padding of the order summary sections.", "type": { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingSelect", "description": "The selects customizations.", "fields": [ { "name": "border", "description": "The border used for selects.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "typography", "description": "The typography customizations used for selects.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingSelectInput", "description": "The input fields used to update the selects customizations.", "fields": null, "inputFields": [ { "name": "border", "description": "The border used for selects.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorder", "ofType": null }, "defaultValue": null }, { "name": "typography", "description": "The typography customizations used for selects.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingShadow", "description": "The container shadow.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SMALL_200", "description": "The Small 200 shadow.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_100", "description": "The Small 100 shadow.", "isDeprecated": false, "deprecationReason": null }, { "name": "BASE", "description": "The Base shadow.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_100", "description": "The Large 100 shadow.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_200", "description": "The Large 200 shadow.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingShopifyFont", "description": "A Shopify font.", "fields": [ { "name": "sources", "description": "The font sources.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The font weight.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CheckoutBrandingFont", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingShopifyFontGroupInput", "description": "The input fields used to update a Shopify font group.", "fields": null, "inputFields": [ { "name": "name", "description": "The Shopify font name from [the list of available fonts](https://shopify.dev/themes/architecture/settings/fonts#available-fonts), such as `Alegreya Sans` or `Anonymous Pro`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "baseWeight", "description": "The base font weight.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "boldWeight", "description": "The bold font weight.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "loadingStrategy", "description": "The font loading strategy.", "type": { "kind": "ENUM", "name": "CheckoutBrandingFontLoadingStrategy", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingSimpleBorder", "description": "Possible values for the simple border.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The None simple border.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULL", "description": "The Full simple border.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingSpacing", "description": "Possible values for the spacing.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The None spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTRA_TIGHT", "description": "The Extra Tight spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "TIGHT", "description": "The Tight spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "BASE", "description": "The Base spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOOSE", "description": "The Loose spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTRA_LOOSE", "description": "The Extra Loose spacing.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingSpacingKeyword", "description": "The spacing between UI elements.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "The None spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "BASE", "description": "The Base spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL", "description": "The Small spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_100", "description": "The Small 100 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_200", "description": "The Small 200 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_300", "description": "The Small 300 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_400", "description": "The Small 400 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL_500", "description": "The Small 500 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE", "description": "The Large spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_100", "description": "The Large 100 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_200", "description": "The Large 200 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_300", "description": "The Large 300 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_400", "description": "The Large 400 spacing.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE_500", "description": "The Large 500 spacing.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingTextField", "description": "The text fields customizations.", "fields": [ { "name": "border", "description": "The border used for text fields.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingBorder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "typography", "description": "The typography customizations used for text fields.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyle", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTextFieldInput", "description": "The input fields used to update the text fields customizations.", "fields": null, "inputFields": [ { "name": "border", "description": "The border used for text fields.", "type": { "kind": "ENUM", "name": "CheckoutBrandingBorder", "ofType": null }, "defaultValue": null }, { "name": "typography", "description": "The typography customizations used for text fields.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingTypography", "description": "The typography settings used for checkout-related text. Use these settings to customize the\nfont family and size for primary and secondary text elements.\n\nRefer to the [typography tutorial](https://shopify.dev/docs/apps/checkout/styling/customize-typography)\nfor further information on typography customization.\n", "fields": [ { "name": "primary", "description": "A font group used for most components such as text, buttons and form controls.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingFontGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secondary", "description": "A font group used for heading components by default.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingFontGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "size", "description": "The font size design system (base size in pixels and scaling between different sizes).", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBrandingFontSize", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingTypographyFont", "description": "The font selection.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRIMARY", "description": "The primary font.", "isDeprecated": false, "deprecationReason": null }, { "name": "SECONDARY", "description": "The secondary font.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyInput", "description": "The input fields used to update the typography. Refer to the [typography tutorial](https://shopify.dev/docs/apps/checkout/styling/customize-typography)\nfor more information on how to set these fields.\n", "fields": null, "inputFields": [ { "name": "size", "description": "The font size.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFontSizeInput", "ofType": null }, "defaultValue": null }, { "name": "primary", "description": "A font group used for most components such as text, buttons and form controls.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFontGroupInput", "ofType": null }, "defaultValue": null }, { "name": "secondary", "description": "A font group used for heading components by default.", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingFontGroupInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingTypographyKerning", "description": "Possible values for the typography kerning.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BASE", "description": "Base or default kerning.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOOSE", "description": "Loose kerning, leaving more space than the default in between characters.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTRA_LOOSE", "description": "Extra loose kerning, leaving even more space in between characters.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingTypographyLetterCase", "description": "Possible values for the typography letter case.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LOWER", "description": "All letters are is lower case.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "No letter casing applied.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "Capitalize the first letter of each word.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPPER", "description": "All letters are uppercase.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingTypographySize", "description": "Possible choices for the font size.\n\nNote that the value in pixels of these settings can be customized with the\n[typography size](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CheckoutBrandingFontSizeInput)\nobject. Refer to the [typography tutorial](https://shopify.dev/docs/apps/checkout/styling/customize-typography)\nfor more information.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EXTRA_SMALL", "description": "The extra small font size. Example: 10px.", "isDeprecated": false, "deprecationReason": null }, { "name": "SMALL", "description": "The small font size. Example: 12px.", "isDeprecated": false, "deprecationReason": null }, { "name": "BASE", "description": "The base font size. Example: 14px.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIUM", "description": "The medium font size. Example: 16px.", "isDeprecated": false, "deprecationReason": null }, { "name": "LARGE", "description": "The large font size. Example: 19px.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTRA_LARGE", "description": "The extra large font size. Example: 21px.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTRA_EXTRA_LARGE", "description": "The extra extra large font size. Example: 24px.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyle", "description": "The typography customizations.", "fields": [ { "name": "font", "description": "The font.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyFont", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "kerning", "description": "The kerning.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyKerning", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "letterCase", "description": "The letter case.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyLetterCase", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "size", "description": "The font size.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographySize", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The font weight.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyWeight", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingTypographyStyleGlobal", "description": "The global typography customizations.", "fields": [ { "name": "kerning", "description": "The kerning.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyKerning", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "letterCase", "description": "The letter case.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyLetterCase", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleGlobalInput", "description": "The input fields used to update the global typography customizations.", "fields": null, "inputFields": [ { "name": "letterCase", "description": "The letter case.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyLetterCase", "ofType": null }, "defaultValue": null }, { "name": "kerning", "description": "The kerning.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyKerning", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingTypographyStyleInput", "description": "The input fields used to update the typography customizations.", "fields": null, "inputFields": [ { "name": "font", "description": "The font.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyFont", "ofType": null }, "defaultValue": null }, { "name": "size", "description": "The font size.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographySize", "ofType": null }, "defaultValue": null }, { "name": "weight", "description": "The font weight.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyWeight", "ofType": null }, "defaultValue": null }, { "name": "letterCase", "description": "The letter case.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyLetterCase", "ofType": null }, "defaultValue": null }, { "name": "kerning", "description": "The kerning.", "type": { "kind": "ENUM", "name": "CheckoutBrandingTypographyKerning", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingTypographyWeight", "description": "Possible values for the font weight.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BASE", "description": "The base weight.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOLD", "description": "The bold weight.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingUpsertPayload", "description": "Return type for `checkoutBrandingUpsert` mutation.", "fields": [ { "name": "checkoutBranding", "description": "Returns the new checkout branding settings.", "args": [], "type": { "kind": "OBJECT", "name": "CheckoutBranding", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutBrandingUpsertUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutBrandingUpsertUserError", "description": "An error that occurs during the execution of `CheckoutBrandingUpsert`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CheckoutBrandingUpsertUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingUpsertUserErrorCode", "description": "Possible error codes that can be returned by `CheckoutBrandingUpsertUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutBrandingVisibility", "description": "Possible visibility states.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HIDDEN", "description": "The Hidden visibility setting.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISIBLE", "description": "The Visible visibility setting.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutProfile", "description": "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.", "fields": [ { "name": "createdAt", "description": "The date and time when the checkout profile was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editedAt", "description": "The date and time when the checkout profile was last edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPublished", "description": "Whether the checkout profile is published or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The profile name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the checkout profile was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutProfileConnection", "description": "An auto-generated type for paginating through multiple CheckoutProfiles.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutProfileEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CheckoutProfileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutProfile", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutProfileEdge", "description": "An auto-generated type which holds one CheckoutProfile and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CheckoutProfileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutProfile", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutProfileSortKeys", "description": "The set of valid sort keys for the CheckoutProfile query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "EDITED_AT", "description": "Sort by the `edited_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "IS_PUBLISHED", "description": "Sort by the `is_published` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CodeDiscountSortKeys", "description": "The set of valid sort keys for the CodeDiscount query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STARTS_AT", "description": "Sort by the `starts_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENDS_AT", "description": "Sort by the `ends_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Collection", "description": "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.\n\nCollections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.\n\nCollections can also be created for a custom group of products. These are called custom or manual collections.\n", "fields": [ { "name": "availablePublicationsCount", "description": "The number of publications a resource is published to without feedback errors.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.\n", "args": [ { "name": "truncateAt", "description": "Truncates string after the given length.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "descriptionHtml", "description": "The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "HTML", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "feedback", "description": "Information about the collection that's provided through resource feedback.", "args": [], "type": { "kind": "OBJECT", "name": "ResourceFeedback", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`.\n\nIf the title is changed, the handle doesn't automatically change.\n\nThe handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasProduct", "description": "Whether the collection includes the specified product.", "args": [ { "name": "id", "description": "The ID of the product to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated with the collection.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "products", "description": "The products that are included in the collection.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductCollectionSortKeys", "ofType": null }, "defaultValue": "COLLECTION_DEFAULT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsCount", "description": "The number of products in the collection.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublicationsCount` instead." }, { "name": "publications", "description": "The channels where the collection is published.", "args": [ { "name": "onlyPublished", "description": "Whether or not to return only the collection publications that are published.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionPublicationConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublications` instead." }, { "name": "publishedOnChannel", "description": "Check to see whether the resource is published to a given channel.", "args": [ { "name": "channelId", "description": "The ID of the channel to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnPublication` instead." }, { "name": "publishedOnCurrentChannel", "description": "Check to see whether the resource is published to the calling app's channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnCurrentPublication` instead." }, { "name": "publishedOnCurrentPublication", "description": "Check to see whether the resource is published to the calling app's publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishedOnPublication", "description": "Check to see whether the resource is published to a given publication.", "args": [ { "name": "publicationId", "description": "The ID of the publication to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublications", "description": "The list of resources that are published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsV2", "description": "The list of resources that are either published or staged to be published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "catalogType", "description": "Filter publications by catalog type.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2Connection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ruleSet", "description": "For a smart (automated) collection, specifies the rules that determine whether a product is included.\n", "args": [], "type": { "kind": "OBJECT", "name": "CollectionRuleSet", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "seo", "description": "If the default SEO fields for page title and description have been modified, contains the modified information.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SEO", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sortOrder", "description": "The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionSortOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontId", "description": "The Storefront GraphQL API ID of the `Collection`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "StorefrontID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `id` instead." }, { "name": "templateSuffix", "description": "The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unpublishedChannels", "description": "The list of channels that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unpublishedPublications` instead." }, { "name": "unpublishedPublications", "description": "The list of publications that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "Publishable", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionAddProductsPayload", "description": "Return type for `collectionAddProducts` mutation.", "fields": [ { "name": "collection", "description": "The updated collection. Returns `null` if an error is raised.", "args": [], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionAddProductsV2Payload", "description": "Return type for `collectionAddProductsV2` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job adding the products.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionAddProductsV2UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionAddProductsV2UserError", "description": "An error that occurs during the execution of `CollectionAddProductsV2`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CollectionAddProductsV2UserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CollectionAddProductsV2UserErrorCode", "description": "Possible error codes that can be returned by `CollectionAddProductsV2UserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANT_ADD_TO_SMART_COLLECTION", "description": "Can't manually add products to a smart collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_DOES_NOT_EXIST", "description": "Collection doesn't exist.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionConnection", "description": "An auto-generated type for paginating through multiple Collections.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CollectionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Collection", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionCreatePayload", "description": "Return type for `collectionCreate` mutation.", "fields": [ { "name": "collection", "description": "The collection that has been created.", "args": [], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionDeleteInput", "description": "The input fields for specifying the collection to delete.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the collection to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionDeletePayload", "description": "Return type for `collectionDelete` mutation.", "fields": [ { "name": "deletedCollectionId", "description": "The ID of the collection that was deleted. Returns `null` if the collection doesn't exist.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop associated with the collection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionEdge", "description": "An auto-generated type which holds one Collection and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CollectionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Collection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionInput", "description": "The input fields required to create a collection.", "fields": null, "inputFields": [ { "name": "descriptionHtml", "description": "The description of the collection, in HTML format.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "handle", "description": "A unique human-friendly string for the collection. Automatically generated from the collection's title.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "Specifies the collection to update or create a new collection if absent. Required for updating a collection.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "image", "description": "The image associated with the collection.", "type": { "kind": "INPUT_OBJECT", "name": "ImageInput", "ofType": null }, "defaultValue": null }, { "name": "products", "description": "Initial list of collection products. Only valid with `collectionCreate` and without rules.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "ruleSet", "description": "The rules used to assign products to the collection.\n", "type": { "kind": "INPUT_OBJECT", "name": "CollectionRuleSetInput", "ofType": null }, "defaultValue": null }, { "name": "templateSuffix", "description": "The theme template used when viewing the collection in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "sortOrder", "description": "The order in which the collection's products are sorted.", "type": { "kind": "ENUM", "name": "CollectionSortOrder", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the collection. Required for creating a new collection.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "The metafields to associate with the collection.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "seo", "description": "SEO information for the collection.", "type": { "kind": "INPUT_OBJECT", "name": "SEOInput", "ofType": null }, "defaultValue": null }, { "name": "redirectNewHandle", "description": "Indicates whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionPublication", "description": "Represents the publications where a collection is published.", "fields": [ { "name": "channel", "description": "The channel where the collection will be published.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Channel", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publication` instead." }, { "name": "collection", "description": "The collection to be published on the publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Collection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPublished", "description": "Whether the publication is published or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "The publication where the collection will be published.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Publication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishDate", "description": "The date that the publication was or is going to be published.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionPublicationConnection", "description": "An auto-generated type for paginating through multiple CollectionPublications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionPublicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CollectionPublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionPublication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionPublicationEdge", "description": "An auto-generated type which holds one CollectionPublication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CollectionPublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionPublication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionPublicationInput", "description": "The input fields for publications to which a collection will be published.", "fields": null, "inputFields": [ { "name": "publicationId", "description": "The ID of the publication.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionPublishInput", "description": "The input fields for specifying a collection to publish and the sales channels to publish it to.", "fields": null, "inputFields": [ { "name": "id", "description": "The collection to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "collectionPublications", "description": "The channels where the collection will be published.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionPublicationInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionPublishPayload", "description": "Return type for `collectionPublish` mutation.", "fields": [ { "name": "collection", "description": "The published collection.", "args": [], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionPublications", "description": "The channels where the collection has been published.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionPublication", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop associated with the collection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRemoveProductsPayload", "description": "Return type for `collectionRemoveProducts` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the products.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionReorderProductsPayload", "description": "Return type for `collectionReorderProducts` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job reordering the products.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRule", "description": "Represents at rule that's used to assign products to a collection.", "fields": [ { "name": "column", "description": "The attribute that the rule focuses on. For example, `title` or `product_type`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleColumn", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "condition", "description": "The value that the operator is applied to. For example, `Hats`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "conditionObject", "description": "The value that the operator is applied to.", "args": [], "type": { "kind": "UNION", "name": "CollectionRuleConditionObject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "relation", "description": "The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleRelation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CollectionRuleColumn", "description": "Specifies the attribute of a product being used to populate the smart collection.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TAG", "description": "The [`tag`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "The [`title`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-title) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "TYPE", "description": "The [`type`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_TAXONOMY_NODE_ID", "description": "The [`product_taxonomy_node_id`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-productcategory) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "VENDOR", "description": "The [`vendor`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-vendor) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_PRICE", "description": "The [`variant_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-price) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "IS_PRICE_REDUCED", "description": "An attribute evaluated based on the `compare_at_price` attribute of the product's variants.\nWith `is_set` relation, the rule matches products with at least one variant with `compare_at_price` set.\nWith `is_not_set` relation, the rule matches matches products with at least one variant with `compare_at_price` not set.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_COMPARE_AT_PRICE", "description": "The [`variant_compare_at_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-compareatprice) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_WEIGHT", "description": "The [`variant_weight`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-weight) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_INVENTORY", "description": "The [`variant_inventory`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryquantity) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_TITLE", "description": "The [`variant_title`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-title) attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_METAFIELD_DEFINITION", "description": "This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_METAFIELD_DEFINITION", "description": "This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "CollectionRuleConditionObject", "description": "Specifies object for the condition of the rule.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CollectionRuleMetafieldCondition", "ofType": null }, { "kind": "OBJECT", "name": "CollectionRuleProductCategoryCondition", "ofType": null }, { "kind": "OBJECT", "name": "CollectionRuleTextCondition", "ofType": null } ] }, { "kind": "OBJECT", "name": "CollectionRuleConditions", "description": "This object defines all columns and allowed relations that can be used in rules for smart collections to automatically include the matching products.", "fields": [ { "name": "allowedRelations", "description": "Allowed relations of the rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleRelation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultRelation", "description": "Most commonly used relation for this rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleRelation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ruleObject", "description": "Additional attributes defining the rule.", "args": [], "type": { "kind": "UNION", "name": "CollectionRuleConditionsRuleObject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ruleType", "description": "Type of the rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleColumn", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "CollectionRuleConditionsRuleObject", "description": "Specifies object with additional rule attributes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CollectionRuleMetafieldCondition", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "CollectionRuleInput", "description": "The input fields for a rule to associate with a collection.", "fields": null, "inputFields": [ { "name": "column", "description": "The attribute that the rule focuses on. For example, `title` or `product_type`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleColumn", "ofType": null } }, "defaultValue": null }, { "name": "relation", "description": "The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CollectionRuleRelation", "ofType": null } }, "defaultValue": null }, { "name": "condition", "description": "The value that the operator is applied to. For example, `Hats`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "conditionObjectId", "description": "The object ID that points to additional attributes for the collection rule.\nThis is only required when using metafield definition rules.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRuleMetafieldCondition", "description": "Identifies a metafield definition used as a rule for the smart collection.", "fields": [ { "name": "metafieldDefinition", "description": "The metafield definition associated with the condition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRuleProductCategoryCondition", "description": "Specifies the condition for a Product Category field.", "fields": [ { "name": "value", "description": "The value of the condition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTaxonomyNode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CollectionRuleRelation", "description": "Specifies the relationship between the `column` and the `condition`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CONTAINS", "description": "The attribute contains the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENDS_WITH", "description": "The attribute ends with the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "EQUALS", "description": "The attribute is equal to the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The attribute is greater than the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "IS_NOT_SET", "description": "The attribute is not set (equal to `null`).", "isDeprecated": false, "deprecationReason": null }, { "name": "IS_SET", "description": "The attribute is set (not equal to `null`).", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The attribute is less than the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_CONTAINS", "description": "The attribute does not contain the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_EQUALS", "description": "The attribute does not equal the condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "STARTS_WITH", "description": "The attribute starts with the condition.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRuleSet", "description": "The set of rules that are used to determine which products are included in the collection.", "fields": [ { "name": "appliedDisjunctively", "description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match at least one of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rules", "description": "The rules used to assign products to the collection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionRule", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionRuleSetInput", "description": "The input fields for a rule set of the collection.", "fields": null, "inputFields": [ { "name": "appliedDisjunctively", "description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match at least one of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "rules", "description": "The rules used to assign products to the collection.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionRuleInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionRuleTextCondition", "description": "Specifies the condition for a text field.", "fields": [ { "name": "value", "description": "The value of the condition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CollectionSortKeys", "description": "The set of valid sort keys for the Collection query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CollectionSortOrder", "description": "Specifies the sort order for the products in the collection.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALPHA_ASC", "description": "Alphabetically, in ascending order (A - Z).", "isDeprecated": false, "deprecationReason": null }, { "name": "ALPHA_DESC", "description": "Alphabetically, in descending order (Z - A).", "isDeprecated": false, "deprecationReason": null }, { "name": "BEST_SELLING", "description": "By best-selling products.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED", "description": "By date created, in ascending order (oldest - newest).", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_DESC", "description": "By date created, in descending order (newest - oldest).", "isDeprecated": false, "deprecationReason": null }, { "name": "MANUAL", "description": "In the order set manually by the merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_ASC", "description": "By price, in ascending order (lowest - highest).", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_DESC", "description": "By price, in descending order (highest - lowest).", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CollectionUnpublishInput", "description": "The input fields for specifying the collection to unpublish and the sales channels to remove it from.\n", "fields": null, "inputFields": [ { "name": "id", "description": "The collection to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "collectionPublications", "description": "The channels where the collection is published.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionPublicationInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionUnpublishPayload", "description": "Return type for `collectionUnpublish` mutation.", "fields": [ { "name": "collection", "description": "The collection that has been unpublished.", "args": [], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop associated with the collection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CollectionUpdatePayload", "description": "Return type for `collectionUpdate` mutation.", "fields": [ { "name": "collection", "description": "The updated collection.", "args": [], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "job", "description": "The asynchronous job updating the products based on the new rule set.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Color", "description": "A string containing a hexadecimal representation of a color.\n\nFor example, \"#6A8D48\".\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CommentEvent", "description": "Comment events are generated by staff members of a shop.\nThey are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.\n", "fields": [ { "name": "appTitle", "description": "The name of the app that created the event.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attachments", "description": "The attachments associated with the comment event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CommentEventAttachment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToApp", "description": "Whether the event was created by an app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToUser", "description": "Whether the event was caused by an admin user.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "author", "description": "The name of the user that authored the comment event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMember", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canDelete", "description": "Whether the comment event can be deleted. If true, then the comment event can be deleted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canEdit", "description": "Whether the comment event can be edited. If true, then the comment event can be edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the event was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "criticalAlert", "description": "Whether the event is critical.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "edited", "description": "Whether the comment event has been edited. If true, then the comment event has been edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "embed", "description": "The object reference associated with the comment event. For example, a product or discount).", "args": [], "type": { "kind": "UNION", "name": "CommentEventEmbed", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Human readable text that describes the event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rawMessage", "description": "The raw body of the comment event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subject", "description": "The parent subject to which the comment event belongs.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Event", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CommentEventAttachment", "description": "A file attachment associated to a comment event.", "fields": [ { "name": "fileExtension", "description": "The file extension of the comment event attachment, indicating the file format.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image attached to the comment event.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The filename of the comment event attachment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "size", "description": "The size of the attachment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the attachment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "CommentEventEmbed", "description": "The main embed of a comment event.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } ] }, { "kind": "INTERFACE", "name": "CommentEventSubject", "description": "The subject line of a comment event.", "fields": [ { "name": "hasTimelineComment", "description": "Whether the timeline subject has a timeline comment. If true, then a timeline comment exists.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PriceRule", "ofType": null } ] }, { "kind": "OBJECT", "name": "CompaniesDeletePayload", "description": "Return type for `companiesDelete` mutation.", "fields": [ { "name": "deletedCompanyIds", "description": "A list of IDs of the deleted companies.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Company", "description": "Represents information about a company which is also a customer of the shop.", "fields": [ { "name": "contactCount", "description": "The number of contacts that belong to the company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `contactsCount` instead." }, { "name": "contactRoles", "description": "The list of roles for the company contacts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyContactRoleSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "contacts", "description": "The list of contacts in the company.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyContactSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_id |\n| company_location_id |\n| created_at |\n| email |\n| location_name |\n| name |\n| role_name |\n| status |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "contactsCount", "description": "The number of contacts that belong to the company.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSince", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company became the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultRole", "description": "The role proposed by default for a contact at the company.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "The list of the company's draft orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| customer_id |\n| source |\n| status |\n| tag |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "externalId", "description": "A unique externally-supplied ID for the company.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Whether the merchant added a timeline comment to the company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lifetimeDuration", "description": "The lifetime duration of the company, since it became a customer of the shop. Examples: `2 days`, `3 months`, `1 year`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": "The list of locations in the company.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyLocationSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_id |\n| created_at |\n| external_id |\n| ids |\n| name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsCount", "description": "The number of locations that belong to the company.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mainContact", "description": "The main contact for the company.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "A note about the company.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "The list of the company's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ordersCount", "description": "The total number of orders placed for this company, across all its locations.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "totalSpent", "description": "The total amount spent by this company, across all its locations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyAddress", "description": "Represents a billing or shipping address for a company location.", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyName", "description": "The name of the company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\nFor example, US.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name of the recipient.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedAddress", "description": "The formatted version of the address.", "args": [ { "name": "withName", "description": "Whether to include the recipient's name in the formatted address.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "withCompanyName", "description": "Whether to include the company name in the formatted address.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedArea", "description": "A comma-separated list of the values for city, province, and country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name of the recipient.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "A unique phone number for the customer.\nFormatted using E.164 standard. For example, _+16135551111_.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient", "description": "The identity of the recipient e.g. 'Receiving Department'.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was last updated.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zoneCode", "description": "The two-letter code for the region.\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyAddressDeletePayload", "description": "Return type for `companyAddressDelete` mutation.", "fields": [ { "name": "deletedAddressId", "description": "The ID of the deleted address.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyAddressInput", "description": "The input fields to create or update the address of a company location.", "fields": null, "inputFields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zip", "description": "The zip or postal code of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "recipient", "description": "The identity of the recipient e.g. 'Receiving Department'.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "firstName", "description": "The first name of the recipient.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lastName", "description": "The last name of the recipient.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "A phone number for the recipient. Formatted using E.164 standard. For example, _+16135551111_.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zoneCode", "description": "The two-letter code ([ISO 3166-2 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-2) format) for the region of the address, such as the province, state, or district. For example, `ON` for Ontario, Canada.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryCode", "description": "The two-letter code ([ISO 3166-1 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format) for the country of the address. For example, `US`` for the United States.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanyAddressType", "description": "The valid values for the address type of a company.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BILLING", "description": "The address is a billing address.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING", "description": "The address is a shipping address.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyAssignCustomerAsContactPayload", "description": "Return type for `companyAssignCustomerAsContact` mutation.", "fields": [ { "name": "companyContact", "description": "The created company contact.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyAssignMainContactPayload", "description": "Return type for `companyAssignMainContact` mutation.", "fields": [ { "name": "company", "description": "The company for which the main contact is assigned.", "args": [], "type": { "kind": "OBJECT", "name": "Company", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyConnection", "description": "An auto-generated type for paginating through multiple Companies.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CompanyEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContact", "description": "A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer).", "fields": [ { "name": "company", "description": "The company to which the contact belongs.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was created at Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer associated to this contact.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "The list of draft orders for the company contact.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| customer_id |\n| source |\n| status |\n| tag |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isMainContact", "description": "Whether the contact is the main contact of the company.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lifetimeDuration", "description": "The lifetime duration of the company contact, since its creation date on Shopify. Examples: `1 year`, `2 months`, `3 days`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "The company contact's locale (language).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "The list of orders for the company contact.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "roleAssignments", "description": "The list of roles assigned to this company contact.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyContactRoleAssignmentSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_contact_id |\n| company_contact_role_id |\n| company_id |\n| company_location_id |\n| created_at |\n| location_name |\n| role_name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The company contact's job title.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactAssignRolePayload", "description": "Return type for `companyContactAssignRole` mutation.", "fields": [ { "name": "companyContactRoleAssignment", "description": "The company contact role assignment.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactAssignRolesPayload", "description": "Return type for `companyContactAssignRoles` mutation.", "fields": [ { "name": "roleAssignments", "description": "A list of newly created assignments of company contacts to a company location.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactConnection", "description": "An auto-generated type for paginating through multiple CompanyContacts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CompanyContactEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactCreatePayload", "description": "Return type for `companyContactCreate` mutation.", "fields": [ { "name": "companyContact", "description": "The created company contact.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactDeletePayload", "description": "Return type for `companyContactDelete` mutation.", "fields": [ { "name": "deletedCompanyContactId", "description": "The ID of the deleted company contact.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactEdge", "description": "An auto-generated type which holds one CompanyContact and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CompanyContactEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyContactInput", "description": "The input fields for company contact attributes when creating or updating a company contact.", "fields": null, "inputFields": [ { "name": "firstName", "description": "The company contact's first name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lastName", "description": "The company contact's last name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "email", "description": "The unique email address of the company contact.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the company contact.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locale", "description": "The contact's locale.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number of the company contact.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRemoveFromCompanyPayload", "description": "Return type for `companyContactRemoveFromCompany` mutation.", "fields": [ { "name": "removedCompanyContactId", "description": "The ID of the removed company contact.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRevokeRolePayload", "description": "Return type for `companyContactRevokeRole` mutation.", "fields": [ { "name": "revokedCompanyContactRoleAssignmentId", "description": "The role assignment that was revoked.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRevokeRolesPayload", "description": "Return type for `companyContactRevokeRoles` mutation.", "fields": [ { "name": "revokedRoleAssignmentIds", "description": "A list of role assignment IDs that were removed from the company contact.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRole", "description": "The role for a [company contact](https://shopify.dev/api/admin-graphql/latest/objects/companycontact).", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of a role.\nFor example, `admin` or `buyer`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "A note for the role.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyContactRoleAssign", "description": "The input fields for the role and location to assign to a company contact.\n", "fields": null, "inputFields": [ { "name": "companyContactRoleId", "description": "The role ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyLocationId", "description": "The location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "description": "The CompanyContactRoleAssignment describes the company and location associated to a company contact's role.", "fields": [ { "name": "company", "description": "The company this role assignment belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContact", "description": "The company contact for whom this role is assigned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocation", "description": "The company location to which the role is assigned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "role", "description": "The role that's assigned to the company contact.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRoleAssignmentConnection", "description": "An auto-generated type for paginating through multiple CompanyContactRoleAssignments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignmentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CompanyContactRoleAssignmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRoleAssignmentEdge", "description": "An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CompanyContactRoleAssignmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanyContactRoleAssignmentSortKeys", "description": "The set of valid sort keys for the CompanyContactRoleAssignment query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_NAME", "description": "Sort by the `location_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRoleConnection", "description": "An auto-generated type for paginating through multiple CompanyContactRoles.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CompanyContactRoleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactRoleEdge", "description": "An auto-generated type which holds one CompanyContactRole and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CompanyContactRoleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanyContactRoleSortKeys", "description": "The set of valid sort keys for the CompanyContactRole query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactSendWelcomeEmailPayload", "description": "Return type for `companyContactSendWelcomeEmail` mutation.", "fields": [ { "name": "companyContact", "description": "The company contact to whom a welcome email was sent.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanyContactSortKeys", "description": "The set of valid sort keys for the CompanyContact query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_ID", "description": "Sort by the `company_id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMAIL", "description": "Sort by the `email` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME_EMAIL", "description": "Sort by the `name_email` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactUpdatePayload", "description": "Return type for `companyContactUpdate` mutation.", "fields": [ { "name": "companyContact", "description": "The updated company contact.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyContactsDeletePayload", "description": "Return type for `companyContactsDelete` mutation.", "fields": [ { "name": "deletedCompanyContactIds", "description": "The list of IDs of the deleted company contacts.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyCreateInput", "description": "The input fields and values for creating a company and its associated resources.\n", "fields": null, "inputFields": [ { "name": "company", "description": "The attributes for the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyInput", "ofType": null } }, "defaultValue": null }, { "name": "companyContact", "description": "The attributes for the company contact.", "type": { "kind": "INPUT_OBJECT", "name": "CompanyContactInput", "ofType": null }, "defaultValue": null }, { "name": "companyLocation", "description": "The attributes for the company location.", "type": { "kind": "INPUT_OBJECT", "name": "CompanyLocationInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyCreatePayload", "description": "Return type for `companyCreate` mutation.", "fields": [ { "name": "company", "description": "The created company.", "args": [], "type": { "kind": "OBJECT", "name": "Company", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyDeletePayload", "description": "Return type for `companyDelete` mutation.", "fields": [ { "name": "deletedCompanyId", "description": "The ID of the deleted company.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyEdge", "description": "An auto-generated type which holds one Company and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CompanyEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyInput", "description": "The input fields for company attributes when creating or updating a company.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "A note about the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "externalId", "description": "A unique externally-supplied ID for the company.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "customerSince", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at\n which the company became the customer.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocation", "description": "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.", "fields": [ { "name": "billingAddress", "description": "The address used as billing address for the location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "buyerExperienceConfiguration", "description": "The configuration for the buyer's B2B checkout.", "args": [], "type": { "kind": "OBJECT", "name": "BuyerExperienceConfiguration", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogs", "description": "The list of catalogs associated with the company location.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogsCount", "description": "The number of catalogs associated with the company location.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The company that the company location belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currency", "description": "The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "The list of draft orders for the company location.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| customer_id |\n| source |\n| status |\n| tag |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "externalId", "description": "A unique externally-supplied ID for the company location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Whether the merchant added a timeline comment to the company location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inCatalog", "description": "Whether the company location is assigned a specific catalog.", "args": [ { "name": "catalogId", "description": "The ID of the catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "The preferred locale of the company location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the company location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "A note about the company location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCount", "description": "The total number of orders placed for the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `ordersCount` instead." }, { "name": "orders", "description": "The list of orders for the company location.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ordersCount", "description": "The total number of orders placed for the location.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number of the company location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "roleAssignments", "description": "The list of roles assigned to the company location.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyContactRoleAssignmentSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_contact_id |\n| company_contact_role_id |\n| company_id |\n| company_location_id |\n| created_at |\n| location_name |\n| role_name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingAddress", "description": "The address used as shipping address for the location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxExemptions", "description": "The list of tax exemptions applied to the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxRegistrationId", "description": "The tax registration ID for the company location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSpent", "description": "The total amount spent by the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationAssignAddressPayload", "description": "Return type for `companyLocationAssignAddress` mutation.", "fields": [ { "name": "addresses", "description": "The list of updated addresses on the company location.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyAddress", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationAssignRolesPayload", "description": "Return type for `companyLocationAssignRoles` mutation.", "fields": [ { "name": "roleAssignments", "description": "A list of newly created assignments of company contacts to a company location.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationAssignTaxExemptionsPayload", "description": "Return type for `companyLocationAssignTaxExemptions` mutation.", "fields": [ { "name": "companyLocation", "description": "The updated company location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationCatalog", "description": "A list of products with publishing and pricing information associated with company locations.\n", "fields": [ { "name": "companyLocations", "description": "The company locations associated with the catalog.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyLocationSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_id |\n| created_at |\n| external_id |\n| ids |\n| name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationsCount", "description": "The number of company locations associated with the catalog.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "operations", "description": "Most recent catalog operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list associated with the catalog.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "A group of products and collections that's published to a catalog.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationConnection", "description": "An auto-generated type for paginating through multiple CompanyLocations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CompanyLocationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationCreatePayload", "description": "Return type for `companyLocationCreate` mutation.", "fields": [ { "name": "companyLocation", "description": "The created company location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationCreateTaxRegistrationPayload", "description": "Return type for `companyLocationCreateTaxRegistration` mutation.", "fields": [ { "name": "companyLocation", "description": "The company location with the created tax registration.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationDeletePayload", "description": "Return type for `companyLocationDelete` mutation.", "fields": [ { "name": "deletedCompanyLocationId", "description": "The ID of the deleted company location.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationEdge", "description": "An auto-generated type which holds one CompanyLocation and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CompanyLocationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyLocationInput", "description": "The input fields for company location when creating or updating a company location.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locale", "description": "The preferred locale of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "externalId", "description": "A unique externally-supplied ID for the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "A note about the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "buyerExperienceConfiguration", "description": "The configuration for the buyer's checkout at the company location.", "type": { "kind": "INPUT_OBJECT", "name": "BuyerExperienceConfigurationInput", "ofType": null }, "defaultValue": null }, { "name": "billingAddress", "description": "The input fields to create or update the billing address for a company location.", "type": { "kind": "INPUT_OBJECT", "name": "CompanyAddressInput", "ofType": null }, "defaultValue": null }, { "name": "shippingAddress", "description": "The input fields to create or update the shipping address for a company location.", "type": { "kind": "INPUT_OBJECT", "name": "CompanyAddressInput", "ofType": null }, "defaultValue": null }, { "name": "billingSameAsShipping", "description": "Whether the billing address is the same as the shipping address. If the value is true, then the input for `billingAddress` is ignored.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "taxRegistrationId", "description": "The tax registration ID of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxExemptions", "description": "The list of tax exemptions to apply to the company location.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationRevokeRolesPayload", "description": "Return type for `companyLocationRevokeRoles` mutation.", "fields": [ { "name": "revokedRoleAssignmentIds", "description": "A list of role assignment IDs that were removed from the company location.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationRevokeTaxExemptionsPayload", "description": "Return type for `companyLocationRevokeTaxExemptions` mutation.", "fields": [ { "name": "companyLocation", "description": "The updated company location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationRevokeTaxRegistrationPayload", "description": "Return type for `companyLocationRevokeTaxRegistration` mutation.", "fields": [ { "name": "companyLocation", "description": "The updated company location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyLocationRoleAssign", "description": "The input fields for the role and contact to assign on a location.\n", "fields": null, "inputFields": [ { "name": "companyContactRoleId", "description": "The role ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyContactId", "description": "The company contact ID..", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanyLocationSortKeys", "description": "The set of valid sort keys for the CompanyLocation query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_ID", "description": "Sort by the `company_id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_AND_LOCATION_NAME", "description": "Sort by the `company_and_location_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CompanyLocationUpdateInput", "description": "The input fields for company location when creating or updating a company location.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locale", "description": "The preferred locale of the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "externalId", "description": "A unique externally-supplied ID for the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "A note about the company location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "buyerExperienceConfiguration", "description": "The configuration for the buyer's checkout at the company location.", "type": { "kind": "INPUT_OBJECT", "name": "BuyerExperienceConfigurationInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationUpdatePayload", "description": "Return type for `companyLocationUpdate` mutation.", "fields": [ { "name": "companyLocation", "description": "The updated company location.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyLocationsDeletePayload", "description": "Return type for `companyLocationsDelete` mutation.", "fields": [ { "name": "deletedCompanyLocationIds", "description": "A list of IDs of the deleted company locations.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyRevokeMainContactPayload", "description": "Return type for `companyRevokeMainContact` mutation.", "fields": [ { "name": "company", "description": "The company from which the main contact is revoked.", "args": [], "type": { "kind": "OBJECT", "name": "Company", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CompanySortKeys", "description": "The set of valid sort keys for the Company query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "SINCE_DATE", "description": "Sort by the `since_date` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_COUNT", "description": "Sort by the `order_count` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_SPENT", "description": "Sort by the `total_spent` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CompanyUpdatePayload", "description": "Return type for `companyUpdate` mutation.", "fields": [ { "name": "company", "description": "The updated company.", "args": [], "type": { "kind": "OBJECT", "name": "Company", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ContextualPricingContext", "description": "The input fields for the context data that determines the pricing of a variant. Refer to [Product](https://shopify.dev/docs/api/admin-graphql/latest/queries/product?example=Get+the+price+range+for+a+product+for+buyers+from+Canada)for more information on how to use this input object.", "fields": null, "inputFields": [ { "name": "country", "description": "The country code used to fetch country-specific prices.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "companyLocationId", "description": "The CompanyLocation ID used to fetch company location specific prices.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ContextualPublicationContext", "description": "The context data that determines the publication status of a product.", "fields": null, "inputFields": [ { "name": "country", "description": "The country code used to fetch country-specific publication.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "companyLocationId", "description": "The company location ID used to fetch company-specific publication.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Count", "description": "Details for count of elements.", "fields": [ { "name": "count", "description": "Count of elements.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "precision", "description": "Precision of count, how exact is the value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountPrecision", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CountPrecision", "description": "The precision of the value returned by a count field.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EXACT", "description": "The count is exactly the value.", "isDeprecated": false, "deprecationReason": null }, { "name": "AT_LEAST", "description": "The count is at least the value. A limit was imposed and reached.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CountriesInShippingZones", "description": "The list of all the countries from the combined shipping zones for the shop.", "fields": [ { "name": "countryCodes", "description": "The list of all the countries from all the combined shipping zones.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "includeRestOfWorld", "description": "Whether 'Rest of World' has been defined in any of the shipping zones.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CountryCode", "description": "The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.\nIf a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision\nof another country. For example, the territories associated with Spain are represented by the country code `ES`,\nand the territories associated with the United States of America are represented by the country code `US`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AF", "description": "Afghanistan.", "isDeprecated": false, "deprecationReason": null }, { "name": "AX", "description": "Åland Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "AL", "description": "Albania.", "isDeprecated": false, "deprecationReason": null }, { "name": "DZ", "description": "Algeria.", "isDeprecated": false, "deprecationReason": null }, { "name": "AD", "description": "Andorra.", "isDeprecated": false, "deprecationReason": null }, { "name": "AO", "description": "Angola.", "isDeprecated": false, "deprecationReason": null }, { "name": "AI", "description": "Anguilla.", "isDeprecated": false, "deprecationReason": null }, { "name": "AG", "description": "Antigua & Barbuda.", "isDeprecated": false, "deprecationReason": null }, { "name": "AR", "description": "Argentina.", "isDeprecated": false, "deprecationReason": null }, { "name": "AM", "description": "Armenia.", "isDeprecated": false, "deprecationReason": null }, { "name": "AW", "description": "Aruba.", "isDeprecated": false, "deprecationReason": null }, { "name": "AC", "description": "Ascension Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "AU", "description": "Australia.", "isDeprecated": false, "deprecationReason": null }, { "name": "AT", "description": "Austria.", "isDeprecated": false, "deprecationReason": null }, { "name": "AZ", "description": "Azerbaijan.", "isDeprecated": false, "deprecationReason": null }, { "name": "BS", "description": "Bahamas.", "isDeprecated": false, "deprecationReason": null }, { "name": "BH", "description": "Bahrain.", "isDeprecated": false, "deprecationReason": null }, { "name": "BD", "description": "Bangladesh.", "isDeprecated": false, "deprecationReason": null }, { "name": "BB", "description": "Barbados.", "isDeprecated": false, "deprecationReason": null }, { "name": "BY", "description": "Belarus.", "isDeprecated": false, "deprecationReason": null }, { "name": "BE", "description": "Belgium.", "isDeprecated": false, "deprecationReason": null }, { "name": "BZ", "description": "Belize.", "isDeprecated": false, "deprecationReason": null }, { "name": "BJ", "description": "Benin.", "isDeprecated": false, "deprecationReason": null }, { "name": "BM", "description": "Bermuda.", "isDeprecated": false, "deprecationReason": null }, { "name": "BT", "description": "Bhutan.", "isDeprecated": false, "deprecationReason": null }, { "name": "BO", "description": "Bolivia.", "isDeprecated": false, "deprecationReason": null }, { "name": "BA", "description": "Bosnia & Herzegovina.", "isDeprecated": false, "deprecationReason": null }, { "name": "BW", "description": "Botswana.", "isDeprecated": false, "deprecationReason": null }, { "name": "BV", "description": "Bouvet Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "BR", "description": "Brazil.", "isDeprecated": false, "deprecationReason": null }, { "name": "IO", "description": "British Indian Ocean Territory.", "isDeprecated": false, "deprecationReason": null }, { "name": "BN", "description": "Brunei.", "isDeprecated": false, "deprecationReason": null }, { "name": "BG", "description": "Bulgaria.", "isDeprecated": false, "deprecationReason": null }, { "name": "BF", "description": "Burkina Faso.", "isDeprecated": false, "deprecationReason": null }, { "name": "BI", "description": "Burundi.", "isDeprecated": false, "deprecationReason": null }, { "name": "KH", "description": "Cambodia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA", "description": "Canada.", "isDeprecated": false, "deprecationReason": null }, { "name": "CV", "description": "Cape Verde.", "isDeprecated": false, "deprecationReason": null }, { "name": "BQ", "description": "Caribbean Netherlands.", "isDeprecated": false, "deprecationReason": null }, { "name": "KY", "description": "Cayman Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "CF", "description": "Central African Republic.", "isDeprecated": false, "deprecationReason": null }, { "name": "TD", "description": "Chad.", "isDeprecated": false, "deprecationReason": null }, { "name": "CL", "description": "Chile.", "isDeprecated": false, "deprecationReason": null }, { "name": "CN", "description": "China.", "isDeprecated": false, "deprecationReason": null }, { "name": "CX", "description": "Christmas Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "CC", "description": "Cocos (Keeling) Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "CO", "description": "Colombia.", "isDeprecated": false, "deprecationReason": null }, { "name": "KM", "description": "Comoros.", "isDeprecated": false, "deprecationReason": null }, { "name": "CG", "description": "Congo - Brazzaville.", "isDeprecated": false, "deprecationReason": null }, { "name": "CD", "description": "Congo - Kinshasa.", "isDeprecated": false, "deprecationReason": null }, { "name": "CK", "description": "Cook Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "CR", "description": "Costa Rica.", "isDeprecated": false, "deprecationReason": null }, { "name": "HR", "description": "Croatia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CU", "description": "Cuba.", "isDeprecated": false, "deprecationReason": null }, { "name": "CW", "description": "Curaçao.", "isDeprecated": false, "deprecationReason": null }, { "name": "CY", "description": "Cyprus.", "isDeprecated": false, "deprecationReason": null }, { "name": "CZ", "description": "Czechia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CI", "description": "Côte d’Ivoire.", "isDeprecated": false, "deprecationReason": null }, { "name": "DK", "description": "Denmark.", "isDeprecated": false, "deprecationReason": null }, { "name": "DJ", "description": "Djibouti.", "isDeprecated": false, "deprecationReason": null }, { "name": "DM", "description": "Dominica.", "isDeprecated": false, "deprecationReason": null }, { "name": "DO", "description": "Dominican Republic.", "isDeprecated": false, "deprecationReason": null }, { "name": "EC", "description": "Ecuador.", "isDeprecated": false, "deprecationReason": null }, { "name": "EG", "description": "Egypt.", "isDeprecated": false, "deprecationReason": null }, { "name": "SV", "description": "El Salvador.", "isDeprecated": false, "deprecationReason": null }, { "name": "GQ", "description": "Equatorial Guinea.", "isDeprecated": false, "deprecationReason": null }, { "name": "ER", "description": "Eritrea.", "isDeprecated": false, "deprecationReason": null }, { "name": "EE", "description": "Estonia.", "isDeprecated": false, "deprecationReason": null }, { "name": "SZ", "description": "Eswatini.", "isDeprecated": false, "deprecationReason": null }, { "name": "ET", "description": "Ethiopia.", "isDeprecated": false, "deprecationReason": null }, { "name": "FK", "description": "Falkland Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "FO", "description": "Faroe Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "FJ", "description": "Fiji.", "isDeprecated": false, "deprecationReason": null }, { "name": "FI", "description": "Finland.", "isDeprecated": false, "deprecationReason": null }, { "name": "FR", "description": "France.", "isDeprecated": false, "deprecationReason": null }, { "name": "GF", "description": "French Guiana.", "isDeprecated": false, "deprecationReason": null }, { "name": "PF", "description": "French Polynesia.", "isDeprecated": false, "deprecationReason": null }, { "name": "TF", "description": "French Southern Territories.", "isDeprecated": false, "deprecationReason": null }, { "name": "GA", "description": "Gabon.", "isDeprecated": false, "deprecationReason": null }, { "name": "GM", "description": "Gambia.", "isDeprecated": false, "deprecationReason": null }, { "name": "GE", "description": "Georgia.", "isDeprecated": false, "deprecationReason": null }, { "name": "DE", "description": "Germany.", "isDeprecated": false, "deprecationReason": null }, { "name": "GH", "description": "Ghana.", "isDeprecated": false, "deprecationReason": null }, { "name": "GI", "description": "Gibraltar.", "isDeprecated": false, "deprecationReason": null }, { "name": "GR", "description": "Greece.", "isDeprecated": false, "deprecationReason": null }, { "name": "GL", "description": "Greenland.", "isDeprecated": false, "deprecationReason": null }, { "name": "GD", "description": "Grenada.", "isDeprecated": false, "deprecationReason": null }, { "name": "GP", "description": "Guadeloupe.", "isDeprecated": false, "deprecationReason": null }, { "name": "GT", "description": "Guatemala.", "isDeprecated": false, "deprecationReason": null }, { "name": "GG", "description": "Guernsey.", "isDeprecated": false, "deprecationReason": null }, { "name": "GN", "description": "Guinea.", "isDeprecated": false, "deprecationReason": null }, { "name": "GW", "description": "Guinea-Bissau.", "isDeprecated": false, "deprecationReason": null }, { "name": "GY", "description": "Guyana.", "isDeprecated": false, "deprecationReason": null }, { "name": "HT", "description": "Haiti.", "isDeprecated": false, "deprecationReason": null }, { "name": "HM", "description": "Heard & McDonald Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "VA", "description": "Vatican City.", "isDeprecated": false, "deprecationReason": null }, { "name": "HN", "description": "Honduras.", "isDeprecated": false, "deprecationReason": null }, { "name": "HK", "description": "Hong Kong SAR.", "isDeprecated": false, "deprecationReason": null }, { "name": "HU", "description": "Hungary.", "isDeprecated": false, "deprecationReason": null }, { "name": "IS", "description": "Iceland.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN", "description": "India.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Indonesia.", "isDeprecated": false, "deprecationReason": null }, { "name": "IR", "description": "Iran.", "isDeprecated": false, "deprecationReason": null }, { "name": "IQ", "description": "Iraq.", "isDeprecated": false, "deprecationReason": null }, { "name": "IE", "description": "Ireland.", "isDeprecated": false, "deprecationReason": null }, { "name": "IM", "description": "Isle of Man.", "isDeprecated": false, "deprecationReason": null }, { "name": "IL", "description": "Israel.", "isDeprecated": false, "deprecationReason": null }, { "name": "IT", "description": "Italy.", "isDeprecated": false, "deprecationReason": null }, { "name": "JM", "description": "Jamaica.", "isDeprecated": false, "deprecationReason": null }, { "name": "JP", "description": "Japan.", "isDeprecated": false, "deprecationReason": null }, { "name": "JE", "description": "Jersey.", "isDeprecated": false, "deprecationReason": null }, { "name": "JO", "description": "Jordan.", "isDeprecated": false, "deprecationReason": null }, { "name": "KZ", "description": "Kazakhstan.", "isDeprecated": false, "deprecationReason": null }, { "name": "KE", "description": "Kenya.", "isDeprecated": false, "deprecationReason": null }, { "name": "KI", "description": "Kiribati.", "isDeprecated": false, "deprecationReason": null }, { "name": "KP", "description": "North Korea.", "isDeprecated": false, "deprecationReason": null }, { "name": "XK", "description": "Kosovo.", "isDeprecated": false, "deprecationReason": null }, { "name": "KW", "description": "Kuwait.", "isDeprecated": false, "deprecationReason": null }, { "name": "KG", "description": "Kyrgyzstan.", "isDeprecated": false, "deprecationReason": null }, { "name": "LA", "description": "Laos.", "isDeprecated": false, "deprecationReason": null }, { "name": "LV", "description": "Latvia.", "isDeprecated": false, "deprecationReason": null }, { "name": "LB", "description": "Lebanon.", "isDeprecated": false, "deprecationReason": null }, { "name": "LS", "description": "Lesotho.", "isDeprecated": false, "deprecationReason": null }, { "name": "LR", "description": "Liberia.", "isDeprecated": false, "deprecationReason": null }, { "name": "LY", "description": "Libya.", "isDeprecated": false, "deprecationReason": null }, { "name": "LI", "description": "Liechtenstein.", "isDeprecated": false, "deprecationReason": null }, { "name": "LT", "description": "Lithuania.", "isDeprecated": false, "deprecationReason": null }, { "name": "LU", "description": "Luxembourg.", "isDeprecated": false, "deprecationReason": null }, { "name": "MO", "description": "Macao SAR.", "isDeprecated": false, "deprecationReason": null }, { "name": "MG", "description": "Madagascar.", "isDeprecated": false, "deprecationReason": null }, { "name": "MW", "description": "Malawi.", "isDeprecated": false, "deprecationReason": null }, { "name": "MY", "description": "Malaysia.", "isDeprecated": false, "deprecationReason": null }, { "name": "MV", "description": "Maldives.", "isDeprecated": false, "deprecationReason": null }, { "name": "ML", "description": "Mali.", "isDeprecated": false, "deprecationReason": null }, { "name": "MT", "description": "Malta.", "isDeprecated": false, "deprecationReason": null }, { "name": "MQ", "description": "Martinique.", "isDeprecated": false, "deprecationReason": null }, { "name": "MR", "description": "Mauritania.", "isDeprecated": false, "deprecationReason": null }, { "name": "MU", "description": "Mauritius.", "isDeprecated": false, "deprecationReason": null }, { "name": "YT", "description": "Mayotte.", "isDeprecated": false, "deprecationReason": null }, { "name": "MX", "description": "Mexico.", "isDeprecated": false, "deprecationReason": null }, { "name": "MD", "description": "Moldova.", "isDeprecated": false, "deprecationReason": null }, { "name": "MC", "description": "Monaco.", "isDeprecated": false, "deprecationReason": null }, { "name": "MN", "description": "Mongolia.", "isDeprecated": false, "deprecationReason": null }, { "name": "ME", "description": "Montenegro.", "isDeprecated": false, "deprecationReason": null }, { "name": "MS", "description": "Montserrat.", "isDeprecated": false, "deprecationReason": null }, { "name": "MA", "description": "Morocco.", "isDeprecated": false, "deprecationReason": null }, { "name": "MZ", "description": "Mozambique.", "isDeprecated": false, "deprecationReason": null }, { "name": "MM", "description": "Myanmar (Burma).", "isDeprecated": false, "deprecationReason": null }, { "name": "NA", "description": "Namibia.", "isDeprecated": false, "deprecationReason": null }, { "name": "NR", "description": "Nauru.", "isDeprecated": false, "deprecationReason": null }, { "name": "NP", "description": "Nepal.", "isDeprecated": false, "deprecationReason": null }, { "name": "NL", "description": "Netherlands.", "isDeprecated": false, "deprecationReason": null }, { "name": "AN", "description": "Netherlands Antilles.", "isDeprecated": false, "deprecationReason": null }, { "name": "NC", "description": "New Caledonia.", "isDeprecated": false, "deprecationReason": null }, { "name": "NZ", "description": "New Zealand.", "isDeprecated": false, "deprecationReason": null }, { "name": "NI", "description": "Nicaragua.", "isDeprecated": false, "deprecationReason": null }, { "name": "NE", "description": "Niger.", "isDeprecated": false, "deprecationReason": null }, { "name": "NG", "description": "Nigeria.", "isDeprecated": false, "deprecationReason": null }, { "name": "NU", "description": "Niue.", "isDeprecated": false, "deprecationReason": null }, { "name": "NF", "description": "Norfolk Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "MK", "description": "North Macedonia.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO", "description": "Norway.", "isDeprecated": false, "deprecationReason": null }, { "name": "OM", "description": "Oman.", "isDeprecated": false, "deprecationReason": null }, { "name": "PK", "description": "Pakistan.", "isDeprecated": false, "deprecationReason": null }, { "name": "PS", "description": "Palestinian Territories.", "isDeprecated": false, "deprecationReason": null }, { "name": "PA", "description": "Panama.", "isDeprecated": false, "deprecationReason": null }, { "name": "PG", "description": "Papua New Guinea.", "isDeprecated": false, "deprecationReason": null }, { "name": "PY", "description": "Paraguay.", "isDeprecated": false, "deprecationReason": null }, { "name": "PE", "description": "Peru.", "isDeprecated": false, "deprecationReason": null }, { "name": "PH", "description": "Philippines.", "isDeprecated": false, "deprecationReason": null }, { "name": "PN", "description": "Pitcairn Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "PL", "description": "Poland.", "isDeprecated": false, "deprecationReason": null }, { "name": "PT", "description": "Portugal.", "isDeprecated": false, "deprecationReason": null }, { "name": "QA", "description": "Qatar.", "isDeprecated": false, "deprecationReason": null }, { "name": "CM", "description": "Cameroon.", "isDeprecated": false, "deprecationReason": null }, { "name": "RE", "description": "Réunion.", "isDeprecated": false, "deprecationReason": null }, { "name": "RO", "description": "Romania.", "isDeprecated": false, "deprecationReason": null }, { "name": "RU", "description": "Russia.", "isDeprecated": false, "deprecationReason": null }, { "name": "RW", "description": "Rwanda.", "isDeprecated": false, "deprecationReason": null }, { "name": "BL", "description": "St. Barthélemy.", "isDeprecated": false, "deprecationReason": null }, { "name": "SH", "description": "St. Helena.", "isDeprecated": false, "deprecationReason": null }, { "name": "KN", "description": "St. Kitts & Nevis.", "isDeprecated": false, "deprecationReason": null }, { "name": "LC", "description": "St. Lucia.", "isDeprecated": false, "deprecationReason": null }, { "name": "MF", "description": "St. Martin.", "isDeprecated": false, "deprecationReason": null }, { "name": "PM", "description": "St. Pierre & Miquelon.", "isDeprecated": false, "deprecationReason": null }, { "name": "WS", "description": "Samoa.", "isDeprecated": false, "deprecationReason": null }, { "name": "SM", "description": "San Marino.", "isDeprecated": false, "deprecationReason": null }, { "name": "ST", "description": "São Tomé & Príncipe.", "isDeprecated": false, "deprecationReason": null }, { "name": "SA", "description": "Saudi Arabia.", "isDeprecated": false, "deprecationReason": null }, { "name": "SN", "description": "Senegal.", "isDeprecated": false, "deprecationReason": null }, { "name": "RS", "description": "Serbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "SC", "description": "Seychelles.", "isDeprecated": false, "deprecationReason": null }, { "name": "SL", "description": "Sierra Leone.", "isDeprecated": false, "deprecationReason": null }, { "name": "SG", "description": "Singapore.", "isDeprecated": false, "deprecationReason": null }, { "name": "SX", "description": "Sint Maarten.", "isDeprecated": false, "deprecationReason": null }, { "name": "SK", "description": "Slovakia.", "isDeprecated": false, "deprecationReason": null }, { "name": "SI", "description": "Slovenia.", "isDeprecated": false, "deprecationReason": null }, { "name": "SB", "description": "Solomon Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "SO", "description": "Somalia.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZA", "description": "South Africa.", "isDeprecated": false, "deprecationReason": null }, { "name": "GS", "description": "South Georgia & South Sandwich Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "KR", "description": "South Korea.", "isDeprecated": false, "deprecationReason": null }, { "name": "SS", "description": "South Sudan.", "isDeprecated": false, "deprecationReason": null }, { "name": "ES", "description": "Spain.", "isDeprecated": false, "deprecationReason": null }, { "name": "LK", "description": "Sri Lanka.", "isDeprecated": false, "deprecationReason": null }, { "name": "VC", "description": "St. Vincent & Grenadines.", "isDeprecated": false, "deprecationReason": null }, { "name": "SD", "description": "Sudan.", "isDeprecated": false, "deprecationReason": null }, { "name": "SR", "description": "Suriname.", "isDeprecated": false, "deprecationReason": null }, { "name": "SJ", "description": "Svalbard & Jan Mayen.", "isDeprecated": false, "deprecationReason": null }, { "name": "SE", "description": "Sweden.", "isDeprecated": false, "deprecationReason": null }, { "name": "CH", "description": "Switzerland.", "isDeprecated": false, "deprecationReason": null }, { "name": "SY", "description": "Syria.", "isDeprecated": false, "deprecationReason": null }, { "name": "TW", "description": "Taiwan.", "isDeprecated": false, "deprecationReason": null }, { "name": "TJ", "description": "Tajikistan.", "isDeprecated": false, "deprecationReason": null }, { "name": "TZ", "description": "Tanzania.", "isDeprecated": false, "deprecationReason": null }, { "name": "TH", "description": "Thailand.", "isDeprecated": false, "deprecationReason": null }, { "name": "TL", "description": "Timor-Leste.", "isDeprecated": false, "deprecationReason": null }, { "name": "TG", "description": "Togo.", "isDeprecated": false, "deprecationReason": null }, { "name": "TK", "description": "Tokelau.", "isDeprecated": false, "deprecationReason": null }, { "name": "TO", "description": "Tonga.", "isDeprecated": false, "deprecationReason": null }, { "name": "TT", "description": "Trinidad & Tobago.", "isDeprecated": false, "deprecationReason": null }, { "name": "TA", "description": "Tristan da Cunha.", "isDeprecated": false, "deprecationReason": null }, { "name": "TN", "description": "Tunisia.", "isDeprecated": false, "deprecationReason": null }, { "name": "TR", "description": "Türkiye.", "isDeprecated": false, "deprecationReason": null }, { "name": "TM", "description": "Turkmenistan.", "isDeprecated": false, "deprecationReason": null }, { "name": "TC", "description": "Turks & Caicos Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "TV", "description": "Tuvalu.", "isDeprecated": false, "deprecationReason": null }, { "name": "UG", "description": "Uganda.", "isDeprecated": false, "deprecationReason": null }, { "name": "UA", "description": "Ukraine.", "isDeprecated": false, "deprecationReason": null }, { "name": "AE", "description": "United Arab Emirates.", "isDeprecated": false, "deprecationReason": null }, { "name": "GB", "description": "United Kingdom.", "isDeprecated": false, "deprecationReason": null }, { "name": "US", "description": "United States.", "isDeprecated": false, "deprecationReason": null }, { "name": "UM", "description": "U.S. Outlying Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "UY", "description": "Uruguay.", "isDeprecated": false, "deprecationReason": null }, { "name": "UZ", "description": "Uzbekistan.", "isDeprecated": false, "deprecationReason": null }, { "name": "VU", "description": "Vanuatu.", "isDeprecated": false, "deprecationReason": null }, { "name": "VE", "description": "Venezuela.", "isDeprecated": false, "deprecationReason": null }, { "name": "VN", "description": "Vietnam.", "isDeprecated": false, "deprecationReason": null }, { "name": "VG", "description": "British Virgin Islands.", "isDeprecated": false, "deprecationReason": null }, { "name": "WF", "description": "Wallis & Futuna.", "isDeprecated": false, "deprecationReason": null }, { "name": "EH", "description": "Western Sahara.", "isDeprecated": false, "deprecationReason": null }, { "name": "YE", "description": "Yemen.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZM", "description": "Zambia.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZW", "description": "Zimbabwe.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZZ", "description": "Unknown Region.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CountryHarmonizedSystemCode", "description": "The country-specific harmonized system code and ISO country code for an inventory item.\n", "fields": [ { "name": "countryCode", "description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "harmonizedSystemCode", "description": "The country-specific harmonized system code. These are usually longer than 6 digits.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CountryHarmonizedSystemCodeConnection", "description": "An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CountryHarmonizedSystemCodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CountryHarmonizedSystemCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CountryHarmonizedSystemCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CountryHarmonizedSystemCodeEdge", "description": "An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CountryHarmonizedSystemCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CountryHarmonizedSystemCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CountryHarmonizedSystemCodeInput", "description": "The input fields required to specify a harmonized system code.\n", "fields": null, "inputFields": [ { "name": "harmonizedSystemCode", "description": "Country specific harmonized system code.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "countryCode", "description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "description": "The input fields required to create a media object.", "fields": null, "inputFields": [ { "name": "originalSource", "description": "The original source of the media object. This might be an external URL or a staged upload URL.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "alt", "description": "The alt text associated with the media.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "mediaContentType", "description": "The media content type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CropRegion", "description": "The part of the image that should remain after cropping.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CENTER", "description": "Keep the center of the image.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOP", "description": "Keep the top of the image.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOTTOM", "description": "Keep the bottom of the image.", "isDeprecated": false, "deprecationReason": null }, { "name": "LEFT", "description": "Keep the left of the image.", "isDeprecated": false, "deprecationReason": null }, { "name": "RIGHT", "description": "Keep the right of the image.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CurrencyCode", "description": "The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,\nand non-standard codes.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "USD", "description": "United States Dollars (USD).", "isDeprecated": false, "deprecationReason": null }, { "name": "EUR", "description": "Euro (EUR).", "isDeprecated": false, "deprecationReason": null }, { "name": "GBP", "description": "United Kingdom Pounds (GBP).", "isDeprecated": false, "deprecationReason": null }, { "name": "CAD", "description": "Canadian Dollars (CAD).", "isDeprecated": false, "deprecationReason": null }, { "name": "AFN", "description": "Afghan Afghani (AFN).", "isDeprecated": false, "deprecationReason": null }, { "name": "ALL", "description": "Albanian Lek (ALL).", "isDeprecated": false, "deprecationReason": null }, { "name": "DZD", "description": "Algerian Dinar (DZD).", "isDeprecated": false, "deprecationReason": null }, { "name": "AOA", "description": "Angolan Kwanza (AOA).", "isDeprecated": false, "deprecationReason": null }, { "name": "ARS", "description": "Argentine Pesos (ARS).", "isDeprecated": false, "deprecationReason": null }, { "name": "AMD", "description": "Armenian Dram (AMD).", "isDeprecated": false, "deprecationReason": null }, { "name": "AWG", "description": "Aruban Florin (AWG).", "isDeprecated": false, "deprecationReason": null }, { "name": "AUD", "description": "Australian Dollars (AUD).", "isDeprecated": false, "deprecationReason": null }, { "name": "BBD", "description": "Barbadian Dollar (BBD).", "isDeprecated": false, "deprecationReason": null }, { "name": "AZN", "description": "Azerbaijani Manat (AZN).", "isDeprecated": false, "deprecationReason": null }, { "name": "BDT", "description": "Bangladesh Taka (BDT).", "isDeprecated": false, "deprecationReason": null }, { "name": "BSD", "description": "Bahamian Dollar (BSD).", "isDeprecated": false, "deprecationReason": null }, { "name": "BHD", "description": "Bahraini Dinar (BHD).", "isDeprecated": false, "deprecationReason": null }, { "name": "BIF", "description": "Burundian Franc (BIF).", "isDeprecated": false, "deprecationReason": null }, { "name": "BYN", "description": "Belarusian Ruble (BYN).", "isDeprecated": false, "deprecationReason": null }, { "name": "BZD", "description": "Belize Dollar (BZD).", "isDeprecated": false, "deprecationReason": null }, { "name": "BMD", "description": "Bermudian Dollar (BMD).", "isDeprecated": false, "deprecationReason": null }, { "name": "BTN", "description": "Bhutanese Ngultrum (BTN).", "isDeprecated": false, "deprecationReason": null }, { "name": "BAM", "description": "Bosnia and Herzegovina Convertible Mark (BAM).", "isDeprecated": false, "deprecationReason": null }, { "name": "BRL", "description": "Brazilian Real (BRL).", "isDeprecated": false, "deprecationReason": null }, { "name": "BOB", "description": "Bolivian Boliviano (BOB).", "isDeprecated": false, "deprecationReason": null }, { "name": "BWP", "description": "Botswana Pula (BWP).", "isDeprecated": false, "deprecationReason": null }, { "name": "BND", "description": "Brunei Dollar (BND).", "isDeprecated": false, "deprecationReason": null }, { "name": "BGN", "description": "Bulgarian Lev (BGN).", "isDeprecated": false, "deprecationReason": null }, { "name": "MMK", "description": "Burmese Kyat (MMK).", "isDeprecated": false, "deprecationReason": null }, { "name": "KHR", "description": "Cambodian Riel.", "isDeprecated": false, "deprecationReason": null }, { "name": "CVE", "description": "Cape Verdean escudo (CVE).", "isDeprecated": false, "deprecationReason": null }, { "name": "KYD", "description": "Cayman Dollars (KYD).", "isDeprecated": false, "deprecationReason": null }, { "name": "XAF", "description": "Central African CFA Franc (XAF).", "isDeprecated": false, "deprecationReason": null }, { "name": "CLP", "description": "Chilean Peso (CLP).", "isDeprecated": false, "deprecationReason": null }, { "name": "CNY", "description": "Chinese Yuan Renminbi (CNY).", "isDeprecated": false, "deprecationReason": null }, { "name": "COP", "description": "Colombian Peso (COP).", "isDeprecated": false, "deprecationReason": null }, { "name": "KMF", "description": "Comorian Franc (KMF).", "isDeprecated": false, "deprecationReason": null }, { "name": "CDF", "description": "Congolese franc (CDF).", "isDeprecated": false, "deprecationReason": null }, { "name": "CRC", "description": "Costa Rican Colones (CRC).", "isDeprecated": false, "deprecationReason": null }, { "name": "HRK", "description": "Croatian Kuna (HRK).", "isDeprecated": false, "deprecationReason": null }, { "name": "CZK", "description": "Czech Koruny (CZK).", "isDeprecated": false, "deprecationReason": null }, { "name": "DKK", "description": "Danish Kroner (DKK).", "isDeprecated": false, "deprecationReason": null }, { "name": "DJF", "description": "Djiboutian Franc (DJF).", "isDeprecated": false, "deprecationReason": null }, { "name": "DOP", "description": "Dominican Peso (DOP).", "isDeprecated": false, "deprecationReason": null }, { "name": "XCD", "description": "East Caribbean Dollar (XCD).", "isDeprecated": false, "deprecationReason": null }, { "name": "EGP", "description": "Egyptian Pound (EGP).", "isDeprecated": false, "deprecationReason": null }, { "name": "ERN", "description": "Eritrean Nakfa (ERN).", "isDeprecated": false, "deprecationReason": null }, { "name": "ETB", "description": "Ethiopian Birr (ETB).", "isDeprecated": false, "deprecationReason": null }, { "name": "FKP", "description": "Falkland Islands Pounds (FKP).", "isDeprecated": false, "deprecationReason": null }, { "name": "XPF", "description": "CFP Franc (XPF).", "isDeprecated": false, "deprecationReason": null }, { "name": "FJD", "description": "Fijian Dollars (FJD).", "isDeprecated": false, "deprecationReason": null }, { "name": "GIP", "description": "Gibraltar Pounds (GIP).", "isDeprecated": false, "deprecationReason": null }, { "name": "GMD", "description": "Gambian Dalasi (GMD).", "isDeprecated": false, "deprecationReason": null }, { "name": "GHS", "description": "Ghanaian Cedi (GHS).", "isDeprecated": false, "deprecationReason": null }, { "name": "GTQ", "description": "Guatemalan Quetzal (GTQ).", "isDeprecated": false, "deprecationReason": null }, { "name": "GYD", "description": "Guyanese Dollar (GYD).", "isDeprecated": false, "deprecationReason": null }, { "name": "GEL", "description": "Georgian Lari (GEL).", "isDeprecated": false, "deprecationReason": null }, { "name": "GNF", "description": "Guinean Franc (GNF).", "isDeprecated": false, "deprecationReason": null }, { "name": "HTG", "description": "Haitian Gourde (HTG).", "isDeprecated": false, "deprecationReason": null }, { "name": "HNL", "description": "Honduran Lempira (HNL).", "isDeprecated": false, "deprecationReason": null }, { "name": "HKD", "description": "Hong Kong Dollars (HKD).", "isDeprecated": false, "deprecationReason": null }, { "name": "HUF", "description": "Hungarian Forint (HUF).", "isDeprecated": false, "deprecationReason": null }, { "name": "ISK", "description": "Icelandic Kronur (ISK).", "isDeprecated": false, "deprecationReason": null }, { "name": "INR", "description": "Indian Rupees (INR).", "isDeprecated": false, "deprecationReason": null }, { "name": "IDR", "description": "Indonesian Rupiah (IDR).", "isDeprecated": false, "deprecationReason": null }, { "name": "ILS", "description": "Israeli New Shekel (NIS).", "isDeprecated": false, "deprecationReason": null }, { "name": "IRR", "description": "Iranian Rial (IRR).", "isDeprecated": false, "deprecationReason": null }, { "name": "IQD", "description": "Iraqi Dinar (IQD).", "isDeprecated": false, "deprecationReason": null }, { "name": "JMD", "description": "Jamaican Dollars (JMD).", "isDeprecated": false, "deprecationReason": null }, { "name": "JPY", "description": "Japanese Yen (JPY).", "isDeprecated": false, "deprecationReason": null }, { "name": "JEP", "description": "Jersey Pound.", "isDeprecated": false, "deprecationReason": null }, { "name": "JOD", "description": "Jordanian Dinar (JOD).", "isDeprecated": false, "deprecationReason": null }, { "name": "KZT", "description": "Kazakhstani Tenge (KZT).", "isDeprecated": false, "deprecationReason": null }, { "name": "KES", "description": "Kenyan Shilling (KES).", "isDeprecated": false, "deprecationReason": null }, { "name": "KID", "description": "Kiribati Dollar (KID).", "isDeprecated": false, "deprecationReason": null }, { "name": "KWD", "description": "Kuwaiti Dinar (KWD).", "isDeprecated": false, "deprecationReason": null }, { "name": "KGS", "description": "Kyrgyzstani Som (KGS).", "isDeprecated": false, "deprecationReason": null }, { "name": "LAK", "description": "Laotian Kip (LAK).", "isDeprecated": false, "deprecationReason": null }, { "name": "LVL", "description": "Latvian Lati (LVL).", "isDeprecated": false, "deprecationReason": null }, { "name": "LBP", "description": "Lebanese Pounds (LBP).", "isDeprecated": false, "deprecationReason": null }, { "name": "LSL", "description": "Lesotho Loti (LSL).", "isDeprecated": false, "deprecationReason": null }, { "name": "LRD", "description": "Liberian Dollar (LRD).", "isDeprecated": false, "deprecationReason": null }, { "name": "LYD", "description": "Libyan Dinar (LYD).", "isDeprecated": false, "deprecationReason": null }, { "name": "LTL", "description": "Lithuanian Litai (LTL).", "isDeprecated": false, "deprecationReason": null }, { "name": "MGA", "description": "Malagasy Ariary (MGA).", "isDeprecated": false, "deprecationReason": null }, { "name": "MKD", "description": "Macedonia Denar (MKD).", "isDeprecated": false, "deprecationReason": null }, { "name": "MOP", "description": "Macanese Pataca (MOP).", "isDeprecated": false, "deprecationReason": null }, { "name": "MWK", "description": "Malawian Kwacha (MWK).", "isDeprecated": false, "deprecationReason": null }, { "name": "MVR", "description": "Maldivian Rufiyaa (MVR).", "isDeprecated": false, "deprecationReason": null }, { "name": "MRU", "description": "Mauritanian Ouguiya (MRU).", "isDeprecated": false, "deprecationReason": null }, { "name": "MXN", "description": "Mexican Pesos (MXN).", "isDeprecated": false, "deprecationReason": null }, { "name": "MYR", "description": "Malaysian Ringgits (MYR).", "isDeprecated": false, "deprecationReason": null }, { "name": "MUR", "description": "Mauritian Rupee (MUR).", "isDeprecated": false, "deprecationReason": null }, { "name": "MDL", "description": "Moldovan Leu (MDL).", "isDeprecated": false, "deprecationReason": null }, { "name": "MAD", "description": "Moroccan Dirham.", "isDeprecated": false, "deprecationReason": null }, { "name": "MNT", "description": "Mongolian Tugrik.", "isDeprecated": false, "deprecationReason": null }, { "name": "MZN", "description": "Mozambican Metical.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAD", "description": "Namibian Dollar.", "isDeprecated": false, "deprecationReason": null }, { "name": "NPR", "description": "Nepalese Rupee (NPR).", "isDeprecated": false, "deprecationReason": null }, { "name": "ANG", "description": "Netherlands Antillean Guilder.", "isDeprecated": false, "deprecationReason": null }, { "name": "NZD", "description": "New Zealand Dollars (NZD).", "isDeprecated": false, "deprecationReason": null }, { "name": "NIO", "description": "Nicaraguan Córdoba (NIO).", "isDeprecated": false, "deprecationReason": null }, { "name": "NGN", "description": "Nigerian Naira (NGN).", "isDeprecated": false, "deprecationReason": null }, { "name": "NOK", "description": "Norwegian Kroner (NOK).", "isDeprecated": false, "deprecationReason": null }, { "name": "OMR", "description": "Omani Rial (OMR).", "isDeprecated": false, "deprecationReason": null }, { "name": "PAB", "description": "Panamian Balboa (PAB).", "isDeprecated": false, "deprecationReason": null }, { "name": "PKR", "description": "Pakistani Rupee (PKR).", "isDeprecated": false, "deprecationReason": null }, { "name": "PGK", "description": "Papua New Guinean Kina (PGK).", "isDeprecated": false, "deprecationReason": null }, { "name": "PYG", "description": "Paraguayan Guarani (PYG).", "isDeprecated": false, "deprecationReason": null }, { "name": "PEN", "description": "Peruvian Nuevo Sol (PEN).", "isDeprecated": false, "deprecationReason": null }, { "name": "PHP", "description": "Philippine Peso (PHP).", "isDeprecated": false, "deprecationReason": null }, { "name": "PLN", "description": "Polish Zlotych (PLN).", "isDeprecated": false, "deprecationReason": null }, { "name": "QAR", "description": "Qatari Rial (QAR).", "isDeprecated": false, "deprecationReason": null }, { "name": "RON", "description": "Romanian Lei (RON).", "isDeprecated": false, "deprecationReason": null }, { "name": "RUB", "description": "Russian Rubles (RUB).", "isDeprecated": false, "deprecationReason": null }, { "name": "RWF", "description": "Rwandan Franc (RWF).", "isDeprecated": false, "deprecationReason": null }, { "name": "WST", "description": "Samoan Tala (WST).", "isDeprecated": false, "deprecationReason": null }, { "name": "SHP", "description": "Saint Helena Pounds (SHP).", "isDeprecated": false, "deprecationReason": null }, { "name": "SAR", "description": "Saudi Riyal (SAR).", "isDeprecated": false, "deprecationReason": null }, { "name": "RSD", "description": "Serbian dinar (RSD).", "isDeprecated": false, "deprecationReason": null }, { "name": "SCR", "description": "Seychellois Rupee (SCR).", "isDeprecated": false, "deprecationReason": null }, { "name": "SLL", "description": "Sierra Leonean Leone (SLL).", "isDeprecated": false, "deprecationReason": null }, { "name": "SGD", "description": "Singapore Dollars (SGD).", "isDeprecated": false, "deprecationReason": null }, { "name": "SDG", "description": "Sudanese Pound (SDG).", "isDeprecated": false, "deprecationReason": null }, { "name": "SOS", "description": "Somali Shilling (SOS).", "isDeprecated": false, "deprecationReason": null }, { "name": "SYP", "description": "Syrian Pound (SYP).", "isDeprecated": false, "deprecationReason": null }, { "name": "ZAR", "description": "South African Rand (ZAR).", "isDeprecated": false, "deprecationReason": null }, { "name": "KRW", "description": "South Korean Won (KRW).", "isDeprecated": false, "deprecationReason": null }, { "name": "SSP", "description": "South Sudanese Pound (SSP).", "isDeprecated": false, "deprecationReason": null }, { "name": "SBD", "description": "Solomon Islands Dollar (SBD).", "isDeprecated": false, "deprecationReason": null }, { "name": "LKR", "description": "Sri Lankan Rupees (LKR).", "isDeprecated": false, "deprecationReason": null }, { "name": "SRD", "description": "Surinamese Dollar (SRD).", "isDeprecated": false, "deprecationReason": null }, { "name": "SZL", "description": "Swazi Lilangeni (SZL).", "isDeprecated": false, "deprecationReason": null }, { "name": "SEK", "description": "Swedish Kronor (SEK).", "isDeprecated": false, "deprecationReason": null }, { "name": "CHF", "description": "Swiss Francs (CHF).", "isDeprecated": false, "deprecationReason": null }, { "name": "TWD", "description": "Taiwan Dollars (TWD).", "isDeprecated": false, "deprecationReason": null }, { "name": "THB", "description": "Thai baht (THB).", "isDeprecated": false, "deprecationReason": null }, { "name": "TJS", "description": "Tajikistani Somoni (TJS).", "isDeprecated": false, "deprecationReason": null }, { "name": "TZS", "description": "Tanzanian Shilling (TZS).", "isDeprecated": false, "deprecationReason": null }, { "name": "TOP", "description": "Tongan Pa'anga (TOP).", "isDeprecated": false, "deprecationReason": null }, { "name": "TTD", "description": "Trinidad and Tobago Dollars (TTD).", "isDeprecated": false, "deprecationReason": null }, { "name": "TND", "description": "Tunisian Dinar (TND).", "isDeprecated": false, "deprecationReason": null }, { "name": "TRY", "description": "Turkish Lira (TRY).", "isDeprecated": false, "deprecationReason": null }, { "name": "TMT", "description": "Turkmenistani Manat (TMT).", "isDeprecated": false, "deprecationReason": null }, { "name": "UGX", "description": "Ugandan Shilling (UGX).", "isDeprecated": false, "deprecationReason": null }, { "name": "UAH", "description": "Ukrainian Hryvnia (UAH).", "isDeprecated": false, "deprecationReason": null }, { "name": "AED", "description": "United Arab Emirates Dirham (AED).", "isDeprecated": false, "deprecationReason": null }, { "name": "UYU", "description": "Uruguayan Pesos (UYU).", "isDeprecated": false, "deprecationReason": null }, { "name": "UZS", "description": "Uzbekistan som (UZS).", "isDeprecated": false, "deprecationReason": null }, { "name": "VUV", "description": "Vanuatu Vatu (VUV).", "isDeprecated": false, "deprecationReason": null }, { "name": "VES", "description": "Venezuelan Bolivares Soberanos (VES).", "isDeprecated": false, "deprecationReason": null }, { "name": "VND", "description": "Vietnamese đồng (VND).", "isDeprecated": false, "deprecationReason": null }, { "name": "XOF", "description": "West African CFA franc (XOF).", "isDeprecated": false, "deprecationReason": null }, { "name": "YER", "description": "Yemeni Rial (YER).", "isDeprecated": false, "deprecationReason": null }, { "name": "ZMW", "description": "Zambian Kwacha (ZMW).", "isDeprecated": false, "deprecationReason": null }, { "name": "BYR", "description": "Belarusian Ruble (BYR).", "isDeprecated": true, "deprecationReason": "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead." }, { "name": "STD", "description": "Sao Tome And Principe Dobra (STD).", "isDeprecated": true, "deprecationReason": "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead." }, { "name": "STN", "description": "Sao Tome And Principe Dobra (STN).", "isDeprecated": false, "deprecationReason": null }, { "name": "VED", "description": "Venezuelan Bolivares (VED).", "isDeprecated": false, "deprecationReason": null }, { "name": "VEF", "description": "Venezuelan Bolivares (VEF).", "isDeprecated": true, "deprecationReason": "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead." }, { "name": "XXX", "description": "Unrecognized currency.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CurrencyFormats", "description": "Currency formats configured for the merchant. These formats are available to use within Liquid.", "fields": [ { "name": "moneyFormat", "description": "Money without currency in HTML.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "moneyInEmailsFormat", "description": "Money without currency in emails.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "moneyWithCurrencyFormat", "description": "Money with currency in HTML.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "moneyWithCurrencyInEmailsFormat", "description": "Money with currency in emails.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CurrencySetting", "description": "A setting for a presentment currency.", "fields": [ { "name": "currencyCode", "description": "The currency's ISO code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyName", "description": "The full name of the currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Whether the currency is enabled or not. An enabled currency setting is visible to buyers and allows orders to be generated with that currency as presentment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rateUpdatedAt", "description": "The date and time when the active exchange rate for the currency was last modified. It can be the automatic rate's creation date, or the manual rate's last updated at date if active.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CurrencySettingConnection", "description": "An auto-generated type for paginating through multiple CurrencySettings.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySettingEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CurrencySettingEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySetting", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CurrencySettingEdge", "description": "An auto-generated type which holds one CurrencySetting and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CurrencySettingEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySetting", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomShippingPackageInput", "description": "The input fields for a custom shipping package used to pack shipment.", "fields": null, "inputFields": [ { "name": "weight", "description": "Weight of the empty shipping package.", "type": { "kind": "INPUT_OBJECT", "name": "WeightInput", "ofType": null }, "defaultValue": null }, { "name": "dimensions", "description": "Outside dimensions of the empty shipping package.", "type": { "kind": "INPUT_OBJECT", "name": "ObjectDimensionsInput", "ofType": null }, "defaultValue": null }, { "name": "default", "description": "The default package is the one used to calculate shipping costs on checkout.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "name", "description": "Descriptive name for the package.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "type", "description": "Type of package.", "type": { "kind": "ENUM", "name": "ShippingPackageType", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Customer", "description": "Represents information about a customer of the shop, such as the customer's contact details, their order\nhistory, and whether they've agreed to receive marketing material by email.\n\n**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.\n", "fields": [ { "name": "addresses", "description": "A list of addresses associated with the customer.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "amountSpent", "description": "The total amount that the customer has spent on orders in their lifetime.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canDelete", "description": "Whether the merchant can delete the customer from their store.\n\nA customer can be deleted from a store only if they haven't yet made an order. After a customer makes an\norder, they can't be deleted from a store.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactProfiles", "description": "A list of the customer's company contact profiles.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the customer was added to the store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultAddress", "description": "The default address associated with the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The full name of the customer, based on the values for first_name and last_name. If the first_name and\nlast_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The customer's email address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "emailMarketingConsent", "description": "The current email marketing state for the customer.\nIf the customer doesn't have an email address, then this property is `null`.\n", "args": [], "type": { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentState", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "A list of events associated with the customer.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The customer's first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Whether the merchant has added timeline comments about the customer on the customer's page.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "To query for comments on the timeline, use the events connection and a `query` argument containing `verb:comment`, or look for a `CommentEvent` in the `__typename` of events." }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated with the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The customer's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastOrder", "description": "The customer's last order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lifetimeDuration", "description": "The amount of time since the customer was first added to the store.\n\nExample: 'about 12 years'.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "The customer's locale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The market that includes the customer’s default address.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mergeable", "description": "Whether the customer can be merged with another customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergeable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multipassIdentifier", "description": "A unique identifier for the customer that's used with Multipass login.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "A note about the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "numberOfOrders", "description": "The number of orders that the customer has made at the store in their lifetime.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "A list of the customer's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| cart_token |\n| channel |\n| channel_id |\n| chargeback_status |\n| checkout_token |\n| confirmation_number |\n| created_at |\n| credit_card_last4 |\n| customer_id |\n| delivery_method |\n| discount_code |\n| email |\n| financial_status |\n| fraud_protection_level |\n| fulfillment_location_id |\n| fulfillment_status |\n| gateway |\n| location_id |\n| name |\n| payment_id |\n| payment_provider_id |\n| po_number |\n| processed_at |\n| reference_location_id |\n| return_status |\n| risk_level |\n| sales_channel |\n| sku |\n| source_identifier |\n| source_name |\n| status |\n| tag |\n| tag_not |\n| test |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentMethods", "description": "A list of the customer's payment methods.", "args": [ { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The customer's phone number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "productSubscriberStatus", "description": "Possible subscriber states of a customer defined by their subscription contracts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerProductSubscriberStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "smsMarketingConsent", "description": "The current SMS marketing state for the customer's phone number.\n\nIf the customer does not have a phone number, then this property is `null`.\n", "args": [], "type": { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentState", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "state", "description": "The state of the customer's account with the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "statistics", "description": "The statistics for a given customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerStatistics", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContracts", "description": "A list of the customer's subscription contracts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tags", "description": "A comma separated list of tags that have been added to the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxExempt", "description": "Whether the customer is exempt from being charged taxes on their orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxExemptions", "description": "The list of tax exemptions applied to the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unsubscribeUrl", "description": "The URL to unsubscribe the customer from the mailing list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the customer was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validEmailAddress", "description": "Whether the email address is formatted correctly.\n\nReturns `true` when the email is formatted correctly and\nbelongs to an existing domain. This doesn't guarantee that\nthe email address actually exists.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "verifiedEmail", "description": "Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerAccountsV2", "description": "Information about the shop's customer accounts.", "fields": [ { "name": "customerAccountsVersion", "description": "Indicates which version of customer accounts the merchant is using in online store and checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerAccountsVersion", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "loginLinksVisibleOnStorefrontAndCheckout", "description": "Login links are shown in online store and checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "loginRequiredAtCheckout", "description": "Customers are required to log in to their account before checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The root url for the customer accounts pages.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerAccountsVersion", "description": "The login redirection target for customer accounts.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CLASSIC", "description": "The customer is redirected to the classic customer accounts login page.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEW_CUSTOMER_ACCOUNTS", "description": "The customer is redirected to the new customer accounts login page.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerAddTaxExemptionsPayload", "description": "Return type for `customerAddTaxExemptions` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerCancelDataErasureErrorCode", "description": "Possible error codes that can be returned by `CustomerCancelDataErasureUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DOES_NOT_EXIST", "description": "Customer does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_CANCEL", "description": "Failed to cancel customer data erasure.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_BEING_ERASED", "description": "Customer's data is not scheduled for erasure.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerCancelDataErasurePayload", "description": "Return type for `customerCancelDataErasure` mutation.", "fields": [ { "name": "customerId", "description": "The ID of the customer whose pending data erasure has been cancelled.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerCancelDataErasureUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerCancelDataErasureUserError", "description": "An error that occurs when cancelling a customer data erasure request.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerCancelDataErasureErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerConnection", "description": "An auto-generated type for paginating through multiple Customers.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CustomerEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerConsentCollectedFrom", "description": "The source that collected the customer's consent to receive marketing materials.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHOPIFY", "description": "The customer consent was collected by Shopify.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The customer consent was collected outside of Shopify.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerCreatePayload", "description": "Return type for `customerCreate` mutation.", "fields": [ { "name": "customer", "description": "The created customer.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerCreditCard", "description": "Represents a card instrument for customer payment method.", "fields": [ { "name": "billingAddress", "description": "The billing address of the card.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerCreditCardBillingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "brand", "description": "The brand of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiresSoon", "description": "Whether the card is about to expire.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryMonth", "description": "The expiry month of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryYear", "description": "The expiry year of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstDigits", "description": "The card's BIN number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRevocable", "description": "The payment method can be revoked if there are no active subscription contracts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastDigits", "description": "The last 4 digits of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maskedNumber", "description": "The masked card number with only the last 4 digits displayed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the card holder.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "source", "description": "The source of the card if coming from a wallet such as Apple Pay.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "virtualLastDigits", "description": "The last 4 digits of the Device Account Number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerCreditCardBillingAddress", "description": "The billing address of a credit card payment instrument.", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\nFor example, US.\n", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name in the billing address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name in the billing address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The two-letter code for the region.\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerDeleteInput", "description": "The input fields to delete a customer.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the customer to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerDeletePayload", "description": "Return type for `customerDelete` mutation.", "fields": [ { "name": "deletedCustomerId", "description": "The ID of the deleted customer.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop of the deleted customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerEdge", "description": "An auto-generated type which holds one Customer and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CustomerEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerEmailAddress", "description": "Represents an email address.\n", "fields": [ { "name": "emailAddress", "description": "The customer's default email address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingState", "description": "Whether the customer has subscribed to email marketing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerEmailAddressMarketingState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingUnsubscribeUrl", "description": "The URL to unsubscribe a member from all mailing lists.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "openTrackingLevel", "description": "Whether the customer has opted in to having their opened emails tracked.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerEmailAddressOpenTrackingLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "openTrackingUrl", "description": "The URL that can be used to opt a customer in or out of email open tracking.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerEmailAddressMarketingState", "description": "Possible marketing states for the customer’s email address.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The customer’s email address marketing state is invalid.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_SUBSCRIBED", "description": "The customer is not subscribed to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The customer is in the process of subscribing to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIBED", "description": "The customer is subscribed to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUBSCRIBED", "description": "The customer is not subscribed to email marketing but was previously subscribed.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerEmailAddressOpenTrackingLevel", "description": "The different levels related to whether a customer has opted in to having their opened emails tracked.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNKNOWN", "description": "The customer has not specified whether they want to opt in or out of having their open emails tracked.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTED_IN", "description": "The customer has opted in to having their open emails tracked.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTED_OUT", "description": "The customer has opted out of having their open emails tracked.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerEmailMarketingConsentInput", "description": "Information that describes when a customer consented to\n receiving marketing material by email.", "fields": null, "inputFields": [ { "name": "marketingOptInLevel", "description": "The customer opt-in level at the time of subscribing to marketing material.", "type": { "kind": "ENUM", "name": "CustomerMarketingOptInLevel", "ofType": null }, "defaultValue": null }, { "name": "marketingState", "description": "The current marketing state associated with the customer's email.\n If the customer doesn't have an email, then this field is `null`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerEmailMarketingState", "ofType": null } }, "defaultValue": null }, { "name": "consentUpdatedAt", "description": "The latest date and time when the customer consented or objected to\n receiving marketing material by email.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentState", "description": "The record of when a customer consented to receive marketing material by email.\n", "fields": [ { "name": "consentUpdatedAt", "description": "The date and time at which the customer consented to receive marketing material by email.\nThe customer's consent state reflects the consent record with the most recent `consent_updated_at` date.\nIf no date is provided, then the date and time at which the consent information was sent is used.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingOptInLevel", "description": "The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines,\nthat the customer gave when they consented to receive marketing material by email.\n", "args": [], "type": { "kind": "ENUM", "name": "CustomerMarketingOptInLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingState", "description": "The current email marketing state for the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerEmailMarketingState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerEmailMarketingConsentUpdateInput", "description": "The input fields for the email consent information to update for a given customer ID.\n", "fields": null, "inputFields": [ { "name": "customerId", "description": "The ID of the customer for which to update the email marketing consent information. The customer must have a unique email address associated to the record. If not, add the email address using the `customerUpdate` mutation first.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "emailMarketingConsent", "description": "The marketing consent information when the customer consented to receiving marketing material by email.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerEmailMarketingConsentInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentUpdatePayload", "description": "Return type for `customerEmailMarketingConsentUpdate` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.\n", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentUpdateUserError", "description": "An error that occurs during the execution of `CustomerEmailMarketingConsentUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerEmailMarketingConsentUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerEmailMarketingConsentUpdateUserErrorCode", "description": "Possible error codes that can be returned by `CustomerEmailMarketingConsentUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENT", "description": "Missing a required argument.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerEmailMarketingState", "description": "The possible email marketing states for a customer.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_SUBSCRIBED", "description": "The customer isn't subscribed to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The customer is in the process of subscribing to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIBED", "description": "The customer is subscribed to email marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUBSCRIBED", "description": "The customer isn't currently subscribed to email marketing but was previously subscribed.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "REDACTED", "description": "The customer's personal data is erased. This value is internally-set and read-only.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The customer’s email address marketing state is invalid.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerGenerateAccountActivationUrlPayload", "description": "Return type for `customerGenerateAccountActivationUrl` mutation.", "fields": [ { "name": "accountActivationUrl", "description": "The generated account activation URL.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerInput", "description": "The input fields and values to use when creating or updating a customer.", "fields": null, "inputFields": [ { "name": "addresses", "description": "The addresses for a customer.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null } } }, "defaultValue": null }, { "name": "email", "description": "The unique email address of the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "firstName", "description": "The customer's first name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "The ID of the customer to update.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "lastName", "description": "The customer's last name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locale", "description": "The customer's locale.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional metafields to associate to the customer.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "note", "description": "A note about the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The unique phone number for the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`\n\nUpdating `tags` overwrites any existing tags that were previously added to the customer. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "emailMarketingConsent", "description": "Information that describes when the customer consented to receiving marketing\n material by email. The `email` field is required when creating a customer with email marketing\n consent information.", "type": { "kind": "INPUT_OBJECT", "name": "CustomerEmailMarketingConsentInput", "ofType": null }, "defaultValue": null }, { "name": "smsMarketingConsent", "description": "The marketing consent information when the customer consented to receiving marketing\n material by SMS. The `phone` field is required when creating a customer with SMS\n marketing consent information.", "type": { "kind": "INPUT_OBJECT", "name": "CustomerSmsMarketingConsentInput", "ofType": null }, "defaultValue": null }, { "name": "taxExempt", "description": "Whether the customer is exempt from paying taxes on their order.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "taxExemptions", "description": "The list of tax exemptions to apply to the customer.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerJourney", "description": "Represents a customer's visiting activities on a shop's online store.", "fields": [ { "name": "customerOrderIndex", "description": "The position of the current order within the customer's order history.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "daysToConversion", "description": "The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstVisit", "description": "The customer's first session going into the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastVisit", "description": "The last session before an order is made.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "moments", "description": "Events preceding a customer order, such as shop sessions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomerMoment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerJourneySummary", "description": "Represents a customer's visiting activities on a shop's online store.", "fields": [ { "name": "customerOrderIndex", "description": "The position of the current order within the customer's order history. Test orders aren't included.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "daysToConversion", "description": "The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstVisit", "description": "The customer's first session going into the shop.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastVisit", "description": "The last session before an order is made.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "moments", "description": "The events preceding a customer's order, such as shop sessions.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerMomentConnection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "momentsCount", "description": "The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ready", "description": "Whether the attributed sessions for the order have been created yet.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerMarketingOptInLevel", "description": "The possible values for the marketing subscription opt-in level enabled at the time the customer consented to receive marketing information.\n\nThe levels are defined by [the M3AAWG best practices guideline\n document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SINGLE_OPT_IN", "description": "After providing their information, the customer receives marketing information without any\nintermediate steps.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFIRMED_OPT_IN", "description": "After providing their information, the customer receives a confirmation and is required to\nperform a intermediate step before receiving marketing information.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "The customer receives marketing information but how they were opted in is unknown.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergeError", "description": "The error blocking a customer merge.", "fields": [ { "name": "errorFields", "description": "The list of fields preventing the customer from being merged.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerMergeErrorFieldType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The customer merge error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerMergeErrorCode", "description": "Possible error codes that can be returned by `CustomerMergeUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CUSTOMER", "description": "The customer cannot be merged.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CUSTOMER_ID", "description": "The customer ID is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_HAS_GIFT_CARDS", "description": "The customer cannot be merged because it has associated gift cards.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_OVERRIDE_ATTRIBUTE", "description": "The customer is missing the attribute requested for override.", "isDeprecated": false, "deprecationReason": null }, { "name": "OVERRIDE_ATTRIBUTE_INVALID", "description": "The override attribute is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerMergeErrorFieldType", "description": "The types of the hard blockers preventing a customer from being merged to another customer.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DELETED_AT", "description": "The customer does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "REDACTED_AT", "description": "The customer has a pending or completed redaction.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTIONS", "description": "The customer has a subscription history.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERGE_IN_PROGRESS", "description": "The customer has a merge in progress.", "isDeprecated": false, "deprecationReason": null }, { "name": "GIFT_CARDS", "description": "The customer has gift cards.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACT", "description": "The customer is a company contact.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PAYMENT_METHODS", "description": "The customer has payment methods.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING_DATA_REQUEST", "description": "The customer has a pending data request.", "isDeprecated": false, "deprecationReason": null }, { "name": "MULTIPASS_IDENTIFIER", "description": "The customer has a multipass identifier.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerMergeOverrideFields", "description": "The input fields to override default customer merge rules.\n", "fields": null, "inputFields": [ { "name": "customerIdOfFirstNameToKeep", "description": "The ID of the customer whose first name will be kept.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "customerIdOfLastNameToKeep", "description": "The ID of the customer whose last name will be kept.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "customerIdOfEmailToKeep", "description": "The ID of the customer whose email will be kept.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "customerIdOfPhoneNumberToKeep", "description": "The ID of the customer whose phone number will be kept.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "customerIdOfDefaultAddressToKeep", "description": "The ID of the customer whose default address will be kept.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "The note to keep.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "The tags to keep.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergePayload", "description": "Return type for `customerMerge` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job for merging the customers.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resultingCustomerId", "description": "The ID of the customer resulting from the merge.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergeUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergePreview", "description": "A preview of the results of a customer merge request.", "fields": [ { "name": "alternateFields", "description": "The fields that can be used to override the default fields.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerMergePreviewAlternateFields", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "blockingFields", "description": "The fields that will block the merge if the two customers are merged.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerMergePreviewBlockingFields", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerMergeErrors", "description": "The errors blocking the customer merge.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergeError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultFields", "description": "The fields that will be kept if the two customers are merged.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerMergePreviewDefaultFields", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resultingCustomerId", "description": "The resulting customer ID if the two customers are merged.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergePreviewAlternateFields", "description": "The fields that can be used to override the default fields.", "fields": [ { "name": "defaultAddress", "description": "The default address of a customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The email state of a customer.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerEmailAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name of a customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name of a customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneNumber", "description": "The phone number state of a customer.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPhoneNumber", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergePreviewBlockingFields", "description": "The blocking fields of a customer merge preview. These fields will block customer merge unless edited.\n", "fields": [ { "name": "note", "description": "The merged note resulting from a customer merge. The merged note is over the 5000 character limit and will block customer merge.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tags", "description": "The merged tags resulting from a customer merge. The merged tags are over the 250 limit and will block customer merge.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergePreviewDefaultFields", "description": "The fields that will be kept as part of a customer merge preview.", "fields": [ { "name": "addresses", "description": "The merged addresses resulting from a customer merge.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MailingAddressConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultAddress", "description": "The default address resulting from a customer merge.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountNodeCount", "description": "The total number of customer-specific discounts resulting from a customer merge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountNodes", "description": "The merged customer-specific discounts resulting from a customer merge.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountNodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The full name of the customer, based on the values for `first_name` and `last_name`. If `first_name` and `last_name` aren't available, then this field falls back to the customer's email address. If the customer's email isn't available, then this field falls back to the customer's phone number.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderCount", "description": "The total number of merged draft orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "The merged draft orders resulting from a customer merge.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "UPDATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The email state of a customer.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerEmailAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name resulting from a customer merge.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardCount", "description": "The total number of merged gift cards.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCards", "description": "The merged gift cards resulting from a customer merge.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "GiftCardSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name resulting from a customer merge.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldCount", "description": "The total number of merged metafields.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The merged note resulting from a customer merge.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCount", "description": "The total number of merged orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "The merged orders resulting from a customer merge.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "PROCESSED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneNumber", "description": "The phone number state of a customer.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPhoneNumber", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tags", "description": "The merged tags resulting from a customer merge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergeRequest", "description": "A merge request for merging two customers.\n", "fields": [ { "name": "customerMergeErrors", "description": "The merge errors that occurred during the customer merge request.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergeError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "jobId", "description": "The UUID of the merge job.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resultingCustomerId", "description": "The ID of the customer resulting from the merge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the customer merge request.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerMergeRequestStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerMergeRequestStatus", "description": "The status of the customer merge request.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "REQUESTED", "description": "The customer merge request has been requested.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_PROGRESS", "description": "The customer merge request is currently in progress.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPLETED", "description": "The customer merge request has been completed.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "The customer merge request has failed.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergeUserError", "description": "An error that occurs while merging two customers.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerMergeErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMergeable", "description": "An object that represents whether a customer can be merged with another customer.\n", "fields": [ { "name": "errorFields", "description": "The list of fields preventing the customer from being merged.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerMergeErrorFieldType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isMergeable", "description": "Whether the customer can be merged with another customer.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mergeInProgress", "description": "The merge request if one is currently in progress.\n", "args": [], "type": { "kind": "OBJECT", "name": "CustomerMergeRequest", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason why the customer can't be merged with another customer.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CustomerMoment", "description": "Represents a session preceding an order, often used for building a timeline of events leading to an order.", "fields": [ { "name": "occurredAt", "description": "The date and time when the customer's session occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null } ] }, { "kind": "OBJECT", "name": "CustomerMomentConnection", "description": "An auto-generated type for paginating through multiple CustomerMoments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMomentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CustomerMomentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomerMoment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerMomentEdge", "description": "An auto-generated type which holds one CustomerMoment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CustomerMomentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomerMoment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "CustomerPaymentInstrument", "description": "All possible instruments for CustomerPaymentMethods.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CustomerCreditCard", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaypalBillingAgreement", "ofType": null }, { "kind": "OBJECT", "name": "CustomerShopPayAgreement", "ofType": null } ] }, { "kind": "OBJECT", "name": "CustomerPaymentInstrumentBillingAddress", "description": "The billing address of a payment instrument.", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\nFor example, US.\n", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the buyer of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The two-letter code for the region.\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethod", "description": "A customer's payment method.", "fields": [ { "name": "customer", "description": "The customer to whom the payment method belongs.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of this payment method.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "instrument", "description": "The instrument for this payment method.", "args": [], "type": { "kind": "UNION", "name": "CustomerPaymentInstrument", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "revokedAt", "description": "The time that the payment method was revoked.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "revokedReason", "description": "The revocation reason for this payment method.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodRevocationReason", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContracts", "description": "List Subscription Contracts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodConnection", "description": "An auto-generated type for paginating through multiple CustomerPaymentMethods.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CustomerPaymentMethodEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodCreateFromDuplicationDataPayload", "description": "Return type for `customerPaymentMethodCreateFromDuplicationData` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", "description": "An error that occurs during the execution of `CustomerPaymentMethodCreateFromDuplicationData`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodCreateFromDuplicationDataUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodCreateFromDuplicationDataUserErrorCode", "description": "Possible error codes that can be returned by `CustomerPaymentMethodCreateFromDuplicationDataUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOO_MANY_REQUESTS", "description": "Too many requests.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_DOES_NOT_EXIST", "description": "Customer doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ENCRYPTED_DUPLICATION_DATA", "description": "Invalid encrypted duplication data.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodCreditCardCreatePayload", "description": "Return type for `customerPaymentMethodCreditCardCreate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "processing", "description": "If the card verification result is processing. When this is true, customer_payment_method will be null.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodCreditCardUpdatePayload", "description": "Return type for `customerPaymentMethodCreditCardUpdate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "processing", "description": "If the card verification result is processing. When this is true, customer_payment_method will be null.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodEdge", "description": "An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CustomerPaymentMethodEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetDuplicationDataPayload", "description": "Return type for `customerPaymentMethodGetDuplicationData` mutation.", "fields": [ { "name": "encryptedDuplicationData", "description": "The encrypted data from the payment method to be duplicated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodGetDuplicationDataUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetDuplicationDataUserError", "description": "An error that occurs during the execution of `CustomerPaymentMethodGetDuplicationData`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodGetDuplicationDataUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodGetDuplicationDataUserErrorCode", "description": "Possible error codes that can be returned by `CustomerPaymentMethodGetDuplicationDataUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_METHOD_DOES_NOT_EXIST", "description": "Payment method doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INSTRUMENT", "description": "Invalid payment instrument.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_REQUESTS", "description": "Too many requests.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_DOES_NOT_EXIST", "description": "Customer doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "SAME_SHOP", "description": "Target shop cannot be the same as the source.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ORGANIZATION_SHOP", "description": "Must be targeted to another shop in the same organization.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetUpdateUrlPayload", "description": "Return type for `customerPaymentMethodGetUpdateUrl` mutation.", "fields": [ { "name": "updatePaymentMethodUrl", "description": "The URL to redirect the customer to update the payment method.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodGetUpdateUrlUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetUpdateUrlUserError", "description": "An error that occurs during the execution of `CustomerPaymentMethodGetUpdateUrl`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode", "description": "Possible error codes that can be returned by `CustomerPaymentMethodGetUpdateUrlUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_METHOD_DOES_NOT_EXIST", "description": "Payment method doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INSTRUMENT", "description": "Invalid payment instrument.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_REQUESTS", "description": "Too many requests.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_DOES_NOT_EXIST", "description": "Customer doesn't exist.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodPaypalBillingAgreementCreatePayload", "description": "Return type for `customerPaymentMethodPaypalBillingAgreementCreate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodPaypalBillingAgreementUpdatePayload", "description": "Return type for `customerPaymentMethodPaypalBillingAgreementUpdate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteCreatePayload", "description": "Return type for `customerPaymentMethodRemoteCreate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteCreditCardCreatePayload", "description": "Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation.", "fields": [ { "name": "customerPaymentMethod", "description": "The customer payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerPaymentMethodUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerPaymentMethodRemoteInput", "description": "The input fields for a remote gateway payment method, only one remote reference permitted.\n", "fields": null, "inputFields": [ { "name": "stripePaymentMethod", "description": "Input containing the fields for a remote stripe payment method.\n", "type": { "kind": "INPUT_OBJECT", "name": "RemoteStripePaymentMethodInput", "ofType": null }, "defaultValue": null }, { "name": "authorizeNetCustomerPaymentProfile", "description": "The input fields for a remote authorize net customer profile.\n", "type": { "kind": "INPUT_OBJECT", "name": "RemoteAuthorizeNetCustomerPaymentProfileInput", "ofType": null }, "defaultValue": null }, { "name": "braintreePaymentMethod", "description": "The input fields for a remote Braintree customer profile.", "type": { "kind": "INPUT_OBJECT", "name": "RemoteBraintreePaymentMethodInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteUserError", "description": "Represents an error in the input of a mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodRemoteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodRemoteUserErrorCode", "description": "Possible error codes that can be returned by `CustomerPaymentMethodRemoteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXACTLY_ONE_REMOTE_REFERENCE_REQUIRED", "description": "Exactly one remote reference is required.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHORIZE_NET_NOT_ENABLED_FOR_SUBSCRIPTIONS", "description": "Authorize.net is not enabled for subscriptions.", "isDeprecated": false, "deprecationReason": null }, { "name": "BRAINTREE_NOT_ENABLED_FOR_SUBSCRIPTIONS", "description": "Braintree is not enabled for subscriptions.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodRevocationReason", "description": "The revocation reason types for a customer payment method.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "description": "The Authorize.net payment gateway is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "description": "Authorize.net did not return any payment methods. Make sure that the correct Authorize.net account is linked.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_UPDATE_CREDIT_CARD", "description": "The credit card failed to update.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRIPE_API_AUTHENTICATION_ERROR", "description": "Failed to contact the Stripe API.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRIPE_API_INVALID_REQUEST_ERROR", "description": "Invalid request. Failed to retrieve payment method from Stripe.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRIPE_GATEWAY_NOT_ENABLED", "description": "The Stripe payment gateway is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRIPE_RETURNED_NO_PAYMENT_METHOD", "description": "Stripe did not return any payment methods. Make sure that the correct Stripe account is linked.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRIPE_PAYMENT_METHOD_NOT_CARD", "description": "The Stripe payment method type should be card.", "isDeprecated": false, "deprecationReason": null }, { "name": "BRAINTREE_API_AUTHENTICATION_ERROR", "description": "Failed to contact Braintree API.", "isDeprecated": false, "deprecationReason": null }, { "name": "BRAINTREE_GATEWAY_NOT_ENABLED", "description": "The Braintree payment gateway is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "description": "Braintree returned no payment methods. Make sure the correct Braintree account is linked.", "isDeprecated": false, "deprecationReason": null }, { "name": "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "description": "The Braintree payment method type should be a credit card or Apple Pay card.", "isDeprecated": false, "deprecationReason": null }, { "name": "MANUALLY_REVOKED", "description": "The payment method was manually revoked.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERGED", "description": "The payment method was replaced with an existing payment method. The associated contracts have been migrated to the other payment method.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodRevokePayload", "description": "Return type for `customerPaymentMethodRevoke` mutation.", "fields": [ { "name": "revokedCustomerPaymentMethodId", "description": "The ID of the revoked customer payment method.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodSendUpdateEmailPayload", "description": "Return type for `customerPaymentMethodSendUpdateEmail` mutation.", "fields": [ { "name": "customer", "description": "The customer to whom an update payment method email was sent.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodUserError", "description": "Represents an error in the input of a mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPaymentMethodUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPaymentMethodUserErrorCode", "description": "Possible error codes that can be returned by `CustomerPaymentMethodUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaypalBillingAgreement", "description": "Represents a PayPal instrument for customer payment method.", "fields": [ { "name": "billingAddress", "description": "The billing address of this payment method.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentInstrumentBillingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inactive", "description": "Whether the PayPal billing agreement is inactive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRevocable", "description": "Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paypalAccountEmail", "description": "The customers's PayPal account email address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPhoneNumber", "description": "A phone number.\n", "fields": [ { "name": "marketingState", "description": "Whether the customer has subscribed to SMS marketing material.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerSmsMarketingState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneNumber", "description": "A customer's phone number.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerPredictedSpendTier", "description": "The valid tiers for the predicted spend of a customer with a shop.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HIGH", "description": "The customer's spending is predicted to be in the top spending range for the shop in the following year.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIUM", "description": "The customer's spending is predicted to be in the normal spending range for the shop in the following year.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "LOW", "description": "The customer's spending is predicted to be zero, or in the lowest spending range for the shop in the following year.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerProductSubscriberStatus", "description": "The possible product subscription states for a customer, as defined by the customer's subscription contracts.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The customer has at least one active subscription contract.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLED", "description": "The customer's last subscription contract was cancelled and there are no other active or paused\nsubscription contracts.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The customer's last subscription contract expired and there are no other active or paused\nsubscription contracts.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "The customer's last subscription contract failed and there are no other active or paused\nsubscription contracts.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "NEVER_SUBSCRIBED", "description": "The customer has never had a subscription contract.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PAUSED", "description": "The customer has at least one paused subscription contract and there are no other active\nsubscription contracts.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerRemoveTaxExemptionsPayload", "description": "Return type for `customerRemoveTaxExemptions` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerReplaceTaxExemptionsPayload", "description": "Return type for `customerReplaceTaxExemptions` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerRequestDataErasureErrorCode", "description": "Possible error codes that can be returned by `CustomerRequestDataErasureUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DOES_NOT_EXIST", "description": "Customer does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_REQUEST", "description": "Failed to request customer data erasure.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerRequestDataErasurePayload", "description": "Return type for `customerRequestDataErasure` mutation.", "fields": [ { "name": "customerId", "description": "The ID of the customer that will be erased.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerRequestDataErasureUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerRequestDataErasureUserError", "description": "An error that occurs when requesting a customer data erasure.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerRequestDataErasureErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerSavedSearchSortKeys", "description": "The set of valid sort keys for the CustomerSavedSearch query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMember", "description": "The member of a segment.\n", "fields": [ { "name": "amountSpent", "description": "The total amount of money that the member has spent on orders.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultAddress", "description": "The member's default address.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultEmailAddress", "description": "The member's default email address.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerEmailAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultPhoneNumber", "description": "The member's default phone number.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPhoneNumber", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The full name of the member, which is based on the values of the `first_name` and `last_name` fields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The member's first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The member’s ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The member's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastOrderId", "description": "The ID of the member's most recent order.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mergeable", "description": "Whether the customer can be merged with another customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergeable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "A note about the member.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "numberOfOrders", "description": "The total number of orders that the member has made.", "args": [], "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMemberConnection", "description": "The connection type for the `CustomerSegmentMembers` object.", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerSegmentMemberEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "statistics", "description": "The statistics for a given segment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentStatistics", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCount", "description": "The total number of members in a given segment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMemberEdge", "description": "An auto-generated type which holds one CustomerSegmentMember and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CustomerSegmentMemberEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerSegmentMember", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMembersQuery", "description": "A job to determine a list of members, such as customers, that are associated with an individual segment.", "fields": [ { "name": "currentCount", "description": "The current total number of members in a given segment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "done", "description": "This indicates if the job is still queued or has been run.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID that's returned when running an asynchronous mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "JobResult", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMembersQueryCreatePayload", "description": "Return type for `customerSegmentMembersQueryCreate` mutation.", "fields": [ { "name": "customerSegmentMembersQuery", "description": "The newly created customer segment members query.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerSegmentMembersQuery", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerSegmentMembersQueryUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerSegmentMembersQueryInput", "description": "The input fields and values for creating a customer segment members query.", "fields": null, "inputFields": [ { "name": "segmentId", "description": "The ID of the segment.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "query", "description": "The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the list. The sorting behaviour defaults to ascending order.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the list by a given key.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSegmentMembersQueryUserError", "description": "Represents a customer segment members query custom error.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerSegmentMembersQueryUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerSegmentMembersQueryUserErrorCode", "description": "Possible error codes that can be returned by `CustomerSegmentMembersQueryUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerShopPayAgreement", "description": "Represents a Shop Pay card instrument for customer payment method.", "fields": [ { "name": "billingAddress", "description": "The billing address of the card.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerCreditCardBillingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiresSoon", "description": "Whether the card is about to expire.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryMonth", "description": "The expiry month of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryYear", "description": "The expiry year of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inactive", "description": "Whether the Shop Pay billing agreement is inactive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRevocable", "description": "The payment method can be revoked if there are no active subscription contracts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastDigits", "description": "The last 4 digits of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maskedNumber", "description": "The masked card number with only the last 4 digits displayed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the card holder.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentError", "description": "An error that occurs during execution of an SMS marketing consent mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "CustomerSmsMarketingConsentErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerSmsMarketingConsentErrorCode", "description": "Possible error codes that can be returned by `CustomerSmsMarketingConsentError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENT", "description": "Missing a required argument.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerSmsMarketingConsentInput", "description": "The marketing consent information when the customer consented to\n receiving marketing material by SMS.", "fields": null, "inputFields": [ { "name": "marketingOptInLevel", "description": "The marketing subscription opt-in level that was set when the customer consented to receive marketing information.\n", "type": { "kind": "ENUM", "name": "CustomerMarketingOptInLevel", "ofType": null }, "defaultValue": null }, { "name": "marketingState", "description": "The current SMS marketing state for the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerSmsMarketingState", "ofType": null } }, "defaultValue": null }, { "name": "consentUpdatedAt", "description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentState", "description": "The record of when a customer consented to receive marketing material by SMS.\n\nThe customer's consent state reflects the record with the most recent date when consent was updated.\n", "fields": [ { "name": "consentCollectedFrom", "description": "The source from which the SMS marketing information for the customer was collected.", "args": [], "type": { "kind": "ENUM", "name": "CustomerConsentCollectedFrom", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "consentUpdatedAt", "description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingOptInLevel", "description": "The marketing subscription opt-in level that was set when the customer consented to receive marketing information.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerMarketingOptInLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingState", "description": "The current SMS marketing state for the customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CustomerSmsMarketingState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerSmsMarketingConsentUpdateInput", "description": "The input fields for updating SMS marketing consent information for a given customer ID.\n", "fields": null, "inputFields": [ { "name": "customerId", "description": "The ID of the customer to update the SMS marketing consent information for. The customer must have a unique phone number associated to the record. If not, add the phone number using the `customerUpdate` mutation first.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "smsMarketingConsent", "description": "The marketing consent information when the customer consented to receiving marketing material by SMS.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerSmsMarketingConsentInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentUpdatePayload", "description": "Return type for `customerSmsMarketingConsentUpdate` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.\n", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerSmsMarketingState", "description": "The valid SMS marketing states for a customer’s phone number.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_SUBSCRIBED", "description": "The customer hasn't subscribed to SMS marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The customer is in the process of subscribing to SMS marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIBED", "description": "The customer is subscribed to SMS marketing.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUBSCRIBED", "description": "The customer isn't currently subscribed to SMS marketing but was previously subscribed.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "REDACTED", "description": "The customer's personal data is erased. This value is internally-set and read-only.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerSortKeys", "description": "The set of valid sort keys for the Customer query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION", "description": "Sort by the `location` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_COUNT", "description": "Sort by the `orders_count` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "LAST_ORDER_DATE", "description": "Sort by the `last_order_date` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_SPENT", "description": "Sort by the `total_spent` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "CustomerState", "description": "The valid values for the state of a customer's account with a shop.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DECLINED", "description": "The customer declined the email invite to create an account.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "DISABLED", "description": "The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "ENABLED", "description": "The customer has created an account.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INVITED", "description": "The customer has received an email invite to create an account.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerStatistics", "description": "A customer's computed statistics.", "fields": [ { "name": "predictedSpendTier", "description": "The predicted spend tier of a customer with a shop.", "args": [], "type": { "kind": "ENUM", "name": "CustomerPredictedSpendTier", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerUpdateDefaultAddressPayload", "description": "Return type for `customerUpdateDefaultAddress` mutation.", "fields": [ { "name": "customer", "description": "The customer whose address was updated.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerUpdatePayload", "description": "Return type for `customerUpdate` mutation.", "fields": [ { "name": "customer", "description": "The updated customer.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerVisit", "description": "Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "landingPage", "description": "URL of the first page the customer landed on for the session.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "landingPageHtml", "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.", "args": [], "type": { "kind": "SCALAR", "name": "HTML", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEvent", "description": "Represent actions taken by an app, on behalf of a merchant,\nto market Shopify resources such as products, collections, and discounts.\n", "args": [], "type": { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "occurredAt", "description": "The date and time when the customer's session occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "referralCode", "description": "Marketing referral code from the link that the customer clicked to visit the store.\nSupports the following URL attributes: _ref_, _source_, or _r_.\nFor example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "referralInfoHtml", "description": "Referral information with URLs linked in HTML.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "referrerUrl", "description": "Webpage where the customer clicked a link that sent them to the online store.\nFor example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "source", "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct,\na website domain, QR code, or unknown.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceDescription", "description": "Describes the source explicitly for first or last session.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceType", "description": "Type of marketing tactic.", "args": [], "type": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "utmParameters", "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", "args": [], "type": { "kind": "OBJECT", "name": "UTMParameters", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomerMoment", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerVisitProductInfo", "description": "This type returns the information about the product and product variant from a customer visit.\n", "fields": [ { "name": "product", "description": "The product information. If `null`, then the product was deleted from the store.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the product that the customer requested.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant information, if the product variant exists.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerVisitProductInfoConnection", "description": "An auto-generated type for paginating through multiple CustomerVisitProductInfos.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisitProductInfoEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in CustomerVisitProductInfoEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisitProductInfo", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerVisitProductInfoEdge", "description": "An auto-generated type which holds one CustomerVisitProductInfo and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of CustomerVisitProductInfoEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerVisitProductInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Date", "description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date string.\nFor example, September 7, 2019 is represented as `\"2019-07-16\"`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "DateTime", "description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.\nFor example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is\nrepresented as `\"2019-09-07T15:50:00Z`\".\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DayOfTheWeek", "description": "Days of the week from Monday to Sunday.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MONDAY", "description": "Monday.", "isDeprecated": false, "deprecationReason": null }, { "name": "TUESDAY", "description": "Tuesday.", "isDeprecated": false, "deprecationReason": null }, { "name": "WEDNESDAY", "description": "Wednesday.", "isDeprecated": false, "deprecationReason": null }, { "name": "THURSDAY", "description": "Thursday.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRIDAY", "description": "Friday.", "isDeprecated": false, "deprecationReason": null }, { "name": "SATURDAY", "description": "Saturday.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUNDAY", "description": "Sunday.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "SCALAR", "name": "Decimal", "description": "A signed decimal number, which supports arbitrary precision and is serialized as a string.\n\nExample values: `\"29.99\"`, `\"29.999\"`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DelegateAccessToken", "description": "A token that delegates a set of scopes from the original permission.\n\nTo learn more about creating delegate access tokens, refer to\n[Delegate OAuth access tokens to subsystems]\n(https://shopify.dev/apps/auth/oauth/delegate-access-tokens).\n", "fields": [ { "name": "accessScopes", "description": "The list of permissions associated with the token.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "accessToken", "description": "The issued delegate access token.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the delegate access token was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenCreatePayload", "description": "Return type for `delegateAccessTokenCreate` mutation.", "fields": [ { "name": "delegateAccessToken", "description": "The delegate access token.", "args": [], "type": { "kind": "OBJECT", "name": "DelegateAccessToken", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DelegateAccessTokenCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenCreateUserError", "description": "An error that occurs during the execution of `DelegateAccessTokenCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DelegateAccessTokenCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DelegateAccessTokenCreateUserErrorCode", "description": "Possible error codes that can be returned by `DelegateAccessTokenCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EMPTY_ACCESS_SCOPE", "description": "The access scope can't be empty.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELEGATE_ACCESS_TOKEN", "description": "The parent access token can't be a delegate token.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEGATIVE_EXPIRES_IN", "description": "The expires_in value must be greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRES_AFTER_PARENT", "description": "The delegate token can't expire after the parent token.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFRESH_TOKEN", "description": "The parent access token can't have a refresh token.", "isDeprecated": false, "deprecationReason": null }, { "name": "PERSISTENCE_FAILED", "description": "Persistence failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN_SCOPES", "description": "Unknown scopes.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenDestroyPayload", "description": "Return type for `delegateAccessTokenDestroy` mutation.", "fields": [ { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the delegate access token destroy operation. Returns true if successful.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DelegateAccessTokenDestroyUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenDestroyUserError", "description": "An error that occurs during the execution of `DelegateAccessTokenDestroy`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DelegateAccessTokenDestroyUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DelegateAccessTokenDestroyUserErrorCode", "description": "Possible error codes that can be returned by `DelegateAccessTokenDestroyUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PERSISTENCE_FAILED", "description": "Persistence failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACCESS_TOKEN_NOT_FOUND", "description": "Access token not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAN_ONLY_DELETE_DELEGATE_TOKENS", "description": "Cannot delete parent access token.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACCESS_DENIED", "description": "Access denied.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DelegateAccessTokenInput", "description": "The input fields for a delegate access token.", "fields": null, "inputFields": [ { "name": "delegateAccessScope", "description": "The list of scopes that will be delegated to the new access token.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null }, { "name": "expiresIn", "description": "The amount of time, in seconds, after which the delegate access token is no longer valid.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeletionEvent", "description": "Deletion events chronicle the destruction of resources (e.g. products and collections).\nOnce deleted, the deletion event is the only trace of the original's existence,\nas the resource itself has been removed and can no longer be accessed.\n", "fields": [ { "name": "occurredAt", "description": "The date and time when the deletion event for the related resource was generated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subjectId", "description": "The ID of the resource that was deleted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subjectType", "description": "The type of resource that was deleted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeletionEventSubjectType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeletionEventConnection", "description": "An auto-generated type for paginating through multiple DeletionEvents.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeletionEventEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeletionEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeletionEvent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeletionEventEdge", "description": "An auto-generated type which holds one DeletionEvent and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeletionEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeletionEvent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeletionEventSortKeys", "description": "The set of valid sort keys for the DeletionEvent query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DeletionEventSubjectType", "description": "The supported subject types of deletion events.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "COLLECTION", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT", "description": null, "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryAvailableService", "description": "A shipping service and a list of countries that the service is available for.", "fields": [ { "name": "countries", "description": "The countries the service provider ships to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCountryCodesOrRestOfWorld", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryBrandedPromise", "description": "Represents a branded promise presented to buyers.\n", "fields": [ { "name": "handle", "description": "The handle of the branded promise. For example: `shop_promise`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the branded promise. For example: `Shop Promise`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCarrierService", "description": "A carrier service (also known as a carrier calculated service or shipping service) provides real-time shipping rates to Shopify. Some common carrier services include Canada Post, FedEx, UPS, and USPS. The term **carrier** is often used interchangeably with the terms **shipping company** and **rate provider**.\n\nUsing the CarrierService resource, you can add a carrier service to a shop and then provide a list of applicable shipping rates at checkout. You can even use the cart data to adjust shipping rates and offer shipping discounts based on what is in the customer's cart.\n\n## Requirements for accessing the CarrierService resource\nTo access the CarrierService resource, add the `write_shipping` permission to your app's requested scopes. For more information, see [API access scopes](https://shopify.dev/docs/admin-api/access-scopes).\n\nYour app's request to create a carrier service will fail unless the store installing your carrier service meets one of the following requirements:\n* It's on the Advanced Shopify plan or higher.\n* It's on the Shopify plan with yearly billing, or the carrier service feature has been added to the store for a monthly fee. For more information, contact [Shopify Support](https://help.shopify.com/questions).\n* It's a development store.\n\n> Note:\n> If a store changes its Shopify plan, then the store's association with a carrier service is deactivated if the store no long meets one of the requirements above.\n\n## Providing shipping rates to Shopify\nWhen adding a carrier service to a store, you need to provide a POST endpoint rooted in the `callbackUrl` property where Shopify can retrieve applicable shipping rates. The callback URL should be a public endpoint that expects these requests from Shopify.\n\n### Example shipping rate request sent to a carrier service\n\n```json\n{\n \"rate\": {\n \"origin\": {\n \"country\": \"CA\",\n \"postal_code\": \"K2P1L4\",\n \"province\": \"ON\",\n \"city\": \"Ottawa\",\n \"name\": null,\n \"address1\": \"150 Elgin St.\",\n \"address2\": \"\",\n \"address3\": null,\n \"phone\": null,\n \"fax\": null,\n \"email\": null,\n \"address_type\": null,\n \"company_name\": \"Jamie D's Emporium\"\n },\n \"destination\": {\n \"country\": \"CA\",\n \"postal_code\": \"K1M1M4\",\n \"province\": \"ON\",\n \"city\": \"Ottawa\",\n \"name\": \"Bob Norman\",\n \"address1\": \"24 Sussex Dr.\",\n \"address2\": \"\",\n \"address3\": null,\n \"phone\": null,\n \"fax\": null,\n \"email\": null,\n \"address_type\": null,\n \"company_name\": null\n },\n \"items\": [{\n \"name\": \"Short Sleeve T-Shirt\",\n \"sku\": \"\",\n \"quantity\": 1,\n \"grams\": 1000,\n \"price\": 1999,\n \"vendor\": \"Jamie D's Emporium\",\n \"requires_shipping\": true,\n \"taxable\": true,\n \"fulfillment_service\": \"manual\",\n \"properties\": null,\n \"product_id\": 48447225880,\n \"variant_id\": 258644705304\n }],\n \"currency\": \"USD\",\n \"locale\": \"en\"\n }\n}\n```\n\n### Example response\n```json\n{\n \"rates\": [\n {\n \"service_name\": \"canadapost-overnight\",\n \"service_code\": \"ON\",\n \"total_price\": \"1295\",\n \"description\": \"This is the fastest option by far\",\n \"currency\": \"CAD\",\n \"min_delivery_date\": \"2013-04-12 14:48:45 -0400\",\n \"max_delivery_date\": \"2013-04-12 14:48:45 -0400\"\n },\n {\n \"service_name\": \"fedex-2dayground\",\n \"service_code\": \"2D\",\n \"total_price\": \"2934\",\n \"currency\": \"USD\",\n \"min_delivery_date\": \"2013-04-12 14:48:45 -0400\",\n \"max_delivery_date\": \"2013-04-12 14:48:45 -0400\"\n },\n {\n \"service_name\": \"fedex-priorityovernight\",\n \"service_code\": \"1D\",\n \"total_price\": \"3587\",\n \"currency\": \"USD\",\n \"min_delivery_date\": \"2013-04-12 14:48:45 -0400\",\n \"max_delivery_date\": \"2013-04-12 14:48:45 -0400\"\n }\n ]\n}\n```\n\nThe `address3`, `fax`, `address_type`, and `company_name` fields are returned by specific [ActiveShipping](https://github.com/Shopify/active_shipping) providers. For API-created carrier services, you should use only the following shipping address fields:\n* `address1`\n* `address2`\n* `city`\n* `zip`\n* `province`\n* `country`\n\nOther values remain as `null` and are not sent to the callback URL.\n\n### Response fields\n\nWhen Shopify requests shipping rates using your callback URL, the response object `rates` must be a JSON array of objects with the following fields. Required fields must be included in the response for the carrier service integration to work properly.\n\n| Field | Required | Description |\n| ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `service_name` | Yes | The name of the rate, which customers see at checkout. For example: `Expedited Mail`. |\n| `description` | Yes | A description of the rate, which customers see at checkout. For example: `Includes tracking and insurance`. |\n| `service_code` | Yes | A unique code associated with the rate. For example: `expedited_mail`. |\n| `currency` | Yes | The currency of the shipping rate. |\n| `total_price` | Yes | The total price expressed in subunits. If the currency doesn't use subunits, then the value must be multiplied by 100. For example: `\"total_price\": 500` for 5.00 CAD, `\"total_price\": 100000` for 1000 JPY. |\n| `phone_required` | No | Whether the customer must provide a phone number at checkout. |\n| `min_delivery_date` | No | The earliest delivery date for the displayed rate. |\n| `max_delivery_date` | No | The latest delivery date for the displayed rate to still be valid. |\n\n## Response Timeouts\nThe read timeout for rate requests are dynamic, based on the number of requests per minute (RPM). These limits are applied to each shop-app pair. The timeout values are as follows.\n\n| RPM Range | Timeout |\n| ------------- | ---------- |\n| Under 1500 | 10s |\n| 1500 to 3000 | 5s |\n| Over 3000 | 3s |\n\n> Note:\n> These values are upper limits and should not be interpretted as a goal to develop towards. Shopify is constantly evaluating the performance of the platform and working towards improving resilience as well as app capabilities. As such, these numbers may be adjusted outside of our normal versioning timelines.\n\n## Server-side caching of requests\nShopify provides server-side caching to reduce the number of requests it makes. Any shipping rate request that identically matches the following fields will be retrieved from Shopify's cache of the initial response:\n* variant IDs\n* default shipping box weight and dimensions\n* variant quantities\n* carrier service ID\n* origin address\n* destination address\n* item weights and signatures\n\nIf any of these fields differ, or if the cache has expired since the original request, then new shipping rates are requested. The cache expires 15 minutes after rates are successfully returned. If an error occurs, then the cache expires after 30 seconds.\n", "fields": [ { "name": "availableServicesForCountries", "description": "The list of services offered for given destinations.", "args": [ { "name": "origins", "description": "The locations of the possible origins.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "countryCodes", "description": "The country codes of the destinations.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "restOfWorld", "description": "Whether to use 'Rest of World' as the destination.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryAvailableService", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedName", "description": "The properly formatted name of the shipping service provider, ready to display.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "The logo of the service provider.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the shipping service provider.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCarrierServiceAndLocations", "description": "A carrier service and the associated list of shop locations.", "fields": [ { "name": "carrierService", "description": "The carrier service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": "The list of locations that support this carrier service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCondition", "description": "A condition that must pass for a delivery method definition to be applied to an order.", "fields": [ { "name": "conditionCriteria", "description": "The value (weight or price) that the condition field is compared to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DeliveryConditionCriteria", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The field to compare the criterion value against, using the operator.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryConditionField", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "operator", "description": "The operator to compare the field and criterion value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryConditionOperator", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DeliveryConditionCriteria", "description": "The value (weight or price) that the condition field is compared to.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, { "kind": "OBJECT", "name": "Weight", "ofType": null } ] }, { "kind": "ENUM", "name": "DeliveryConditionField", "description": "The field type that the condition will be applied to.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOTAL_WEIGHT", "description": "The condition will check against the total weight of the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_PRICE", "description": "The condition will check against the total price of the order.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryConditionOperator", "description": "The operator to use to determine if the condition passes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The condition will check whether the field is greater than or equal to the criterion.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The condition will check if the field is less than or equal to the criterion.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCountry", "description": "A country that is used to define a shipping zone.", "fields": [ { "name": "code", "description": "A two-letter country code in ISO 3166-1 alpha-2 standard.\nIt also includes a flag indicating whether the country should be\na part of the 'Rest Of World' shipping zone.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCountryCodeOrRestOfWorld", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The full name of the country.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinces", "description": "The list of regions associated with this country.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProvince", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatedName", "description": "The translated name of the country. The translation returned is based on the system's locale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCountryAndZone", "description": "The country details and the associated shipping zone.", "fields": [ { "name": "country", "description": "The country details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCountry", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "zone", "description": "The name of the shipping zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCountryCodeOrRestOfWorld", "description": "The country code and whether the country is a part of the 'Rest Of World' shipping zone.\n", "fields": [ { "name": "countryCode", "description": "The country code in the ISO 3166-1 alpha-2 format.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "restOfWorld", "description": "Whether the country is a part of the 'Rest of World' shipping zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCountryCodesOrRestOfWorld", "description": "The list of country codes and information whether the countries\nare a part of the 'Rest Of World' shipping zone.\n", "fields": [ { "name": "countryCodes", "description": "List of applicable country codes in the ISO 3166-1 alpha-2 format.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restOfWorld", "description": "Whether the countries are a part of the 'Rest of World' shipping zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryCountryInput", "description": "The input fields to specify a country.", "fields": null, "inputFields": [ { "name": "code", "description": "The country code of the country in the ISO 3166-1 alpha-2 format.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "restOfWorld", "description": "Whether the country is a part of the 'Rest of World' shipping zone.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "provinces", "description": "The regions associated with this country.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProvinceInput", "ofType": null } } }, "defaultValue": null }, { "name": "includeAllProvinces", "description": "Associate all available provinces with this country.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomization", "description": "A delivery customization.", "fields": [ { "name": "enabled", "description": "The enabled status of the delivery customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorHistory", "description": "The error history on the most recent version of the delivery customization.", "args": [], "type": { "kind": "OBJECT", "name": "FunctionsErrorHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "functionId", "description": "The ID of the Shopify Function implementing the delivery customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "shopifyFunction", "description": "The Shopify Function implementing the delivery customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the delivery customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationActivationPayload", "description": "Return type for `deliveryCustomizationActivation` mutation.", "fields": [ { "name": "ids", "description": "The IDs of the updated delivery customizations.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationConnection", "description": "An auto-generated type for paginating through multiple DeliveryCustomizations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeliveryCustomizationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationCreatePayload", "description": "Return type for `deliveryCustomizationCreate` mutation.", "fields": [ { "name": "deliveryCustomization", "description": "Returns the created delivery customization.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationDeletePayload", "description": "Return type for `deliveryCustomizationDelete` mutation.", "fields": [ { "name": "deletedId", "description": "Returns the deleted delivery customization ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationEdge", "description": "An auto-generated type which holds one DeliveryCustomization and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeliveryCustomizationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationError", "description": "An error that occurs during the execution of a delivery customization mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DeliveryCustomizationErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryCustomizationErrorCode", "description": "Possible error codes that can be returned by `DeliveryCustomizationError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "Function not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_CUSTOMIZATION_NOT_FOUND", "description": "Delivery customization not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE", "description": "Shop must be on a Shopify Plus plan to activate delivery customizations from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNAUTHORIZED_APP_SCOPE", "description": "Unauthorized app scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_ACTIVE_DELIVERY_CUSTOMIZATIONS", "description": "Maximum delivery customizations are already enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", "description": "Shop must be on a Shopify Plus plan to activate functions from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_DOES_NOT_IMPLEMENT", "description": "Function does not implement the required interface for this delivery customization.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_PENDING_DELETION", "description": "Function is pending deletion.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_ID_CANNOT_BE_CHANGED", "description": "Function ID cannot be changed.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRED_INPUT_FIELD", "description": "Required input field must be present.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_METAFIELDS", "description": "Could not create or update metafields.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryCustomizationInput", "description": "The input fields to create and update a delivery customization.", "fields": null, "inputFields": [ { "name": "functionId", "description": "The ID of the function providing the delivery customization.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the delivery customization.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "enabled", "description": "The enabled status of the delivery customization.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional metafields to associate to the delivery customization.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationUpdatePayload", "description": "Return type for `deliveryCustomizationUpdate` mutation.", "fields": [ { "name": "deliveryCustomization", "description": "Returns the updated delivery customization.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLegacyModeBlocked", "description": "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.", "fields": [ { "name": "blocked", "description": "Whether the shop can convert to full multi-location delivery profiles mode.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reasons", "description": "The reasons why the shop is blocked from converting to full multi-location delivery profiles mode.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryLegacyModeBlockedReason", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryLegacyModeBlockedReason", "description": "Reasons the shop is blocked from converting to full multi-location delivery profiles mode.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MULTI_LOCATION_DISABLED", "description": "Multi-Location mode is disabled. The shop can't convert to full multi-location delivery profiles mode.", "isDeprecated": true, "deprecationReason": "All shops are now using multi-location mode." }, { "name": "NO_LOCATIONS_FULFILLING_ONLINE_ORDERS", "description": "There are no locations for this store that can fulfill online orders.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocalPickupSettings", "description": "Local pickup settings associated with a location.", "fields": [ { "name": "instructions", "description": "Additional instructions or information related to the local pickup.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pickupTime", "description": "The estimated pickup time to show customers at checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryLocalPickupTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryLocalPickupTime", "description": "Possible pickup time values that a location enabled for local pickup can have.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ONE_HOUR", "description": "Usually ready in 1 hour.", "isDeprecated": false, "deprecationReason": null }, { "name": "TWO_HOURS", "description": "Usually ready in 2 hours.", "isDeprecated": false, "deprecationReason": null }, { "name": "FOUR_HOURS", "description": "Usually ready in 4 hours.", "isDeprecated": false, "deprecationReason": null }, { "name": "TWENTY_FOUR_HOURS", "description": "Usually ready in 24 hours.", "isDeprecated": false, "deprecationReason": null }, { "name": "TWO_TO_FOUR_DAYS", "description": "Usually ready in 2-4 days.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIVE_OR_MORE_DAYS", "description": "Usually ready in 5+ days.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocationGroup", "description": "A location group is a collection of locations. They share zones and delivery methods across delivery\nprofiles.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": "A list of all locations that are part of this location group.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "LocationSortKeys", "ofType": null }, "defaultValue": "NAME" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| active |\n| address1 |\n| address2 |\n| city |\n| country |\n| legacy |\n| name |\n| province |\n| zip |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "includeLegacy", "description": "If true, also include the legacy locations of fulfillment services.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "includeInactive", "description": "If true, also include the locations that are deactivated.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsCount", "description": "A count of all locations that are part of this location group.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocationGroupZone", "description": "Links a location group with a zone and the associated method definitions.", "fields": [ { "name": "methodDefinitionCounts", "description": "The number of method definitions for the zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryMethodDefinitionCounts", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "methodDefinitions", "description": "The method definitions associated to a zone and location group.", "args": [ { "name": "eligible", "description": "Return only eligible or ineligible method definitions.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "type", "description": "Return only merchant or participant method definitions.", "type": { "kind": "ENUM", "name": "DeliveryMethodDefinitionType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MethodDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryMethodDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "zone", "description": "The zone associated to a location group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryZone", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocationGroupZoneConnection", "description": "An auto-generated type for paginating through multiple DeliveryLocationGroupZones.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationGroupZoneEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeliveryLocationGroupZoneEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationGroupZone", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocationGroupZoneEdge", "description": "An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeliveryLocationGroupZoneEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationGroupZone", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryLocationGroupZoneInput", "description": "The input fields for a delivery zone associated to a location group and profile.", "fields": null, "inputFields": [ { "name": "id", "description": "A globally-unique ID of the zone.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "The name of the zone.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countries", "description": "A list of countries to associate with the zone.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryCountryInput", "ofType": null } } }, "defaultValue": null }, { "name": "methodDefinitionsToCreate", "description": "A list of method definitions to create.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryMethodDefinitionInput", "ofType": null } } }, "defaultValue": null }, { "name": "methodDefinitionsToUpdate", "description": "A list of method definitions to update.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryMethodDefinitionInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryLocationLocalPickupEnableInput", "description": "The input fields for a local pickup setting associated with a location.", "fields": null, "inputFields": [ { "name": "locationId", "description": "The ID of the location associated with the location setting.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "pickupTime", "description": "The time of the local pickup.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryLocalPickupTime", "ofType": null } }, "defaultValue": null }, { "name": "instructions", "description": "The instructions for the local pickup.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryLocationLocalPickupSettingsError", "description": "Represents an error that happened when changing local pickup settings for a location.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DeliveryLocationLocalPickupSettingsErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryLocationLocalPickupSettingsErrorCode", "description": "Possible error codes that can be returned by `DeliveryLocationLocalPickupSettingsError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE_LOCATION_NOT_FOUND", "description": "Provided locationId is not for an active location belonging to this store.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "An error occurred while changing the local pickup settings.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethod", "description": "The delivery method used by a fulfillment order.", "fields": [ { "name": "additionalInformation", "description": "The Additional information to consider when performing the delivery.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryMethodAdditionalInformation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "brandedPromise", "description": "The branded promise that was presented to the buyer during checkout. For example: Shop Promise.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryBrandedPromise", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxDeliveryDateTime", "description": "The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "methodType", "description": "The type of the delivery method.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeliveryMethodType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minDeliveryDateTime", "description": "The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "serviceCode", "description": "A reference to the shipping method.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethodAdditionalInformation", "description": "Additional information included on a delivery method that will help during the delivery process.\n", "fields": [ { "name": "instructions", "description": "The delivery instructions to follow when performing the delivery.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number to contact when performing the delivery.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethodDefinition", "description": "A method definition contains the delivery rate and the conditions that must be met for the method to be\napplied.\n", "fields": [ { "name": "active", "description": "Whether this method definition is active.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the method definition. Only available on shipping rates that are custom.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "methodConditions", "description": "The method conditions that must pass for this method definition to be applied to an order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCondition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the method definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rateProvider", "description": "The provided rate for this method definition, from a rate definition or participant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DeliveryRateProvider", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethodDefinitionConnection", "description": "An auto-generated type for paginating through multiple DeliveryMethodDefinitions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryMethodDefinitionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeliveryMethodDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryMethodDefinition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethodDefinitionCounts", "description": "The number of method definitions for a zone, separated into merchant-owned and participant definitions.\n", "fields": [ { "name": "participantDefinitionsCount", "description": "The number of participant method definitions for the specified zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rateDefinitionsCount", "description": "The number of merchant-defined method definitions for the specified zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryMethodDefinitionEdge", "description": "An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeliveryMethodDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryMethodDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryMethodDefinitionInput", "description": "The input fields for a method definition.", "fields": null, "inputFields": [ { "name": "id", "description": "A globally-unique ID of the method definition. Use only when updating a method definiton.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "The name of the method definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "The description of the method definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "active", "description": "Whether to use this method definition during rate calculation.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "rateDefinition", "description": "A rate definition to apply to the method definition.", "type": { "kind": "INPUT_OBJECT", "name": "DeliveryRateDefinitionInput", "ofType": null }, "defaultValue": null }, { "name": "participant", "description": "A participant to apply to the method definition.", "type": { "kind": "INPUT_OBJECT", "name": "DeliveryParticipantInput", "ofType": null }, "defaultValue": null }, { "name": "weightConditionsToCreate", "description": "A list of weight conditions on the method definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryWeightConditionInput", "ofType": null } } }, "defaultValue": null }, { "name": "priceConditionsToCreate", "description": "A list of price conditions on the method definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryPriceConditionInput", "ofType": null } } }, "defaultValue": null }, { "name": "conditionsToUpdate", "description": "A list of conditions to update on the method definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryUpdateConditionInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryMethodDefinitionType", "description": "The different types of method definitions to filter by.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MERCHANT", "description": "A static merchant-defined rate.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARTICIPANT", "description": "A dynamic participant rate.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DeliveryMethodType", "description": "Possible method types that a delivery method can have.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHIPPING", "description": "The order is shipped.", "isDeprecated": false, "deprecationReason": null }, { "name": "PICK_UP", "description": "The order is picked up by the customer.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "No delivery is needed.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETAIL", "description": "The order is delivered to a retail store.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCAL", "description": "The order is delivered using a local delivery service.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryParticipant", "description": "A participant defines carrier-calculated rates for shipping services\nwith a possible merchant-defined fixed fee or a percentage-of-rate fee.\n", "fields": [ { "name": "adaptToNewServicesFlag", "description": "Whether to display new shipping services automatically to the customer when the service becomes available.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "carrierService", "description": "The carrier used for this participant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fixedFee", "description": "The merchant-defined fixed fee for this participant.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "participantServices", "description": "The carrier-specific services offered by the participant, and whether each service is active.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryParticipantService", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "percentageOfRateFee", "description": "The merchant-defined percentage-of-rate fee for this participant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryParticipantInput", "description": "The input fields for a participant.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the participant.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "carrierServiceId", "description": "The ID of the carrier service for this participant.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "fixedFee", "description": "The fixed feed that's defined by the merchant for this participant.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "percentageOfRateFee", "description": "The merchant-defined percentage-of-rate fee for this participant.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "participantServices", "description": "The list of shipping services offered by the participant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryParticipantServiceInput", "ofType": null } } }, "defaultValue": null }, { "name": "adaptToNewServices", "description": "Whether to automatically display new shipping services to the customer when a service becomes available.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryParticipantService", "description": "A mail service provided by the participant.", "fields": [ { "name": "active", "description": "Whether the service is active.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryParticipantServiceInput", "description": "The input fields for a shipping service provided by a participant.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the service.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "active", "description": "Whether the service is active.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryPriceConditionInput", "description": "The input fields for a price-based condition of a delivery method definition.", "fields": null, "inputFields": [ { "name": "criteria", "description": "The monetary value to compare the price of an order to.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "operator", "description": "The operator to use for comparison.", "type": { "kind": "ENUM", "name": "DeliveryConditionOperator", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProductVariantsCount", "description": "How many product variants are in a profile. This count is capped at 500.", "fields": [ { "name": "capped", "description": "Whether the count has reached the cap of 500.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "count", "description": "The product variant count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfile", "description": "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.\n", "fields": [ { "name": "activeMethodDefinitionsCount", "description": "The number of active shipping rates for the profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "default", "description": "Whether this is the default profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyMode", "description": "Whether this shop has enabled legacy compatibility mode for delivery profiles.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsWithoutRatesCount", "description": "The number of locations without rates defined.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the delivery profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originLocationCount", "description": "The number of active origin locations for the profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsCount", "description": "How many product variants are in this profile.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsCountV2", "description": "How many product variants are in this profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProductVariantsCount", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `productVariantsCount` instead." }, { "name": "profileItems", "description": "The products and variants associated with this profile.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "profileLocationGroups", "description": "The location groups and associated zones using this profile.", "args": [ { "name": "locationGroupId", "description": "Filter the location groups of the profile by location group ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileLocationGroup", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroups", "description": "Selling plan groups associated with the specified delivery profile.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unassignedLocations", "description": "List of locations that haven't been assigned to a location group for this profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unassignedLocationsPaginated", "description": "List of locations that have not been assigned to a location group for this profile.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "zoneCountryCount", "description": "The number of countries with active rates to deliver to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileConnection", "description": "An auto-generated type for paginating through multiple DeliveryProfiles.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeliveryProfileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileEdge", "description": "An auto-generated type which holds one DeliveryProfile and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeliveryProfileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryProfileInput", "description": "The input fields for a delivery profile.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the delivery profile.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "profileLocationGroups", "description": "The list of location groups associated with the delivery profile.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProfileLocationGroupInput", "ofType": null } } }, "defaultValue": null }, { "name": "locationGroupsToCreate", "description": "The list of location groups to be created in the delivery profile.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProfileLocationGroupInput", "ofType": null } } }, "defaultValue": null }, { "name": "locationGroupsToUpdate", "description": "The list of location groups to be updated in the delivery profile.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProfileLocationGroupInput", "ofType": null } } }, "defaultValue": null }, { "name": "locationGroupsToDelete", "description": "The list of location groups to be deleted from the delivery profile.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "variantsToAssociate", "description": "The list of product variant IDs to be associated with the delivery profile.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "variantsToDissociate", "description": "The list of product variant IDs to be dissociated from the delivery profile.\nThe dissociated product variants are moved back to the default delivery profile.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "zonesToDelete", "description": "The list of zone IDs to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "methodDefinitionsToDelete", "description": "The list of method definition IDs to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "conditionsToDelete", "description": "The list of condition IDs to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "sellingPlanGroupsToAssociate", "description": "The list of selling plan groups to be associated with the delivery profile.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "sellingPlanGroupsToDissociate", "description": "The list of selling plan groups to be dissociated with the delivery profile.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileItem", "description": "A product and the subset of associated variants that are part of this delivery profile.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "A product associated with this profile.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variants", "description": "The product variants associated with this delivery profile.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileItemConnection", "description": "An auto-generated type for paginating through multiple DeliveryProfileItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DeliveryProfileItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileItemEdge", "description": "An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DeliveryProfileItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProfileLocationGroup", "description": "Links a location group with zones. Both are associated to a delivery profile.", "fields": [ { "name": "countriesInAnyZone", "description": "The countries already selected in any zone for the specified location group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCountryAndZone", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationGroup", "description": "The collection of locations that make up the specified location group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationGroup", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationGroupZones", "description": "The applicable zones associated to the specified location group.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationGroupZoneConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryProfileLocationGroupInput", "description": "The input fields for a location group associated to a delivery profile.", "fields": null, "inputFields": [ { "name": "id", "description": "The globally-unique ID of the delivery profile location group.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "locations", "description": "The list of location IDs to be moved to this location group.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "locationsToAdd", "description": "The list of location IDs to be added to this location group.\n\n**Note:** due to API input array limits, a maximum of 250 items can be sent per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "locationsToRemove", "description": "The list of location IDs to be removed from this location group.\n\n**Note:** due to API input array limits, a maximum of 250 items can be sent per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "zonesToCreate", "description": "The list of location group zones to create.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryLocationGroupZoneInput", "ofType": null } } }, "defaultValue": null }, { "name": "zonesToUpdate", "description": "The list of location group zones to update.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryLocationGroupZoneInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryProvince", "description": "A region that is used to define a shipping zone.", "fields": [ { "name": "code", "description": "The code of the region.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The full name of the region.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatedName", "description": "The translated name of the region. The translation returned is based on the system's locale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryProvinceInput", "description": "The input fields to specify a region.", "fields": null, "inputFields": [ { "name": "code", "description": "The code of the region.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryRateDefinition", "description": "The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition).", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of this rate.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryRateDefinitionInput", "description": "The input fields for a rate definition.", "fields": null, "inputFields": [ { "name": "id", "description": "A globally-unique ID of the rate definition.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of the rate definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DeliveryRateProvider", "description": "A rate provided by a merchant-defined rate or a participant.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DeliveryParticipant", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryRateDefinition", "ofType": null } ] }, { "kind": "OBJECT", "name": "DeliverySetting", "description": "The `DeliverySetting` object enables you to manage shop-wide shipping settings.\nYou can enable legacy compatibility mode for the multi-location delivery profiles feature\nif the legacy mode isn't blocked.\n", "fields": [ { "name": "legacyModeBlocked", "description": "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.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLegacyModeBlocked", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyModeProfiles", "description": "Enables legacy compatability mode for the multi-location delivery profiles feature.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliverySettingInput", "description": "The input fields for shop-level delivery settings.", "fields": null, "inputFields": [ { "name": "legacyModeProfiles", "description": "Whether legacy compatability mode is enabled for the multi-location delivery profiles feature.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliverySettingUpdatePayload", "description": "Return type for `deliverySettingUpdate` mutation.", "fields": [ { "name": "setting", "description": "The updated delivery shop level settings.", "args": [], "type": { "kind": "OBJECT", "name": "DeliverySetting", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryShippingOriginAssignPayload", "description": "Return type for `deliveryShippingOriginAssign` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryUpdateConditionInput", "description": "The input fields for updating the condition of a delivery method definition.", "fields": null, "inputFields": [ { "name": "id", "description": "A globally-unique ID of the condition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "criteria", "description": "The value that will be used in comparison.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "criteriaUnit", "description": "The unit associated with the value that will be used in comparison.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "field", "description": "The property of an order that will be used in comparison.", "type": { "kind": "ENUM", "name": "DeliveryConditionField", "ofType": null }, "defaultValue": null }, { "name": "operator", "description": "The operator to use for comparison.", "type": { "kind": "ENUM", "name": "DeliveryConditionOperator", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DeliveryWeightConditionInput", "description": "The input fields for a weight-based condition of a delivery method definition.", "fields": null, "inputFields": [ { "name": "criteria", "description": "The weight value to compare the weight of an order to.", "type": { "kind": "INPUT_OBJECT", "name": "WeightInput", "ofType": null }, "defaultValue": null }, { "name": "operator", "description": "The operator to use for comparison.", "type": { "kind": "ENUM", "name": "DeliveryConditionOperator", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeliveryZone", "description": "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.\n", "fields": [ { "name": "countries", "description": "The list of countries within the zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCountry", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the zone.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DigitalWallet", "description": "Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APPLE_PAY", "description": "Apple Pay.", "isDeprecated": false, "deprecationReason": null }, { "name": "ANDROID_PAY", "description": "Android Pay.", "isDeprecated": false, "deprecationReason": null }, { "name": "GOOGLE_PAY", "description": "Google Pay.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOPIFY_PAY", "description": "Shopify Pay.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "Discount", "description": "A discount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountAutomaticApp", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBasic", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticFreeShipping", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeApp", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeBasic", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeFreeShipping", "ofType": null } ] }, { "kind": "OBJECT", "name": "DiscountAllocation", "description": "An amount that's allocated to a line based on an associated discount application.", "fields": [ { "name": "allocatedAmount", "description": "The money amount that's allocated to a line based on the associated discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `allocatedAmountSet` instead." }, { "name": "allocatedAmountSet", "description": "The money amount that's allocated to a line based on the associated discount application in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountApplication", "description": "The discount application that the allocated amount originated from.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAmount", "description": "The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items.", "fields": [ { "name": "amount", "description": "The value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOnEachItem", "description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountAmountInput", "description": "The input fields for the value of the discount and how it is applied.", "fields": null, "inputFields": [ { "name": "amount", "description": "The value of the discount.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "appliesOnEachItem", "description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "DiscountApplication", "description": "Discount applications capture the intentions of a discount source at\nthe time of application on an order's line items or shipping lines.\n\nDiscount 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.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "index", "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AutomaticDiscountApplication", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeApplication", "ofType": null }, { "kind": "OBJECT", "name": "ManualDiscountApplication", "ofType": null }, { "kind": "OBJECT", "name": "ScriptDiscountApplication", "ofType": null } ] }, { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "description": "The method by which the discount's value is allocated onto its entitled lines.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACROSS", "description": "The value is spread across all entitled lines.", "isDeprecated": false, "deprecationReason": null }, { "name": "EACH", "description": "The value is applied onto every entitled line.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONE", "description": "The value is specifically applied onto a particular line.", "isDeprecated": true, "deprecationReason": "Use ACROSS instead." } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountApplicationConnection", "description": "An auto-generated type for paginating through multiple DiscountApplications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountApplicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountApplicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountApplicationEdge", "description": "An auto-generated type which holds one DiscountApplication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountApplicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountApplicationLevel", "description": "The level at which the discount's value is applied.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ORDER", "description": "The discount is applied at the order level.\nOrder level discounts are not factored into the discountedUnitPriceSet on line items.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "LINE", "description": "The discount is applied at the line level.\nLine level discounts are factored into the discountedUnitPriceSet on line items.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "description": "The lines on the order to which the discount is applied, of the type defined by\nthe discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of\n`LINE_ITEM`, applies the discount on all line items that are entitled to the discount.\nThe value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALL", "description": "The discount is allocated onto all the lines.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENTITLED", "description": "The discount is allocated onto only the lines that it's entitled for.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPLICIT", "description": "The discount is allocated onto explicitly chosen lines.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountApplicationTargetType", "description": "The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LINE_ITEM", "description": "The discount applies onto line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_LINE", "description": "The discount applies onto shipping lines.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "DiscountAutomatic", "description": "The type of discount associated to the automatic discount. For example, the automatic discount might offer a basic discount using a fixed percentage, or a fixed amount, on specific products from the order. The automatic discount may also be a BXGY discount, which offers customer discounts on select products if they add a specific product to their order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountAutomaticApp", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBasic", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticFreeShipping", "ofType": null } ] }, { "kind": "OBJECT", "name": "DiscountAutomaticActivatePayload", "description": "Return type for `discountAutomaticActivate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The activated automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticApp", "description": "An automatic app discount.", "fields": [ { "name": "appDiscountType", "description": "The app discount type providing the discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppDiscountType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountId", "description": "The ID for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorHistory", "description": "The error history on the most recent version of the app discount.", "args": [], "type": { "kind": "OBJECT", "name": "FunctionsErrorHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticAppCreatePayload", "description": "Return type for `discountAutomaticAppCreate` mutation.", "fields": [ { "name": "automaticAppDiscount", "description": "The created app discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticAppInput", "description": "The input fields to create an app discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "functionId", "description": "The ID of the function providing the app discount type.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional metafields to associate to the discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticAppUpdatePayload", "description": "Return type for `discountAutomaticAppUpdate` mutation.", "fields": [ { "name": "automaticAppDiscount", "description": "The updated automatic app discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBasic", "description": "An automatic discount that offers customers a percentage discount, or fixed amount discount, on specific products, collections, or the entire order.", "fields": [ { "name": "asyncUsageCount", "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerGets", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MerchandiseDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountMinimumRequirement", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shortSummary", "description": "A short summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `asyncUsageCount` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBasicCreatePayload", "description": "Return type for `discountAutomaticBasicCreate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The created automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBasicInput", "description": "The input fields to create or update an automatic basic discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumRequirementInput", "ofType": null }, "defaultValue": null }, { "name": "customerGets", "description": "Information about the qualifying items and their discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsInput", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBasicUpdatePayload", "description": "Return type for `discountAutomaticBasicUpdate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The updated automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBulkDeletePayload", "description": "Return type for `discountAutomaticBulkDelete` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the automatic discounts.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgy", "description": "An automatic discount that offers customers a Buy X, Get Y (BXGY) discount.", "fields": [ { "name": "asyncUsageCount", "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerBuys", "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerBuys", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerGets", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MerchandiseDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A legacy unique ID for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use DiscountAutomaticNode.id instead." }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `asyncUsageCount` instead." }, { "name": "usesPerOrderLimit", "description": "The maximum number of times that the discount can be applied to an order.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgyCreatePayload", "description": "Return type for `discountAutomaticBxgyCreate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The created automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBxgyInput", "description": "The input fields to create or update an automatic Buy X, Get Y (BXGY) discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "usesPerOrderLimit", "description": "The maximum number of times that the discount can be applied to an order.", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null }, { "name": "customerBuys", "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerBuysInput", "ofType": null }, "defaultValue": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgyUpdatePayload", "description": "Return type for `discountAutomaticBxgyUpdate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The updated automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticConnection", "description": "An auto-generated type for paginating through multiple DiscountAutomatics.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountAutomaticEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountAutomatic", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticDeactivatePayload", "description": "Return type for `discountAutomaticDeactivate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The deactivated automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticDeletePayload", "description": "Return type for `discountAutomaticDelete` mutation.", "fields": [ { "name": "deletedAutomaticDiscountId", "description": "The deleted automatic discount ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticEdge", "description": "An auto-generated type which holds one DiscountAutomatic and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountAutomaticEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountAutomatic", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticFreeShipping", "description": "An automatic discount that offers customers free shipping on their order.", "fields": [ { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times that the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "destinationSelection", "description": "A shipping destination that qualifies for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountShippingDestinationSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShippingDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumShippingPrice", "description": "The maximum shipping price amount accepted to qualify for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountMinimumRequirement", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shortSummary", "description": "A short summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the discount was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticFreeShippingCreatePayload", "description": "Return type for `discountAutomaticFreeShippingCreate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The created automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticFreeShippingInput", "description": "The input fields to create or update free shipping automatic discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the shipping discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumRequirementInput", "ofType": null }, "defaultValue": null }, { "name": "destination", "description": "A list of destinations where the discount will apply.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountShippingDestinationSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "maximumShippingPrice", "description": "The maximum shipping price that qualifies for the discount.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticFreeShippingUpdatePayload", "description": "Return type for `discountAutomaticFreeShippingUpdate` mutation.", "fields": [ { "name": "automaticDiscountNode", "description": "The updated automatic discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "description": "A node containing an automatic discount and its related events.", "fields": [ { "name": "automaticDiscount", "description": "The automatic discount object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountAutomatic", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNodeConnection", "description": "An auto-generated type for paginating through multiple DiscountAutomaticNodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticNodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountAutomaticNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNodeEdge", "description": "An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountAutomaticNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountClass", "description": "The class of the discount for combining purposes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT", "description": "Combined as a product discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER", "description": "Combined as an order discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING", "description": "Combined as a shipping discount.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "DiscountCode", "description": "The type of discount associated with the discount code. For example, the discount code might offer a basic discount of a fixed percentage, or a fixed amount, on specific products or the order. Alternatively, the discount might offer the customer free shipping on their order. A third option is a Buy X, Get Y (BXGY) discount, which offers a customer discounts on select products if they add a specific product to their order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountCodeApp", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeBasic", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeFreeShipping", "ofType": null } ] }, { "kind": "OBJECT", "name": "DiscountCodeActivatePayload", "description": "Return type for `discountCodeActivate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The activated code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeApp", "description": "A code app discount.", "fields": [ { "name": "appDiscountType", "description": "The app discount type providing the discount type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppDiscountType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codes", "description": "A list of redeem codes for the discount.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codesCount", "description": "The number of redeem codes for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountId", "description": "The ID for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorHistory", "description": "The error history on the most recent version of the discount.", "args": [], "type": { "kind": "OBJECT", "name": "FunctionsErrorHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shareableUrls", "description": "URLs that can be used to share the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountShareableUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the discount was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeAppCreatePayload", "description": "Return type for `discountCodeAppCreate` mutation.", "fields": [ { "name": "codeAppDiscount", "description": "The created code app discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCodeAppInput", "description": "The input fields to create a code app discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "functionId", "description": "The ID of the function providing the app discount type.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "The code to use the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional metafields to associate to the discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeAppUpdatePayload", "description": "Return type for `discountCodeAppUpdate` mutation.", "fields": [ { "name": "codeAppDiscount", "description": "The updated code app discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeApplication", "description": "Discount code applications capture the intentions of a discount code at\nthe time that it is applied onto an order.\n\nDiscount 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.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "The string identifying the discount code that was used at the time of application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "index", "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBasic", "description": "A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order.", "fields": [ { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codes", "description": "A list of redeem codes for the discount.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codesCount", "description": "The number of redeem codes for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerGets", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MerchandiseDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "args": [], "type": { "kind": "UNION", "name": "DiscountMinimumRequirement", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shareableUrls", "description": "URLs that can be used to share the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountShareableUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shortSummary", "description": "A short summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the discount was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBasicCreatePayload", "description": "Return type for `discountCodeBasicCreate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The created code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCodeBasicInput", "description": "The input fields to create or update a basic code discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumRequirementInput", "ofType": null }, "defaultValue": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsInput", "ofType": null }, "defaultValue": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "The code to use the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBasicUpdatePayload", "description": "Return type for `discountCodeBasicUpdate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The updated code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBulkActivatePayload", "description": "Return type for `discountCodeBulkActivate` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that activates the code discounts.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBulkDeactivatePayload", "description": "Return type for `discountCodeBulkDeactivate` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that deactivates the code discounts.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBulkDeletePayload", "description": "Return type for `discountCodeBulkDelete` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that deletes the code discounts.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBxgy", "description": "A code discount that offers customers a Buy X, Get Y (BXGY) discount.", "fields": [ { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codes", "description": "A list of redeem codes for the discount.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codesCount", "description": "The number of redeem codes for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerBuys", "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerBuys", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCustomerGets", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MerchandiseDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shareableUrls", "description": "URLs that can be used to share the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountShareableUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the discount was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "usesPerOrderLimit", "description": "The maximum number of times that the discount can be applied to an order.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBxgyCreatePayload", "description": "Return type for `discountCodeBxgyCreate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The created code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCodeBxgyInput", "description": "The input fields to create or update a BXGY code discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "customerBuys", "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerBuysInput", "ofType": null }, "defaultValue": null }, { "name": "customerGets", "description": "The qualifying items that will be discounted, the quantity of each one, and the total value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsInput", "ofType": null }, "defaultValue": null }, { "name": "customerSelection", "description": "The customers that are eligible to use the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "The code to use the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "usesPerOrderLimit", "description": "The maximum number of times that the discount can be applied to an order.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeBxgyUpdatePayload", "description": "Return type for `discountCodeBxgyUpdate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The updated code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeDeactivatePayload", "description": "Return type for `discountCodeDeactivate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The deactivated code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeDeletePayload", "description": "Return type for `discountCodeDelete` mutation.", "fields": [ { "name": "deletedCodeDiscountId", "description": "The deleted code discount ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeFreeShipping", "description": "A code discount that offers customers free shipping on their order.", "fields": [ { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "asyncUsageCount", "description": "The number of times that the discount has been used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codes", "description": "A list of redeem codes for the discount.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codesCount", "description": "The number of redeem codes for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the discount was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSelection", "description": "The customers that can use the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "destinationSelection", "description": "A shipping destination that qualifies for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountShippingDestinationSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShippingDiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumShippingPrice", "description": "The maximum shipping price amount accepted to qualify for the discount.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "args": [], "type": { "kind": "UNION", "name": "DiscountMinimumRequirement", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shareableUrls", "description": "URLs that can be used to share the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountShareableUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shortSummary", "description": "A short summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the discount was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the discount was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeFreeShippingCreatePayload", "description": "Return type for `discountCodeFreeShippingCreate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The created code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCodeFreeShippingInput", "description": "The input fields to create or update a free shipping code discount.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the shipping discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "startsAt", "description": "The date and time when the discount starts.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "endsAt", "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "The code to use the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "usageLimit", "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "appliesOncePerCustomer", "description": "Whether the discount can be applied only once per customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "minimumRequirement", "description": "The minimum subtotal or quantity that's required for the discount to be applied.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumRequirementInput", "ofType": null }, "defaultValue": null }, { "name": "customerSelection", "description": "The customers that are eligible to use the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "destination", "description": "A list of destinations where the discount will apply.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountShippingDestinationSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "maximumShippingPrice", "description": "The maximum shipping price that qualifies for the discount.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The number of times a discount applies on recurring purchases (subscriptions).", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeFreeShippingUpdatePayload", "description": "Return type for `discountCodeFreeShippingUpdate` mutation.", "fields": [ { "name": "codeDiscountNode", "description": "The updated code discount.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "description": "A node containing a code discount and its related events.", "fields": [ { "name": "codeDiscount", "description": "The underlying code discount object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeNodeConnection", "description": "An auto-generated type for paginating through multiple DiscountCodeNodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCodeNodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountCodeNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeNodeEdge", "description": "An auto-generated type which holds one DiscountCodeNode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountCodeNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCodeRedeemCodeBulkDeletePayload", "description": "Return type for `discountCodeRedeemCodeBulkDelete` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that deletes the discount redeem codes.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountCodeSortKeys", "description": "The set of valid sort keys for the DiscountCode query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CODE", "description": "Sort by the `code` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCollections", "description": "A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied.", "fields": [ { "name": "collections", "description": "The list of collections that the discount can have as a prerequisite or the list of collections to which the discount can be applied.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCollectionsInput", "description": "The input fields for collections attached to a discount.", "fields": null, "inputFields": [ { "name": "add", "description": "Specifies list of collection ids to add.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "remove", "description": "Specifies list of collection ids to remove.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCombinesWith", "description": "Determines which discount classes the discount can combine with.", "fields": [ { "name": "orderDiscounts", "description": "Combines with order discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDiscounts", "description": "Combines with product discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingDiscounts", "description": "Combines with shipping discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "description": "The input fields to determine which discount classes the discount can combine with.", "fields": null, "inputFields": [ { "name": "productDiscounts", "description": "Combines with product discounts.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "orderDiscounts", "description": "Combines with order discounts.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "shippingDiscounts", "description": "Combines with shipping discounts.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCountries", "description": "The shipping destinations where the discount can be applied.", "fields": [ { "name": "countries", "description": "The codes for the countries where the discount can be applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "includeRestOfWorld", "description": "Whether the discount is applicable to countries that haven't been defined in the shop's shipping zones.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCountriesInput", "description": "The input fields for a list of countries to add or remove from the free shipping discount.", "fields": null, "inputFields": [ { "name": "add", "description": "The country codes to add to the list of countries where the discount applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "remove", "description": "The country codes to remove from the list of countries where the discount applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "includeRestOfWorld", "description": "Whether the discount code is applicable to countries that haven't been defined in the shop's shipping zones.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCountryAll", "description": "The `DiscountCountryAll` object lets you target all countries as shipping destination for discount eligibility.", "fields": [ { "name": "allCountries", "description": "Whether the discount can be applied to all countries as shipping destination. This value is always `true`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCustomerAll", "description": "The `DiscountCustomerAll` object lets you target all customers for discount eligibility.", "fields": [ { "name": "allCustomers", "description": "Whether the discount can be applied by all customers. This value is always `true`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCustomerBuys", "description": "The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable.", "fields": [ { "name": "items", "description": "The items required for the discount to be applicable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountItems", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The prerequisite value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerBuysValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerBuysInput", "description": "The input fields for prerequisite items and quantity for the discount.", "fields": null, "inputFields": [ { "name": "value", "description": "The quantity of prerequisite items.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerBuysValueInput", "ofType": null }, "defaultValue": null }, { "name": "items", "description": "The IDs of items that the customer buys. The items can be either collections or products.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountItemsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DiscountCustomerBuysValue", "description": "The prerequisite for the discount to be applicable. For example, the discount might require a customer to buy a minimum quantity of select items. Alternatively, the discount might require a customer to spend a minimum amount on select items.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountPurchaseAmount", "ofType": null }, { "kind": "OBJECT", "name": "DiscountQuantity", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerBuysValueInput", "description": "The input fields for prerequisite quantity or minimum purchase amount required for the discount.", "fields": null, "inputFields": [ { "name": "quantity", "description": "The quantity of prerequisite items.", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null }, { "name": "amount", "description": "The prerequisite minimum purchase amount required for the discount to be applicable.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCustomerGets", "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", "fields": [ { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "The items to which the discount applies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountItems", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Entitled quantity and the discount value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountCustomerGetsValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsInput", "description": "Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.", "fields": null, "inputFields": [ { "name": "value", "description": "The quantity of items discounted and the discount value.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsValueInput", "ofType": null }, "defaultValue": null }, { "name": "items", "description": "The IDs of the items that the customer gets. The items can be either collections or products.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountItemsInput", "ofType": null }, "defaultValue": null }, { "name": "appliesOnOneTimePurchase", "description": "Whether the discount applies on regular one-time-purchase items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "appliesOnSubscription", "description": "Whether the discount applies on subscription items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DiscountCustomerGetsValue", "description": "The type of the discount value and how it will be applied. For example, it might be a percentage discount on a fixed number of items. Alternatively, it might be a fixed amount evenly distributed across all items or on each individual item. A third example is a percentage discount on all items.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountAmount", "ofType": null }, { "kind": "OBJECT", "name": "DiscountOnQuantity", "ofType": null }, { "kind": "OBJECT", "name": "DiscountPercentage", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerGetsValueInput", "description": "The input fields for the quantity of items discounted and the discount value.", "fields": null, "inputFields": [ { "name": "discountOnQuantity", "description": "The quantity of the items that are discounted and the discount value.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountOnQuantityInput", "ofType": null }, "defaultValue": null }, { "name": "percentage", "description": "The percentage value of the discount. Value must be between 0.00 - 1.00.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "discountAmount", "description": "The value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountAmountInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCustomerSegments", "description": "A list of customer segments that contain the customers that the discount applies to.", "fields": [ { "name": "segments", "description": "A list of customer segments that contain the customers who can use the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Segment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSegmentsInput", "description": "The input fields for which customer segments to add to or remove from the discount.", "fields": null, "inputFields": [ { "name": "add", "description": "A list of customer segments to add to the current list of customer segments.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "remove", "description": "A list of customer segments to remove from the current list of customer segments.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DiscountCustomerSelection", "description": "The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountCustomerAll", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCustomerSegments", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCustomers", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSelectionInput", "description": "The input fields for the customers who can use this discount.", "fields": null, "inputFields": [ { "name": "all", "description": "Whether all customers can use this discount.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "customers", "description": "The list of customer IDs to add or remove from the list of customers.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomersInput", "ofType": null }, "defaultValue": null }, { "name": "customerSegments", "description": "The list of customer segment IDs to add or remove from the list of customer segments.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCustomerSegmentsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountCustomers", "description": "A list of customers eligible for the discount.", "fields": [ { "name": "customers", "description": "The list of customers eligible for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountCustomersInput", "description": "The input fields for which customers to add to or remove from the discount.", "fields": null, "inputFields": [ { "name": "add", "description": "A list of customers to add to the current list of customers who can use the discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "remove", "description": "A list of customers to remove from the current list of customers who can use the discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DiscountEffect", "description": "The type of discount that will be applied. Currently, only a percentage discount is supported.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountAmount", "ofType": null }, { "kind": "OBJECT", "name": "DiscountPercentage", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountEffectInput", "description": "The input fields for how the discount will be applied. Currently, only percentage off is supported.", "fields": null, "inputFields": [ { "name": "percentage", "description": "The percentage value of the discount. Value must be between 0.00 - 1.00.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "amount", "description": "The value of the discount.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountErrorCode", "description": "Possible error codes that can be returned by `DiscountUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "EQUAL_TO", "description": "The input value should be equal to the value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The input value should be greater than or equal to the minimum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The input value should be less than the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_ARGUMENTS", "description": "Too many arguments provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENT", "description": "Missing a required argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE_PERIOD_OVERLAP", "description": "The active period overlaps with other automatic discounts. At any given time, only one automatic discount can be active.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCEEDED_MAX", "description": "The value exceeded the maximum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "MINIMUM_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT", "description": "Specify a minimum subtotal or a quantity, but not both.", "isDeprecated": false, "deprecationReason": null }, { "name": "VALUE_OUTSIDE_RANGE", "description": "The value is outside of the allowed range.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFLICT", "description": "The attribute selection contains conflicting settings.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMPLICIT_DUPLICATE", "description": "The value is already present through another selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE", "description": "The input value is already present.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS", "description": "The `combinesWith` settings are invalid for the discount class.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE", "description": "The discountClass is invalid for the price rule.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAX_APP_DISCOUNTS", "description": "The active period overlaps with too many other app-provided discounts. There's a limit on the number of app discounts that can be active at any given time.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "DiscountItems", "description": "The type used to target the items required for discount eligibility, or the items to which the application of a discount might apply. For example, for a customer to be eligible for a discount, they're required to add an item from a specified collection to their order. Alternatively, a customer might be required to add a specific product or product variant. When using this type to target which items the discount will apply to, the discount might apply to all items on the order, or to specific products and product variants, or items in a given collection.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AllDiscountItems", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCollections", "ofType": null }, { "kind": "OBJECT", "name": "DiscountProducts", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountItemsInput", "description": "The input fields for the items attached to a discount. You can specify the discount items by product ID or collection ID.\n", "fields": null, "inputFields": [ { "name": "products", "description": "The products and product variants that are attached to a discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountProductsInput", "ofType": null }, "defaultValue": null }, { "name": "collections", "description": "The collections that are attached to a discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCollectionsInput", "ofType": null }, "defaultValue": null }, { "name": "all", "description": "Whether all items should be selected.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountMinimumQuantity", "description": "The minimum quantity of items required for the discount to apply.", "fields": [ { "name": "greaterThanOrEqualToQuantity", "description": "The minimum quantity of items that's required for the discount to be applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountMinimumQuantityInput", "description": "The input fields for the minimum quantity required for the discount.", "fields": null, "inputFields": [ { "name": "greaterThanOrEqualToQuantity", "description": "The minimum quantity of items that's required for the discount to be applied.", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "DiscountMinimumRequirement", "description": "The type of minimum requirement that must be met for the discount to be applied. For example, a customer must spend a minimum subtotal to be eligible for the discount. Alternatively, a customer must purchase a minimum quantity of items to be eligible for the discount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountMinimumQuantity", "ofType": null }, { "kind": "OBJECT", "name": "DiscountMinimumSubtotal", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountMinimumRequirementInput", "description": "The input fields for the minimum quantity or subtotal required for a discount.", "fields": null, "inputFields": [ { "name": "quantity", "description": "The minimum required quantity.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumQuantityInput", "ofType": null }, "defaultValue": null }, { "name": "subtotal", "description": "The minimum required subtotal.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountMinimumSubtotalInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountMinimumSubtotal", "description": "The minimum subtotal required for the discount to apply.", "fields": [ { "name": "greaterThanOrEqualToSubtotal", "description": "The minimum subtotal that's required for the discount to be applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountMinimumSubtotalInput", "description": "The input fields for the minimum subtotal required for a discount.", "fields": null, "inputFields": [ { "name": "greaterThanOrEqualToSubtotal", "description": "The minimum subtotal that's required for the discount to be applied.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountNode", "description": "A discount wrapper node.", "fields": [ { "name": "discount", "description": "A discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountNodeConnection", "description": "An auto-generated type for paginating through multiple DiscountNodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountNodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountNode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountNodeEdge", "description": "An auto-generated type which holds one DiscountNode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountNodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountNode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountOnQuantity", "description": "The quantity of items discounted, the discount value, and how the discount will be applied.", "fields": [ { "name": "effect", "description": "The discount's effect on qualifying items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "DiscountEffect", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of items being discounted. The customer must have at least this many items of specified products or product variants in their order to be eligible for the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountQuantity", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountOnQuantityInput", "description": "The input fields for the quantity of items discounted and the discount value.", "fields": null, "inputFields": [ { "name": "quantity", "description": "The quantity of items that are discounted.", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null }, { "name": "effect", "description": "The percentage value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountEffectInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountPercentage", "description": "A discount effect that gives customers a percentage off of specified items on their order.", "fields": [ { "name": "percentage", "description": "The percentage value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountProducts", "description": "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.", "fields": [ { "name": "productVariants", "description": "The list of product variants that the discount can have as a prerequisite or the list of product variants to which the discount can be applied.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The list of products that the discount can have as a prerequisite or the list of products to which the discount can be applied.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountProductsInput", "description": "The input fields for the products and product variants attached to a discount.", "fields": null, "inputFields": [ { "name": "productsToAdd", "description": "Specifies list of product ids to add.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productsToRemove", "description": "Specifies list of product ids to remove.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productVariantsToAdd", "description": "Specifies list of product variant ids to add.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productVariantsToRemove", "description": "Specifies list of product variant ids to remove.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountPurchaseAmount", "description": "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.", "fields": [ { "name": "amount", "description": "The purchase amount in decimal format.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountQuantity", "description": "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.", "fields": [ { "name": "quantity", "description": "The quantity of items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCode", "description": "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.", "fields": [ { "name": "asyncUsageCount", "description": "The number of times that the discount redeem code has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "The code that a customer can use at checkout to receive a discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdBy", "description": "The application that created the discount redeem code.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID of the discount redeem code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkAddPayload", "description": "Return type for `discountRedeemCodeBulkAdd` mutation.", "fields": [ { "name": "bulkCreation", "description": "The ID of the discount redeem code bulk creation operation. The properties and status of the operation can be tracked using the [`DiscountRedeemCodeBulkCreation` query](https://shopify.dev/api/admin-graphql/2022-04/queries/discountRedeemCodeBulkCreation).", "args": [], "type": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreation", "description": "The properties and status of a bulk discount redeem code creation operation.", "fields": [ { "name": "codes", "description": "The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codesCount", "description": "The number of codes to create.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the bulk creation was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCode", "description": "The code discount associated with the created codes.", "args": [], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "done", "description": "Whether the bulk creation is still queued (`false`) or has been run (`true`).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "failedCount", "description": "The number of codes that weren't created successfully.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "importedCount", "description": "The number of codes created successfully.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCode", "description": "A result of a discount redeem code creation operation created by a bulk creation.", "fields": [ { "name": "code", "description": "The code to use in the discount redeem code creation operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountRedeemCode", "description": "The successfully created discount redeem code.\n\nIf the discount redeem code couldn't be created, then this field is `null``.\n", "args": [], "type": { "kind": "OBJECT", "name": "DiscountRedeemCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "errors", "description": "A list of errors that occurred during the creation operation of the discount redeem code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCodeConnection", "description": "An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountRedeemCodeBulkCreationCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCodeEdge", "description": "An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountRedeemCodeBulkCreationCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreationCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeConnection", "description": "An auto-generated type for paginating through multiple DiscountRedeemCodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DiscountRedeemCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeEdge", "description": "An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DiscountRedeemCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountRedeemCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DiscountRedeemCodeInput", "description": "The input fields for the redeem code to attach to a discount.", "fields": null, "inputFields": [ { "name": "code", "description": "The code that a customer can use at checkout to receive the associated discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountShareableUrl", "description": "A shareable URL for a discount code.", "fields": [ { "name": "targetItemImage", "description": "The image URL of the item (product or collection) to which the discount applies.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "The type of page that's associated with the URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountShareableUrlTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the page that's associated with the URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL for the discount code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountShareableUrlTargetType", "description": "The type of page where a shareable discount URL lands.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HOME", "description": "The URL lands on a home page.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT", "description": "The URL lands on a product page.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION", "description": "The URL lands on a collection page.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "DiscountShippingDestinationSelection", "description": "The type used to target the eligible countries of an order's shipping destination for which the discount applies. For example, the discount might be applicable when shipping to all countries, or only to a set of countries.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DiscountCountries", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCountryAll", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "DiscountShippingDestinationSelectionInput", "description": "The input fields for the destinations where the free shipping discount will be applied.", "fields": null, "inputFields": [ { "name": "all", "description": "Whether the discount code applies to all countries.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "countries", "description": "A list of countries where the discount code will apply.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCountriesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountSortKeys", "description": "The set of valid sort keys for the Discount query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STARTS_AT", "description": "Sort by the `starts_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENDS_AT", "description": "Sort by the `ends_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountStatus", "description": "The status of the discount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The discount is active.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The discount is expired.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "The discount is scheduled when it has a start date in the future.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountTargetType", "description": "The type of line (line item or shipping line) on an order that the subscription discount is applicable towards.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LINE_ITEM", "description": "The discount applies onto line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_LINE", "description": "The discount applies onto shipping lines.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DiscountType", "description": "The type of the subscription discount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MANUAL", "description": "Manual discount type.", "isDeprecated": false, "deprecationReason": null }, { "name": "CODE_DISCOUNT", "description": "Code discount type.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTOMATIC_DISCOUNT", "description": "Automatic discount type.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DiscountUserError", "description": "An error that occurs during the execution of a discount mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DiscountErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "extraInfo", "description": "Extra information about this error.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "DisplayableError", "description": "Represents an error in the input of a mutation.", "fields": [ { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AbandonmentEmailStateUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", "ofType": null }, { "kind": "OBJECT", "name": "AppSubscriptionTrialExtendUserError", "ofType": null }, { "kind": "OBJECT", "name": "BillingAttemptUserError", "ofType": null }, { "kind": "OBJECT", "name": "BulkMutationUserError", "ofType": null }, { "kind": "OBJECT", "name": "BulkProductResourceFeedbackCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "BusinessCustomerUserError", "ofType": null }, { "kind": "OBJECT", "name": "CartTransformCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "CartTransformDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "CatalogUserError", "ofType": null }, { "kind": "OBJECT", "name": "CheckoutBrandingUpsertUserError", "ofType": null }, { "kind": "OBJECT", "name": "CollectionAddProductsV2UserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerCancelDataErasureUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerMergeUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetDuplicationDataUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodGetUpdateUrlUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethodUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerRequestDataErasureUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerSegmentMembersQueryUserError", "ofType": null }, { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentError", "ofType": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "DelegateAccessTokenDestroyUserError", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCustomizationError", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryLocationLocalPickupSettingsError", "ofType": null }, { "kind": "OBJECT", "name": "DiscountUserError", "ofType": null }, { "kind": "OBJECT", "name": "DisputeEvidenceUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "ofType": null }, { "kind": "OBJECT", "name": "ErrorsWebPixelUserError", "ofType": null }, { "kind": "OBJECT", "name": "FilesUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderHoldUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMergeUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderReleaseHoldUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderRescheduleUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSplitUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersReleaseHoldsUserError", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardUserError", "ofType": null }, { "kind": "OBJECT", "name": "InventoryAdjustQuantitiesUserError", "ofType": null }, { "kind": "OBJECT", "name": "InventoryBulkToggleActivationUserError", "ofType": null }, { "kind": "OBJECT", "name": "InventoryMoveQuantitiesUserError", "ofType": null }, { "kind": "OBJECT", "name": "InventorySetOnHandQuantitiesUserError", "ofType": null }, { "kind": "OBJECT", "name": "InventorySetScheduledChangesUserError", "ofType": null }, { "kind": "OBJECT", "name": "LocationActivateUserError", "ofType": null }, { "kind": "OBJECT", "name": "LocationAddUserError", "ofType": null }, { "kind": "OBJECT", "name": "LocationDeactivateUserError", "ofType": null }, { "kind": "OBJECT", "name": "LocationDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "LocationEditUserError", "ofType": null }, { "kind": "OBJECT", "name": "MarketCurrencySettingsUserError", "ofType": null }, { "kind": "OBJECT", "name": "MarketUserError", "ofType": null }, { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null }, { "kind": "OBJECT", "name": "MediaUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionPinUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUnpinUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldsSetUserError", "ofType": null }, { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderCancelUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderCreateMandatePaymentUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditAddShippingLineUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditRemoveDiscountUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditRemoveShippingLineUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditUpdateDiscountUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditUpdateShippingLineUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderInvoiceSendUserError", "ofType": null }, { "kind": "OBJECT", "name": "OrderRiskAssessmentCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PaymentCustomizationError", "ofType": null }, { "kind": "OBJECT", "name": "PaymentReminderSendUserError", "ofType": null }, { "kind": "OBJECT", "name": "PaymentTermsCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PaymentTermsDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "PaymentTermsUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesByProductBulkUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PriceListPriceUserError", "ofType": null }, { "kind": "OBJECT", "name": "PriceListUserError", "ofType": null }, { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductChangeStatusUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductDuplicateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductFeedCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductFeedDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductFullSyncUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionsCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionsDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionsReorderUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductSetUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantRelationshipBulkUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkDeleteUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkReorderUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "PublicationUserError", "ofType": null }, { "kind": "OBJECT", "name": "QuantityPricingByVariantUserError", "ofType": null }, { "kind": "OBJECT", "name": "QuantityRuleUserError", "ofType": null }, { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null }, { "kind": "OBJECT", "name": "ShopPolicyUserError", "ofType": null }, { "kind": "OBJECT", "name": "ShopResourceFeedbackCreateUserError", "ofType": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionEnableUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleSkipUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleUnskipUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionContractUserError", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null }, { "kind": "OBJECT", "name": "TaxAppConfigureUserError", "ofType": null }, { "kind": "OBJECT", "name": "TransactionVoidUserError", "ofType": null }, { "kind": "OBJECT", "name": "TranslationUserError", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteByIdsUserError", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySavedSearchUserError", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySearchUserError", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectImportUserError", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectUserError", "ofType": null }, { "kind": "OBJECT", "name": "UserError", "ofType": null }, { "kind": "OBJECT", "name": "ValidationUserError", "ofType": null } ] }, { "kind": "OBJECT", "name": "DisputeEvidenceUpdatePayload", "description": "Return type for `disputeEvidenceUpdate` mutation.", "fields": [ { "name": "disputeEvidence", "description": "The updated dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEvidence", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DisputeEvidenceUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DisputeEvidenceUpdateUserError", "description": "An error that occurs during the execution of `DisputeEvidenceUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "DisputeEvidenceUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DisputeEvidenceUpdateUserErrorCode", "description": "Possible error codes that can be returned by `DisputeEvidenceUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DISPUTE_EVIDENCE_NOT_FOUND", "description": "Dispute evidence could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "EVIDENCE_ALREADY_ACCEPTED", "description": "Evidence already accepted.", "isDeprecated": false, "deprecationReason": null }, { "name": "EVIDENCE_PAST_DUE_DATE", "description": "Evidence past due date.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILES_SIZE_EXCEEDED_LIMIT", "description": "Combined files size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LARGE", "description": "Individual file size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DisputeStatus", "description": "The possible statuses of a dispute.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACCEPTED", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "LOST", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "NEEDS_RESPONSE", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "UNDER_REVIEW", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "WON", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "CHARGE_REFUNDED", "description": "Status previously used by Stripe to indicate that a dispute led to a refund.", "isDeprecated": true, "deprecationReason": "CHARGE_REFUNDED is no longer supported." } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DisputeType", "description": "The possible types for a dispute.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CHARGEBACK", "description": "The dispute has turned into a chargeback.", "isDeprecated": false, "deprecationReason": null }, { "name": "INQUIRY", "description": "The dispute is in the inquiry phase.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Domain", "description": "A unique string that represents the address of a Shopify store on the Internet.", "fields": [ { "name": "host", "description": "The host name of the domain. For example, `example.com`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localization", "description": "The localization of the domain, if the domain doesn't redirect.", "args": [], "type": { "kind": "OBJECT", "name": "DomainLocalization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketWebPresence", "description": "The web presence of the domain.", "args": [], "type": { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sslEnabled", "description": "Whether SSL is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the domain (for example, `https://example.com`).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DomainLocalization", "description": "The country and language settings assigned to a domain.", "fields": [ { "name": "alternateLocales", "description": "The ISO codes for the domain’s alternate locales. For example, `[\"en\"]`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The ISO code for the country assigned to the domain. For example, `\"CA\"` or \"*\" for a domain set to \"Rest of world\".", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultLocale", "description": "The ISO code for the domain’s default locale. For example, `\"en\"`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrder", "description": "An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:\n\n- 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.\n- Send invoices to customers to pay with a secure checkout link.\n- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.\n- Re-create orders manually from active sales channels.\n- Sell products at discount or wholesale rates.\n- Take pre-orders.\n- Save an order as a draft and resume working on it later.\n\nFor 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.\n\n**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.\n", "fields": [ { "name": "appliedDiscount", "description": "The order-level discount applied to the draft order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrderAppliedDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddress", "description": "The billing address of the customer.\n", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddressMatchesShippingAddress", "description": "Whether the billing address matches the shipping address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "completedAt", "description": "The date and time when the draft order converted to a new order,\nand the draft order's status changed to **Completed**.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the draft order was created in Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The three letter code for the currency of the store at the time of the most recent update to the draft order.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "The custom information added to the draft order on behalf of the customer.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer who will be sent an invoice for the draft order, if there is one.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The email address of the customer, which is used to send notifications.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The list of events associated with the draft order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Whether the merchant has added timeline comments to the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "invoiceEmailTemplateSubject", "description": "The subject defined for the draft invoice email template.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "invoiceSentAt", "description": "The date and time when the invoice was last emailed to the customer.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "invoiceUrl", "description": "The link to the checkout, which is sent to the customer in the invoice email.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "The list of the line items in the draft order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItemsSubtotalPrice", "description": "The subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localizationExtensions", "description": "List of localization extensions for the resource.", "args": [ { "name": "countryCodes", "description": "The country codes of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "purposes", "description": "The purpose of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionPurpose", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtensionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketName", "description": "The name of the selected market.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketRegionCountryCode", "description": "The selected country code that determines the pricing of the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The identifier for the draft order, which is unique within the store. For example, _#D1223_.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note2", "description": "The text from an optional note attached to the draft order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order that was created from this draft order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTerms", "description": "The associated payment terms for this draft order.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number assigned to the draft order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "poNumber", "description": "The purchase order number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentCurrencyCode", "description": "The payment currency of the customer for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "purchasingEntity", "description": "The purchasing entity for the draft order.", "args": [], "type": { "kind": "UNION", "name": "PurchasingEntity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ready", "description": "Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reserveInventoryUntil", "description": "The time after which inventory will automatically be restocked.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingAddress", "description": "The shipping address of the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLine", "description": "The line item that contains the shipping costs.", "args": [], "type": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Status of the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DraftOrderStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPrice", "description": "The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPriceSet", "description": "A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tags", "description": "A comma separated list of tags associated with the draft order. Updating `tags` overwrites\nany existing tags that were previously added to the draft order. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxExempt", "description": "Whether the draft order is tax exempt.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "Total amount of taxes charged for each line item and shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxesIncluded", "description": "Whether the line item prices include taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountsSet", "description": "The total discounts for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalLineItemsPriceSet", "description": "The total price of line items for this draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPrice", "description": "The total amount of the draft order, including taxes, shipping charges, and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "The total amount of the draft order including taxes, shipping charges, and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalShippingPrice", "description": "The total shipping charge for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalShippingPriceSet", "description": "The total shipping charge for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTax", "description": "The total amount of taxes for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxSet", "description": "The total amount of taxes for the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalWeight", "description": "The total weight in grams of the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the draft order was last changed.\nThe format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibleToCustomer", "description": "Whether the draft order will be visible to the customer on the self-serve portal.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasLocalizationExtensions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderAppliedDiscount", "description": "The order-level discount applied to a draft order.", "fields": [ { "name": "amount", "description": "Amount of the order-level discount that's applied to the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountV2` instead." }, { "name": "amountSet", "description": "The amount of money discounted, with values shown in both shop currency and presentment currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "amountV2", "description": "Amount of money discounted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Description of the order-level discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Name of the order-level discount.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The order level discount amount. If `valueType` is `\"percentage\"`,\nthen `value` is the percentage discount.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "valueType", "description": "Type of the order-level discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DraftOrderAppliedDiscountType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DraftOrderAppliedDiscountInput", "description": "The input fields for applying an order-level discount to a draft order.", "fields": null, "inputFields": [ { "name": "amount", "description": "The applied amount of the discount.\nIf the type of the discount is fixed amount, then this is the fixed dollar amount.\nIf the type is percentage, then this is the subtotal multiplied by the percentage.\n", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Reason for the discount.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "Title of the discount.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "The value of the discount.\nIf the type of the discount is fixed amount, then this is a fixed dollar amount.\nIf the type is percentage, then this is the percentage.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "valueType", "description": "The type of discount.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DraftOrderAppliedDiscountType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DraftOrderAppliedDiscountType", "description": "The valid discount types that can be applied to a draft order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FIXED_AMOUNT", "description": "A fixed amount in the store's currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "PERCENTAGE", "description": "A percentage of the order subtotal.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderBulkAddTagsPayload", "description": "Return type for `draftOrderBulkAddTags` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job for adding tags to the draft orders.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderBulkDeletePayload", "description": "Return type for `draftOrderBulkDelete` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job for deleting the draft orders.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderBulkRemoveTagsPayload", "description": "Return type for `draftOrderBulkRemoveTags` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job for removing tags from the draft orders.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderCalculatePayload", "description": "Return type for `draftOrderCalculate` mutation.", "fields": [ { "name": "calculatedDraftOrder", "description": "The calculated properties for a draft order.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedDraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderCompletePayload", "description": "Return type for `draftOrderComplete` mutation.", "fields": [ { "name": "draftOrder", "description": "The completed draft order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderConnection", "description": "An auto-generated type for paginating through multiple DraftOrders.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DraftOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderCreateFromOrderPayload", "description": "Return type for `draftOrderCreateFromOrder` mutation.", "fields": [ { "name": "draftOrder", "description": "The created Draft Order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderCreateMerchantCheckoutPayload", "description": "Return type for `draftOrderCreateMerchantCheckout` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderCreatePayload", "description": "Return type for `draftOrderCreate` mutation.", "fields": [ { "name": "draftOrder", "description": "The created draft order.\n", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DraftOrderDeleteInput", "description": "The input fields to specify the draft order to delete by its ID.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the draft order to delete.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderDeletePayload", "description": "Return type for `draftOrderDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted draft order.\n", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderDuplicatePayload", "description": "Return type for `draftOrderDuplicate` mutation.", "fields": [ { "name": "draftOrder", "description": "The newly duplicated draft order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderEdge", "description": "An auto-generated type which holds one DraftOrder and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DraftOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DraftOrderInput", "description": "The input fields used to create or update a draft order.", "fields": null, "inputFields": [ { "name": "appliedDiscount", "description": "The discount that will be applied to the draft order.\nA draft order line item can have one discount. A draft order can also have one order-level discount.\n", "type": { "kind": "INPUT_OBJECT", "name": "DraftOrderAppliedDiscountInput", "ofType": null }, "defaultValue": null }, { "name": "billingAddress", "description": "The mailing address associated with the payment method.\n", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "customAttributes", "description": "Extra information added to the customer.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null }, { "name": "email", "description": "The customer's email address.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lineItems", "description": "Product variant line item or custom line item associated to the draft order.\nEach draft order must include at least one line item.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DraftOrderLineItemInput", "ofType": null } } }, "defaultValue": null }, { "name": "metafields", "description": "Metafields attached to the draft order. An existing metafield can not be used when creating a draft order.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "localizationExtensions", "description": "The localization extensions attached to the draft order. For example, Tax IDs.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "LocalizationExtensionInput", "ofType": null } } }, "defaultValue": null }, { "name": "note", "description": "The text of an optional note that a shop owner can attach to the draft order.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "shippingAddress", "description": "The mailing address to where the order will be shipped.\n", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "shippingLine", "description": "A shipping line object, which details the shipping method used.\n", "type": { "kind": "INPUT_OBJECT", "name": "ShippingLineInput", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "A comma separated list of tags that have been added to the draft order.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "taxExempt", "description": "Whether or not taxes are exempt for the draft order.\nIf false, then Shopify will refer to the taxable field for each line item.\nIf a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "useCustomerDefaultAddress", "description": "Sent as part of a draft order object to load customer shipping information.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "visibleToCustomer", "description": "Whether the draft order will be visible to the customer on the self-serve portal.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "reserveInventoryUntil", "description": "Time after which inventory will automatically be restocked.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "presentmentCurrencyCode", "description": "The payment currency of the customer for this draft order.", "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "defaultValue": null }, { "name": "marketRegionCountryCode", "description": "The selected country code that determines the pricing of the draft order.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The customer's phone number.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "paymentTerms", "description": "The fields used to create payment terms.", "type": { "kind": "INPUT_OBJECT", "name": "PaymentTermsInput", "ofType": null }, "defaultValue": null }, { "name": "purchasingEntity", "description": "The purchasing entity for this draft order.", "type": { "kind": "INPUT_OBJECT", "name": "PurchasingEntityInput", "ofType": null }, "defaultValue": null }, { "name": "sourceName", "description": "The source of the checkout.\n To use this field for sales attribution, you must register the channels that your app is managing.\n You can register the channels that your app is managing by completing\n [this Google Form](https://docs.google.com/forms/d/e/1FAIpQLScmVTZRQNjOJ7RD738mL1lGeFjqKVe_FM2tO9xsm21QEo5Ozg/viewform?usp=sf_link).\n After you've submitted your request, you need to wait for your request to be processed by Shopify.\n You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension.\n You need to specify the handle as the `source_name` value in your request.\n The handle is the channel that the order was placed from.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "poNumber", "description": "The purchase order number.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderInvoicePreviewPayload", "description": "Return type for `draftOrderInvoicePreview` mutation.", "fields": [ { "name": "previewHtml", "description": "The draft order invoice email rendered as HTML to allow previewing.", "args": [], "type": { "kind": "SCALAR", "name": "HTML", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "previewSubject", "description": "The subject preview for the draft order invoice email.", "args": [], "type": { "kind": "SCALAR", "name": "HTML", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderInvoiceSendPayload", "description": "Return type for `draftOrderInvoiceSend` mutation.", "fields": [ { "name": "draftOrder", "description": "The draft order an invoice email is sent for.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderLineItem", "description": "A line item included in a draft order.", "fields": [ { "name": "appliedDiscount", "description": "The discount that will be applied to the line item or the overall order.\n", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrderAppliedDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "custom", "description": "Whether the line item is a custom line item (`true`) or a product variant line item (`false`).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributesV2", "description": "Additional information (metafields) about the line item with the associated types.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TypedAttribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotal", "description": "The line item price after discounts are applied.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotalSet", "description": "The line item price after discounts are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPrice", "description": "The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceSet", "description": "The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grams", "description": "The weight of the line item in grams. The weight can only be specified if the line item is a custom\nline item.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `weight` instead." }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated with the draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the line item represents the purchase of a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotal", "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalSet", "description": "The total price (without discounts) of the line item,based on the original unit price of the variant x quantity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPrice", "description": "The variant price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "The variant price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product corresponding to the line item’s product variant.\n", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of product variants that are requested in the draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The SKU number of the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "A list of tax line objects, each of which details the total taxes applicable to the order.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product or variant. This field only applies to custom line items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscount", "description": "The total value of the discount that's applied to the line item.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountSet", "description": "The total value of the discount that's applied to the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The associated variant for the line item.\n", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The name of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who created the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The weight unit and value for a draft order line item.", "args": [], "type": { "kind": "OBJECT", "name": "Weight", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderLineItemConnection", "description": "An auto-generated type for paginating through multiple DraftOrderLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in DraftOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderLineItemEdge", "description": "An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of DraftOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DraftOrderLineItemInput", "description": "The input fields used to create a line item for a draft order.", "fields": null, "inputFields": [ { "name": "appliedDiscount", "description": "Discount which will be applied to the line item.\n", "type": { "kind": "INPUT_OBJECT", "name": "DraftOrderAppliedDiscountInput", "ofType": null }, "defaultValue": null }, { "name": "customAttributes", "description": "Represents a generic custom attribute using a key value pair.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null }, { "name": "originalUnitPrice", "description": "The price without any discounts applied. This value is ignored when `variantId` is provided.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "The number of products that were purchased.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required. This value is ignored when `variantId` is provided.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "The SKU number of the item. This value is ignored when `variantId` is provided.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxable", "description": "Whether the item is taxable. This value is ignored when `variantId` is provided.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "Title of the item. Ignored when `variantId` is provided.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "variantId", "description": "The ID of the product variant corresponding to the line item.\nNull if custom line item. Required if product variant line item.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "weight", "description": "Specifies the weight unit and value inputs.\nThis value is ignored when `variantId` is provided.\n", "type": { "kind": "INPUT_OBJECT", "name": "WeightInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DraftOrderSortKeys", "description": "The set of valid sort keys for the DraftOrder query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NUMBER", "description": "Sort by the `number` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "STATUS", "description": "Sort by the `status` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_PRICE", "description": "Sort by the `total_price` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_NAME", "description": "Sort by the `customer_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "DraftOrderStatus", "description": "The valid statuses for a draft order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "COMPLETED", "description": "The draft order has been paid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVOICE_SENT", "description": "An invoice for the draft order has been sent to the customer.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPEN", "description": "The draft order is open. It has not been paid, and an invoice hasn't been sent.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderTag", "description": "Represents a draft order tag.", "fields": [ { "name": "handle", "description": "Handle of draft order tag.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "ID of draft order tag.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Title of draft order tag.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DraftOrderUpdatePayload", "description": "Return type for `draftOrderUpdate` mutation.", "fields": [ { "name": "draftOrder", "description": "The updated draft order.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Duty", "description": "The duty details for a line item.", "fields": [ { "name": "countryCodeOfOrigin", "description": "The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "harmonizedSystemCode", "description": "The harmonized system code of the item used in calculating the duty.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The amount of the duty.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "A list of taxes charged on the duty.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DutySale", "description": "A sale associated with a duty charge.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "duty", "description": "The duty for the associated sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Duty", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EditableProperty", "description": "The attribute editable information.", "fields": [ { "name": "locked", "description": "Whether the attribute is locked for editing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the attribute is locked for editing.", "args": [], "type": { "kind": "SCALAR", "name": "FormattedString", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "EmailInput", "description": "The input fields for an email.", "fields": null, "inputFields": [ { "name": "subject", "description": "Specifies the email subject.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "to", "description": "Specifies the email recipient.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "from", "description": "Specifies the email sender.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "body", "description": "Specifies the email body.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "bcc", "description": "Specifies any bcc recipients for the email.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "customMessage", "description": "Specifies a custom message to include in the email.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ErrorPosition", "description": "Error position information in a ShopifyQL parsing error.", "fields": [ { "name": "character", "description": "The character position of the error in the line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "line", "description": "The line number of the error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "description": "An error that occurs during the execution of a server pixel mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ErrorsServerPixelUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ErrorsServerPixelUserErrorCode", "description": "Possible error codes that can be returned by `ErrorsServerPixelUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "A server pixel doesn't exist for this app and shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALREADY_EXISTS", "description": "A server pixel already exists for this app and shop. Only one server pixel can exist for any app and shop combination.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUB_SUB_ERROR", "description": "PubSubProject and PubSubTopic values resulted in an address that is not a valid GCP pub/sub format.Address format should be pubsub://project:topic.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEEDS_CONFIGURATION_TO_CONNECT", "description": "Server Pixel must be configured with a valid AWS Event Bridge or GCP pub/sub endpoint address to be connected.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ErrorsWebPixelUserError", "description": "An error that occurs during the execution of a web pixel mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ErrorsWebPixelUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ErrorsWebPixelUserErrorCode", "description": "Possible error codes that can be returned by `ErrorsWebPixelUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The record with the ID used as the input value couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_SETTINGS", "description": "The provided settings ID does not match the expected settings definition on the app.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNABLE_TO_DELETE", "description": "An error occurred and the web pixel couldnt be deleted.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "Event", "description": "Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the\naddition of a product.\n", "fields": [ { "name": "appTitle", "description": "The name of the app that created the event.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToApp", "description": "Whether the event was created by an app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributeToUser", "description": "Whether the event was caused by an admin user.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the event was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "criticalAlert", "description": "Whether the event is critical.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Human readable text that describes the event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "FormattedString", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "BasicEvent", "ofType": null }, { "kind": "OBJECT", "name": "CommentEvent", "ofType": null } ] }, { "kind": "OBJECT", "name": "EventBridgeServerPixelUpdatePayload", "description": "Return type for `eventBridgeServerPixelUpdate` mutation.", "fields": [ { "name": "serverPixel", "description": "The server pixel as configured by the mutation.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EventBridgeWebhookSubscriptionCreatePayload", "description": "Return type for `eventBridgeWebhookSubscriptionCreate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was created.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "EventBridgeWebhookSubscriptionInput", "description": "The input fields for an EventBridge webhook subscription.\n", "fields": null, "inputFields": [ { "name": "arn", "description": "The ARN of the EventBridge partner event source.", "type": { "kind": "SCALAR", "name": "ARN", "ofType": null }, "defaultValue": null }, { "name": "format", "description": "The format in which the webhook subscription should send the data.", "type": { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "ofType": null }, "defaultValue": null }, { "name": "includeFields", "description": "The list of fields to be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "metafieldNamespaces", "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EventBridgeWebhookSubscriptionUpdatePayload", "description": "Return type for `eventBridgeWebhookSubscriptionUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EventConnection", "description": "An auto-generated type for paginating through multiple Events.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in EventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Event", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EventEdge", "description": "An auto-generated type which holds one Event and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of EventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Event", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "EventSortKeys", "description": "The set of valid sort keys for the Event query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeLineItem", "description": "An item for exchange.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The order line item for the exchange.", "args": [], "type": { "kind": "OBJECT", "name": "LineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeLineItemConnection", "description": "An auto-generated type for paginating through multiple ExchangeLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ExchangeLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeLineItemEdge", "description": "An auto-generated type which holds one ExchangeLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ExchangeLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2", "description": "An exchange where existing items on an order are returned and new items are added to the order.", "fields": [ { "name": "additions", "description": "The details of the new items in the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2Additions", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "completedAt", "description": "The date and time when the exchange was completed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the exchange was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location where the exchange happened.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The text of an optional note that a shop owner can attach to the exchange.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refunds", "description": "The refunds processed during the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Refund", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns", "description": "The details of the returned items in the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2Returns", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The staff member associated with the exchange.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmountProcessedSet", "description": "The amount of money that was paid or refunded as part of the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "The difference in values of the items that were exchanged.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactions", "description": "The order transactions related to the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2Additions", "description": "New items associated to the exchange.", "fields": [ { "name": "lineItems", "description": "The list of new items for the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2LineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPriceSet", "description": "The subtotal of the items being added, including discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The summary of all taxes of the items being added.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "The total price of the items being added, including discounts and taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2Connection", "description": "An auto-generated type for paginating through multiple ExchangeV2s.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2Edge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ExchangeV2Edge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2Edge", "description": "An auto-generated type which holds one ExchangeV2 and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ExchangeV2Edge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2LineItem", "description": "Contains information about an item in the exchange.", "fields": [ { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotalSet", "description": "The total line price, in shop and presentment currencies, after discounts are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceSet", "description": "The price, in shop and presentment currencies,\nof a single variant unit after line item discounts are applied.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCard", "description": "Indiciates if this line item is a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCards", "description": "The gift cards associated with the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCard", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the line item represents the purchase of a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The line item associated with this object.", "args": [], "type": { "kind": "OBJECT", "name": "LineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalSet", "description": "The total price, in shop and presentment currencies, before discounts are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "The price, in shop and presentment currencies,\nof a single variant unit before line item discounts are applied.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of products that were purchased.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The SKU number of the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The TaxLine object connected to this line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product or variant. This field only applies to custom line items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant of the line item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The name of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who created the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeV2Returns", "description": "Return items associated to the exchange.", "fields": [ { "name": "lineItems", "description": "The list of return items for the exchange.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2LineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderDiscountAmountSet", "description": "The amount of the order-level discount for the items and shipping being returned, which doesn't contain any line item discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingRefundAmountSet", "description": "The amount of money to be refunded for shipping.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPriceSet", "description": "The subtotal of the items being returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The summary of all taxes of the items being returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tipRefundAmountSet", "description": "The amount of money to be refunded for tip.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPriceSet", "description": "The total value of the items being returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExternalVideo", "description": "Represents a video hosted outside of Shopify.\n", "fields": [ { "name": "alt", "description": "A word or phrase to share the nature or contents of a media.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "embedUrl", "description": "The embed URL of the video for the respective host.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "embeddedUrl", "description": "The URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originUrl` instead." }, { "name": "host", "description": "The host of the external video.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaHost", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaContentType", "description": "The media content type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaErrors", "description": "Any errors which have occurred on the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaWarnings", "description": "The warnings attached to the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originUrl", "description": "The origin URL of the video on the respective host.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Current status of the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Media", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FailedRequirement", "description": "Requirements that must be met before an app can be installed.", "fields": [ { "name": "action", "description": "Action to be taken to resolve a failed requirement, including URL link.", "args": [], "type": { "kind": "OBJECT", "name": "NavigationItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app\nencounters when trying to make use of their Shop and its resources.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "Fee", "description": "A additional cost, charged by the merchant, on an order. Examples include return shipping fees and restocking fees.", "fields": [ { "name": "id", "description": "The unique ID for the Fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "RestockingFee", "ofType": null }, { "kind": "OBJECT", "name": "ReturnShippingFee", "ofType": null } ] }, { "kind": "OBJECT", "name": "FeeSale", "description": "A sale associated with a fee.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fee", "description": "The fee associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Fee", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "File", "description": "A file interface.", "fields": [ { "name": "alt", "description": "A word or phrase to describe the contents or the function of a file.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileErrors", "description": "Any errors that have occurred on the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileStatus", "description": "The status of the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FileStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "GenericFile", "ofType": null }, { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, { "kind": "OBJECT", "name": "Video", "ofType": null } ] }, { "kind": "OBJECT", "name": "FileAcknowledgeUpdateFailedPayload", "description": "Return type for `fileAcknowledgeUpdateFailed` mutation.", "fields": [ { "name": "files", "description": "The updated file(s).", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "File", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FilesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FileConnection", "description": "An auto-generated type for paginating through multiple Files.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "File", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FileContentType", "description": "The possible content types for a file object.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "IMAGE", "description": "A Shopify-hosted image.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE", "description": "A Shopify-hosted generic file.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO", "description": "A Shopify-hosted video file. It's recommended to use this type for all video files.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FileCreateInput", "description": "The input fields that are required to create a file object.", "fields": null, "inputFields": [ { "name": "filename", "description": "When provided, the file will be created with the given filename,\notherwise the filename in the originalSource will be used.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "originalSource", "description": "An external URL (for images only) or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "contentType", "description": "The file content type. If omitted, then Shopify will attempt to determine the content type during file processing.", "type": { "kind": "ENUM", "name": "FileContentType", "ofType": null }, "defaultValue": null }, { "name": "alt", "description": "The alternative text description of the file.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "duplicateResolutionMode", "description": "How to handle if filename is already in use.", "type": { "kind": "ENUM", "name": "FileCreateInputDuplicateResolutionMode", "ofType": null }, "defaultValue": "APPEND_UUID" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FileCreateInputDuplicateResolutionMode", "description": "The input fields for handling if filename is already in use.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APPEND_UUID", "description": "Append a UUID if filename is already in use.", "isDeprecated": false, "deprecationReason": null }, { "name": "RAISE_ERROR", "description": "Raise an error if filename is already in use.", "isDeprecated": false, "deprecationReason": null }, { "name": "REPLACE", "description": "Replace the existing file if filename is already in use.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FileCreatePayload", "description": "Return type for `fileCreate` mutation.", "fields": [ { "name": "files", "description": "The newly created files.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "File", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FilesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FileDeletePayload", "description": "Return type for `fileDelete` mutation.", "fields": [ { "name": "deletedFileIds", "description": "The IDs of the deleted files.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FilesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FileEdge", "description": "An auto-generated type which holds one File and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FileEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "File", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FileError", "description": "A file error. This typically occurs when there is an issue with the file itself causing it to fail validation.\nCheck the file before attempting to upload again.\n", "fields": [ { "name": "code", "description": "Code representing the type of error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FileErrorCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "details", "description": "Additional details regarding the error.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Translated error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FileErrorCode", "description": "The error types for a file.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNKNOWN", "description": "File error has occurred for an unknown reason.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_SIGNED_URL", "description": "File could not be processed because the signed URL was invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE_DOWNLOAD_FAILURE", "description": "File could not be processed because the image could not be downloaded.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE_PROCESSING_FAILURE", "description": "File could not be processed because the image could not be processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_TIMEOUT_ERROR", "description": "File timed out because it is currently being modified by another operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_NOT_FOUND", "description": "File could not be created because the external video could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_UNLISTED", "description": "File could not be created because the external video is not listed or is private.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO", "description": "File could not be created because the external video has an invalid aspect ratio.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_EMBED_DISABLED", "description": "File could not be created because embed permissions are disabled for this video.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING", "description": "File could not be created because video is either not found or still transcoding.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_FILE_DOWNLOAD_FAILURE", "description": "File could not be processed because the source could not be downloaded.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_FILE_INVALID_SIZE", "description": "File could not be created because the size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_METADATA_READ_ERROR", "description": "File could not be created because the metadata could not be read.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_INVALID_FILETYPE_ERROR", "description": "File could not be created because it has an invalid file type.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_WIDTH_ERROR", "description": "File could not be created because it does not meet the minimum width requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_WIDTH_ERROR", "description": "File could not be created because it does not meet the maximum width requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_HEIGHT_ERROR", "description": "File could not be created because it does not meet the minimum height requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_HEIGHT_ERROR", "description": "File could not be created because it does not meet the maximum height requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_DURATION_ERROR", "description": "File could not be created because it does not meet the minimum duration requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_DURATION_ERROR", "description": "File could not be created because it does not meet the maximum duration requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_VALIDATION_ERROR", "description": "Video failed validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_VALIDATION_ERROR", "description": "Model failed validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_THUMBNAIL_GENERATION_ERROR", "description": "File could not be created because the model's thumbnail generation failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_THUMBNAIL_REGENERATION_ERROR", "description": "There was an issue while trying to generate a new thumbnail.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR", "description": "File could not be created because the model can't be converted to USDZ format.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_GLB_OUTPUT_CREATION_ERROR", "description": "File could not be created because the model file failed processing.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_PROCESSING_FAILURE", "description": "File could not be created because the model file failed processing.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_IMAGE_FILE_TYPE", "description": "File could not be created because the image is an unsupported file type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_FILE_SIZE", "description": "File could not be created because the image size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_ASPECT_RATIO", "description": "File could not be created because the image has an invalid aspect ratio.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_RESOLUTION", "description": "File could not be created because the image's resolution exceeds the max limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE_STORAGE_LIMIT_EXCEEDED", "description": "File could not be created because the cumulative file storage limit would be exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_FILENAME_ERROR", "description": "File could not be created because a file with the same name already exists.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FileSortKeys", "description": "The set of valid sort keys for the File query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FILENAME", "description": "Sort by the `filename` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORIGINAL_UPLOAD_SIZE", "description": "Sort by the `original_upload_size` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FileStatus", "description": "The possible statuses for a file object.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UPLOADED", "description": "File has been uploaded but hasn't been processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING", "description": "File is being processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY", "description": "File is ready to be displayed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "File processing has failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FileUpdateInput", "description": "The input fields that are required to update a file object.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the file to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "alt", "description": "The alternative text description of the file.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "originalSource", "description": "The source from which to update a media image or generic file.\nAn external URL (for images only) or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "previewImageSource", "description": "The source from which to update the media preview image.\nMay be an external URL or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "filename", "description": "The name of the file including its extension.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FileUpdatePayload", "description": "Return type for `fileUpdate` mutation.", "fields": [ { "name": "files", "description": "The list of updated files.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "File", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FilesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FilesErrorCode", "description": "Possible error codes that can be returned by `FilesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE_DOES_NOT_EXIST", "description": "File does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE_LOCKED", "description": "File has a pending operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATE", "description": "Filename update is only supported on Image and GenericFile.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_ARGUMENTS", "description": "Specify one argument: search, IDs, or deleteAll.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK_SEARCH", "description": "The search term must not be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENTS", "description": "At least one argument is required.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUERY", "description": "Search query isn't supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_FILENAME_EXTENSION", "description": "Invalid filename extension.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_FILENAME", "description": "The provided filename is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILENAME_ALREADY_EXISTS", "description": "The provided filename already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNACCEPTABLE_UNVERIFIED_TRIAL_ASSET", "description": "The file is not supported on trial accounts that have not validated their email. Either select a plan or verify the shop owner email to upload this file.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNACCEPTABLE_ASSET", "description": "The file type is not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNACCEPTABLE_TRIAL_ASSET", "description": "The file is not supported on trial accounts. Select a plan to upload this file.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALT_VALUE_LIMIT_EXCEEDED", "description": "The alt value exceeds the maximum limit of 512 characters.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_READY_STATE", "description": "The file is not in the READY state.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDED", "description": "Exceeded the limit of non-image media per shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISMATCHED_FILENAME_AND_ORIGINAL_SOURCE", "description": "Cannot create file with custom filename which does not match original source extension.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DUPLICATE_MODE_FOR_TYPE", "description": "Duplicate resolution mode is not supported for this file type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_SOURCE_URL", "description": "Invalid image source url value provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACE", "description": "Duplicate resolution mode REPLACE cannot be used without specifying filename.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_MEDIA_LIMIT_EXCEEDED", "description": "Exceeded the limit of media per product.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FilesUserError", "description": "An error that happens during the execution of a Files API query or mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FilesErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FilterOption", "description": "A filter option is one possible value in a search filter.", "fields": [ { "name": "label", "description": "The filter option's label for display purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The filter option's value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FinancialSummaryDiscountAllocation", "description": "An amount that's allocated to a line item based on an associated discount application.\n", "fields": [ { "name": "approximateAllocatedAmountPerItem", "description": "The money amount that's allocated per unit on the associated line based on the discount application in shop and presentment currencies. If the allocated amount for the line cannot be evenly divided by the quantity, then this amount will be an approximate amount, avoiding fractional pennies. For example, if the associated line had a quantity of 3 with a discount of 4 cents, then the discount distribution would be [0.01, 0.01, 0.02]. This field returns the highest number of the distribution. In this example, this would be 0.02.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountApplication", "description": "The discount application that the allocated amount originated from.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FinancialSummaryDiscountApplication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FinancialSummaryDiscountApplication", "description": "Discount applications capture the intentions of a discount source at\nthe time of application on an order's line items or shipping lines.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Float", "description": "Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FlowGenerateSignaturePayload", "description": "Return type for `flowGenerateSignature` mutation.", "fields": [ { "name": "payload", "description": "The payload used to generate the signature.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "signature", "description": "The generated signature.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FlowTriggerReceivePayload", "description": "Return type for `flowTriggerReceive` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "FormattedString", "description": "A string containing a strict subset of HTML code. Non-allowed tags will be stripped out.\nAllowed tags:\n* `a` (allowed attributes: `href`, `target`)\n* `b`\n* `br`\n* `em`\n* `i`\n* `strong`\n* `u`\nUse [HTML](https://shopify.dev/api/admin-graphql/latest/scalars/HTML) instead if you need to\ninclude other HTML tags.\n\nExample value: `\"Your current domain is johns-apparel.myshopify.com.\"`\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Fulfillment", "description": "Represents a fulfillment.\nIn Shopify, a fulfillment represents a shipment of one or more items in an order.\nWhen an order has been completely fulfilled, it means that all the items that are included\nin the order have been sent to the customer.\nThere can be more than one fulfillment for an order.\n", "fields": [ { "name": "createdAt", "description": "The date and time when the fulfillment was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveredAt", "description": "The date that this fulfillment was delivered.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayStatus", "description": "Human readable display status for this fulfillment.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentDisplayStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "estimatedDeliveryAt", "description": "The estimated date that this fulfillment will arrive.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "The history of events associated with this fulfillment.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "FulfillmentEventSortKeys", "ofType": null }, "defaultValue": "HAPPENED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentEventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentLineItems", "description": "List of the fulfillment's line items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrders", "description": "A paginated list of fulfillment orders for the fulfillment.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inTransitAt", "description": "The date and time when the fulfillment went into transit.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location that the fulfillment was processed at.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "Human readable reference identifier for this fulfillment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order for which the fulfillment was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originAddress", "description": "The address at which the fulfillment occurred. This field is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the `assignedLocation` field on the [`FulfillmentOrder`](/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object instead.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOriginAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether any of the line items in the fulfillment require shipping.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "service", "description": "Fulfillment service associated with the fulfillment.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLabel", "description": "The optional shipping label for this fulfillment.", "args": [], "type": { "kind": "OBJECT", "name": "ShippingLabel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the fulfillment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalQuantity", "description": "Sum of all line item quantities for the fulfillment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "trackingInfo", "description": "Tracking information associated with the fulfillment,\nsuch as the tracking company, tracking number, and tracking URL.\n", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentTrackingInfo", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the fulfillment was last modified.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentCancelPayload", "description": "Return type for `fulfillmentCancel` mutation.", "fields": [ { "name": "fulfillment", "description": "The canceled fulfillment.", "args": [], "type": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConnection", "description": "An auto-generated type for paginating through multiple Fulfillments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRule", "description": "A fulfillment constraint rule.", "fields": [ { "name": "function", "description": "The ID for the fulfillment constraint function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleCreatePayload", "description": "Return type for `fulfillmentConstraintRuleCreate` mutation.", "fields": [ { "name": "fulfillmentConstraintRule", "description": "The newly created fulfillment constraint rule.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentConstraintRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentConstraintRuleCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleCreateUserError", "description": "An error that occurs during the execution of `FulfillmentConstraintRuleCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentConstraintRuleCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentConstraintRuleCreateUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentConstraintRuleCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INPUT_INVALID", "description": "Failed to create fulfillment constraint rule due to invalid input.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "No Shopify Function found for provided function_id.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_ALREADY_REGISTERED", "description": "A fulfillment constraint rule already exists for the provided function_id.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_DOES_NOT_IMPLEMENT", "description": "Function does not implement the required interface for this fulfillment constraint rule.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", "description": "Shop must be on a Shopify Plus plan to activate functions from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_PENDING_DELETION", "description": "Function is pending deletion and cannot have new rules created against it.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleDeletePayload", "description": "Return type for `fulfillmentConstraintRuleDelete` mutation.", "fields": [ { "name": "success", "description": "Whether or not the fulfillment constraint rule was successfully deleted.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentConstraintRuleDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRuleDeleteUserError", "description": "An error that occurs during the execution of `FulfillmentConstraintRuleDelete`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentConstraintRuleDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentConstraintRuleDeleteUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentConstraintRuleDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "Could not find fulfillment constraint rule for provided id.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNAUTHORIZED_APP_SCOPE", "description": "Unauthorized app scope.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentCreateV2Payload", "description": "Return type for `fulfillmentCreateV2` mutation.", "fields": [ { "name": "fulfillment", "description": "The created fulfillment.", "args": [], "type": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentDisplayStatus", "description": "The display status of a fulfillment.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ATTEMPTED_DELIVERY", "description": "Displayed as **Attempted delivery**.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELED", "description": "Displayed as **Canceled**.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFIRMED", "description": "Displayed as **Confirmed**.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERED", "description": "Displayed as **Delivered**.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILURE", "description": "Displayed as **Failure**.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLED", "description": "Displayed as **Fulfilled**.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_TRANSIT", "description": "Displayed as **In transit**.", "isDeprecated": false, "deprecationReason": null }, { "name": "LABEL_PRINTED", "description": "Displayed as **Label printed**.", "isDeprecated": false, "deprecationReason": null }, { "name": "LABEL_PURCHASED", "description": "Displayed as **Label purchased**.", "isDeprecated": false, "deprecationReason": null }, { "name": "LABEL_VOIDED", "description": "Displayed as **Label voided**.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKED_AS_FULFILLED", "description": "Displayed as **Marked as fulfilled**.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_DELIVERED", "description": "Displayed as **Not delivered**.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUT_FOR_DELIVERY", "description": "Displayed as **Out for delivery**.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY_FOR_PICKUP", "description": "Displayed as **Ready for pickup**.", "isDeprecated": false, "deprecationReason": null }, { "name": "PICKED_UP", "description": "Displayed as **Picked up**.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBMITTED", "description": "Displayed as **Submitted**.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentEdge", "description": "An auto-generated type which holds one Fulfillment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentEvent", "description": "The fulfillment event that describes the fulfilllment status at a particular time.", "fields": [ { "name": "address1", "description": "The street address where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The country where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "estimatedDeliveryAt", "description": "The estimated delivery date and time of the fulfillment.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The time at which this fulfillment event happened.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "latitude", "description": "The latitude where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "longitude", "description": "The longitude where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A message associated with this fulfillment event.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The province where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this fulfillment event.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentEventStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip code of the location where this fulfillment event occurred.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentEventConnection", "description": "An auto-generated type for paginating through multiple FulfillmentEvents.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentEventEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentEvent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentEventCreatePayload", "description": "Return type for `fulfillmentEventCreate` mutation.", "fields": [ { "name": "fulfillmentEvent", "description": "The created fulfillment event.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentEvent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentEventEdge", "description": "An auto-generated type which holds one FulfillmentEvent and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentEvent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentEventInput", "description": "The input fields used to create a fulfillment event.", "fields": null, "inputFields": [ { "name": "address1", "description": "The street address where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The city where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "country", "description": "The country where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "estimatedDeliveryAt", "description": "The estimated delivery date and time of the fulfillment.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "happenedAt", "description": "The time at which this fulfillment event happened.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "fulfillmentId", "description": "The ID for the fulfillment that's associated with this fulfillment event.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "latitude", "description": "The latitude where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "longitude", "description": "The longitude where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "message", "description": "A message associated with this fulfillment event.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "province", "description": "The province where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The status of this fulfillment event.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentEventStatus", "ofType": null } }, "defaultValue": null }, { "name": "zip", "description": "The zip code of the location where this fulfillment event occurred.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentEventSortKeys", "description": "The set of valid sort keys for the FulfillmentEvent query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HAPPENED_AT", "description": "Sort by the `happened_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentEventStatus", "description": "The status that describes a fulfillment or delivery event.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LABEL_PURCHASED", "description": "A shipping label has been purchased.", "isDeprecated": false, "deprecationReason": null }, { "name": "LABEL_PRINTED", "description": "A purchased shipping label has been printed.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY_FOR_PICKUP", "description": "The fulfillment is ready to be picked up.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFIRMED", "description": "The fulfillment is confirmed. This is the default value when no other information is available.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_TRANSIT", "description": "The fulfillment is in transit.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUT_FOR_DELIVERY", "description": "The fulfillment is out for delivery.", "isDeprecated": false, "deprecationReason": null }, { "name": "ATTEMPTED_DELIVERY", "description": "A delivery was attempted.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERED", "description": "The fulfillment was successfully delivered.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILURE", "description": "The fulfillment request failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentHold", "description": "A fulfillment hold currently applied on a fulfillment order.\n", "fields": [ { "name": "heldBy", "description": "The name of the app or service that applied the fulfillment hold.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason for the fulfillment hold.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentHoldReason", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reasonNotes", "description": "Additional information about the fulfillment hold reason.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentHoldReason", "description": "The reason for a fulfillment hold.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AWAITING_PAYMENT", "description": "The fulfillment hold is applied because payment is pending.", "isDeprecated": false, "deprecationReason": null }, { "name": "HIGH_RISK_OF_FRAUD", "description": "The fulfillment hold is applied because of a high risk of fraud.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_ADDRESS", "description": "The fulfillment hold is applied because of an incorrect address.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_OUT_OF_STOCK", "description": "The fulfillment hold is applied because inventory is out of stock.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN_DELIVERY_DATE", "description": "The fulfillment hold is applied because of an unknown delivery date.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_POST_PURCHASE_CROSS_SELL", "description": "The fulfillment hold is applied because of a post purchase upsell offer.", "isDeprecated": false, "deprecationReason": null }, { "name": "AWAITING_RETURN_ITEMS", "description": "The fulfillment hold is applied because of return items not yet received during an exchange.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The fulfillment hold is applied for another reason.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentLineItem", "description": "Represents a line item from an order that's included in a fulfillment.", "fields": [ { "name": "discountedTotal", "description": "The total price after discounts are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedTotalSet` instead." }, { "name": "discountedTotalSet", "description": "The total price after discounts are applied in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The associated order's line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotal", "description": "The total price before discounts are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalTotalSet` instead." }, { "name": "originalTotalSet", "description": "The total price before discounts are applied in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "Number of line items in the fulfillment.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentLineItemConnection", "description": "An auto-generated type for paginating through multiple FulfillmentLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentLineItemEdge", "description": "An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrder", "description": "The FulfillmentOrder object represents either an item or a group of items in an\n[Order](https://shopify.dev/api/admin-graphql/latest/objects/Order)\nthat are expected to be fulfilled from the same location.\nThere can be more than one fulfillment order for an\n[order](https://shopify.dev/api/admin-graphql/latest/objects/Order)\nat a given location.\n\n{{ '/api/reference/fulfillment_order_relationships.png' | image }}\n\nFulfillment orders represent the work which is intended to be done in relation to an order.\nWhen fulfillment has started for one or more line items, a\n[Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment)\nis created by a merchant or third party to represent the ongoing or completed work of fulfillment.\n\n[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).\n\n> Note:\n> Shopify creates fulfillment orders automatically when an order is created.\n> It is not possible to manually create fulfillment orders.\n>\n> [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order).\n\n## Retrieving fulfillment orders\n\n### Fulfillment orders from an order\n\nAll fulfillment orders related to a given order can be retrieved with the\n[Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders)\nconnection.\n\n[API access scopes](#api-access-scopes)\ngovern which fulfillments orders are returned to clients.\nAn API client will only receive a subset of the fulfillment orders which belong to an order\nif they don't have the necessary access scopes to view all of the fulfillment orders.\n\n### Fulfillment orders assigned to the app for fulfillment\n\nFulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the\n[Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders)\nconnection.\nUse the `assignmentStatus` argument to control whether all assigned fulfillment orders\nshould be returned or only those where a merchant has sent a\n[fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest)\nand it has yet to be responded to.\n\nThe API client must be granted the `read_assigned_fulfillment_orders` access scope to access\nthe assigned fulfillment orders.\n\n### All fulfillment orders\n\nApps can retrieve all fulfillment orders with the\n[fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders)\nquery. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop,\nwhich are accessible to the app according to the\n[fulfillment order access scopes](#api-access-scopes) it was granted with.\n\n## The lifecycle of a fulfillment order\n\n### Fulfillment Order Creation\n\nAfter an order is created, a background worker performs the order routing process which determines\nwhich locations will be responsible for fulfilling the purchased items.\nOnce the order routing process is complete, one or more fulfillment orders will be created\nand assigned to these locations. It is not possible to manually create fulfillment orders.\n\nOnce a fulfillment order has been created, it will have one of two different lifecycles depending on\nthe type of location which the fulfillment order is assigned to.\n\n### The lifecycle of a fulfillment order at a merchant managed location\n\nFulfillment orders are completed by creating\n[fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment).\nFulfillments represents the work done.\n\nFor digital products a merchant or an order management app would create a fulfilment once the digital asset\nhas been provisioned.\nFor example, in the case of a digital gift card, a merchant would to do this once\nthe gift card has been activated - before the email has been shipped.\n\nOn the other hand, for a traditional shipped order,\na merchant or an order management app would create a fulfillment after picking and packing the items relating\nto a fulfillment order, but before the courier has collected the goods.\n\n[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).\n\n### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service\n\nFor fulfillment orders which are assigned to a location that is managed by a fulfillment service,\na merchant or an Order Management App can\n[send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest)\nto the fulfillment service which operates the location to request that they fulfill the associated items.\nA fulfillment service has the option to\n[accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest)\nor [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest)\nthis fulfillment request.\n\nOnce the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant\nor order management app and instead a\n[cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest)\nto the fulfillment service.\n\nOnce a fulfillment service accepts a fulfillment request,\nthen after they are ready to pack items and send them for delivery, they create fulfillments with the\n[fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2)\nmutation.\nThey can provide tracking information right away or create fulfillments without it and then\nupdate the tracking information for fulfillments with the\n[fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2)\nmutation.\n\n[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).\n\n## API access scopes\n\nFulfillment orders are governed by the following API access scopes:\n\n* The `read_merchant_managed_fulfillment_orders` and\n `write_merchant_managed_fulfillment_orders` access scopes\n grant access to fulfillment orders assigned to merchant-managed locations.\n* The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders`\n access scopes are intended for fulfillment services.\n These scopes grant access to fulfillment orders assigned to locations that are being managed\n by fulfillment services.\n* The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders`\n access scopes grant access to fulfillment orders\n assigned to locations managed by other fulfillment services.\n\n### Fulfillment service app access scopes\n\nUsually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope\nand don't have the `*_third_party_fulfillment_orders`\nor `*_merchant_managed_fulfillment_orders` access scopes.\nThe app will only have access to the fulfillment orders assigned to their location\n(or multiple locations if the app registers multiple fulfillment services on the shop).\nThe app will not have access to fulfillment orders assigned to merchant-managed locations\nor locations owned by other fulfillment service apps.\n\n### Order management app access scopes\n\n**Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and\n`write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders\non behalf of a merchant.\n\nIf an app combines the functions of an order management app and a fulfillment service,\nthen the app should request all\naccess scopes to manage all assigned and all unassigned fulfillment orders.\n\n## Notifications about fulfillment orders\n\nFulfillment services are required to\n[register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService)\na self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified\nwhenever a merchant submits a fulfillment or cancellation request.\n\nBoth merchants and apps can\n[subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks)\nto the\n[fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted)\nto be notified whenever fulfillment order related domain events occur.\n\n[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).\n", "fields": [ { "name": "assignedLocation", "description": "The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.\n\nThe fulfillment order's assigned location might change in the following cases:\n\n- The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder\n ) field within the mutation's response.\n- Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the\n [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open),\n [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or\n [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold)\n status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderAssignedLocation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelId", "description": "ID of the channel that created the order.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "Date and time when the fulfillment order was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryMethod", "description": "Delivery method of this fulfillment order.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "destination", "description": "The destination where the items should be sent.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrderDestination", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillAt", "description": "The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the `fulfill_at` date for a subscription order might be the 1st of each month, a pre-order `fulfill_at` date would be `nil`, and a standard order `fulfill_at` date would be the order creation date.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillBy", "description": "The latest date and time by which all items in the fulfillment order need to be fulfilled.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentHolds", "description": "The fulfillment holds applied on the fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentHold", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrdersForMerge", "description": "Fulfillment orders eligible for merging with the given fulfillment order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillments", "description": "A list of fulfillments for the fulfillment order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "internationalDuties", "description": "The duties delivery method of this fulfillment order.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrderInternationalDuties", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "A list of the fulfillment order's line items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsForMove", "description": "A list of locations that the fulfillment order can potentially move to.", "args": [ { "name": "lineItemIds", "description": "Filter to a list of Fulfillment Order Line Items.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": "[]" }, { "name": "query", "description": "Supported filter parameters:\n * name\n * address1\n * address2\n * city\n * zip\n * province\n * country\n * legacy\n * active\n * permits_sku_sharing\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locationIds", "description": "Specific Location ids to check for the movability for a fulfillment order.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMoveConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantRequests", "description": "A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order.", "args": [ { "name": "kind", "description": "The kind of request the merchant sent.", "type": { "kind": "ENUM", "name": "FulfillmentOrderMerchantRequestKind", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequestConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order that's associated with the fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderId", "description": "ID of the order that's associated with the fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderName", "description": "The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page.\nFor example, \"#1001\", \"EN1001\", or \"1001-A\".\nThis value isn't unique across multiple stores.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderProcessedAt", "description": "The date and time when the order was processed.\nThis date and time might not match the date and time when the order was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requestStatus", "description": "The request status of the fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentOrderRequestStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentOrderStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "supportedActions", "description": "The actions that can be performed on this fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderSupportedAction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the fulfillment order was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderAcceptCancellationRequestPayload", "description": "Return type for `fulfillmentOrderAcceptCancellationRequest` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order whose cancellation request was accepted.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderAcceptFulfillmentRequestPayload", "description": "Return type for `fulfillmentOrderAcceptFulfillmentRequest` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order whose fulfillment request was accepted.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderAction", "description": "The actions that can be taken on a fulfillment order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATE_FULFILLMENT", "description": "Creates a fulfillment for selected line items in the fulfillment order. The corresponding mutation for this action is `fulfillmentCreateV2`.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUEST_FULFILLMENT", "description": "Sends a request for fulfilling selected line items in a fulfillment order to a fulfillment service. The corresponding mutation for this action is `fulfillmentOrderSubmitFulfillmentRequest`.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCEL_FULFILLMENT_ORDER", "description": "Cancels a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderCancel`.", "isDeprecated": false, "deprecationReason": null }, { "name": "MOVE", "description": "Moves a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMove`.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUEST_CANCELLATION", "description": "Sends a cancellation request to the fulfillment service of a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSubmitCancellationRequest`.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARK_AS_OPEN", "description": "Marks the fulfillment order as open. The corresponding mutation for this action is `fulfillmentOrderOpen`.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEASE_HOLD", "description": "Releases the fulfillment hold on the fulfillment order. The corresponding mutation for this action is `fulfillmentOrderReleaseHold`.", "isDeprecated": false, "deprecationReason": null }, { "name": "HOLD", "description": "Applies a fulfillment hold on an open fulfillment order. The corresponding mutation for this action is `fulfillmentOrderHold`.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL", "description": "Opens an external URL to initiate the fulfillment process outside Shopify. This action should be paired with `FulfillmentOrderSupportedAction.externalUrl`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SPLIT", "description": "Splits a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSplit`.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERGE", "description": "Merges a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMerge`.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderAssignedLocation", "description": "The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.\n\n The fulfillment order's assigned location might change in the following cases:\n\n - The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder\n ) field within the mutation's response.\n\n - Work on the fulfillment order has not yet begun, which means that the fulfillment order has the\n [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open),\n [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or\n [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold)\n status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).\n\nIf the [fulfillmentOrderMove](\nhttps://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n) mutation has moved the fulfillment order's line items to a new location,\nbut hasn't moved the fulfillment order instance itself, then the original fulfillment order's assigned location\ndoesn't change.\nThis happens if the fulfillment order is being split during the move, or if all line items can be moved\nto an existing fulfillment order at a new location.\n\nOnce the fulfillment order has been taken into work or canceled,\nwhich means that the fulfillment order has the\n[IN_PROGRESS](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-inprogress),\n[CLOSED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-closed),\n[CANCELLED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-cancelled), or\n[INCOMPLETE](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-incomplete)\nstatus, `FulfillmentOrderAssignedLocation` acts as a snapshot of the shop's location content.\nUp-to-date shop's location data may be queried through [location](\n https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderAssignedLocation#field-fulfillmentorderassignedlocation-location\n) connection.\n", "fields": [ { "name": "address1", "description": "The first line of the address for the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address for the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter country code of the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location where the fulfillment is expected to happen. This value might be different from\n`FulfillmentOrderAssignedLocation` if the location's attributes were updated\nafter the fulfillment order was taken into work of canceled.\n", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The province of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The ZIP code of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderAssignmentStatus", "description": "The assigment status to be used to filter fulfillment orders.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANCELLATION_REQUESTED", "description": "Fulfillment orders for which the merchant has requested cancellation of\nthe previously accepted fulfillment request.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_REQUESTED", "description": "Fulfillment orders for which the merchant has requested fulfillment.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ACCEPTED", "description": "Fulfillment orders for which the merchant's fulfillment request has been accepted.\nAny number of fulfillments can be created on these fulfillment orders\nto completely fulfill the requested items.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_UNSUBMITTED", "description": "Fulfillment orders for which the merchant hasn't yet requested fulfillment.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderCancelPayload", "description": "Return type for `fulfillmentOrderCancel` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order that was marked as canceled.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "replacementFulfillmentOrder", "description": "The fulfillment order that was created to replace the canceled fulfillment order.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderClosePayload", "description": "Return type for `fulfillmentOrderClose` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order that was marked as incomplete.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "description": "An auto-generated type for paginating through multiple FulfillmentOrders.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderDestination", "description": "Represents the destination where the items should be sent upon fulfillment.\n", "fields": [ { "name": "address1", "description": "The first line of the address of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The company of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter country code of the destination.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The email of the customer at the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name of the customer at the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name of the customer at the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number of the customer at the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The province of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The ZIP code of the destination.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderEdge", "description": "An auto-generated type which holds one FulfillmentOrder and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderHoldInput", "description": "The input fields for the fulfillment hold applied on the fulfillment order.", "fields": null, "inputFields": [ { "name": "reason", "description": "The reason for the fulfillment hold.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentHoldReason", "ofType": null } }, "defaultValue": null }, { "name": "reasonNotes", "description": "Additional information about the fulfillment hold reason.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "notifyMerchant", "description": "Whether the merchant receives a notification about the fulfillment hold. The default value is `false`.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "externalId", "description": "A configurable ID used to track the automation system releasing these holds.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be placed on hold.\nIf left blank, all line items of the fulfillment order are placed on hold.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderHoldPayload", "description": "Return type for `fulfillmentOrderHold` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order on which a fulfillment hold was applied.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingFulfillmentOrder", "description": "The remaining fulfillment order containing the line items to which the hold wasn't applied,\nif specific line items were specified to be placed on hold.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderHoldUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderHoldUserError", "description": "An error that occurs during the execution of `FulfillmentOrderHold`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderHoldUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderHoldUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderHoldUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDER_NOT_FOUND", "description": "The fulfillment order could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_ZERO", "description": "The fulfillment order line item quantity must be greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LINE_ITEM_QUANTITY", "description": "The fulfillment order line item quantity is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderInternationalDuties", "description": "The international duties relevant to a fulfillment order.\n", "fields": [ { "name": "incoterm", "description": "The method of duties payment. Example values: `DDP`, `DAP`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItem", "description": "Associates an order line item with quantities requiring fulfillment from the respective fulfillment order.\n", "fields": [ { "name": "financialSummaries", "description": "The financial summary for the Fulfillment Order's Line Items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemFinancialSummary", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated to the line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItemId", "description": "The ID of the inventory item.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The associated order line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": true, "deprecationReason": " As of API version 2023-01, this field has been deprecated. The order line item associated with a `FulfillmentOrderLineItem`\n shouldn't be used to determine what to fulfill. Use the `FulfillmentOrderLineItem` and `FulfillmentOrder` objects\n instead. An order `LineItem` represents a single line item on an order, but it doesn't represent what should be fulfilled.\n" }, { "name": "originalUnitPriceSet", "description": "The variant unit price without discounts applied, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `financialSummaries` instead." }, { "name": "productTitle", "description": "The title of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingQuantity", "description": "The number of units remaining to be fulfilled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The variant SKU number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalQuantity", "description": "The total number of units to be fulfilled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The name of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who made the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "warnings", "description": "Warning messages for a fulfillment order line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The weight of a line item unit.", "args": [], "type": { "kind": "OBJECT", "name": "Weight", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemConnection", "description": "An auto-generated type for paginating through multiple FulfillmentOrderLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemEdge", "description": "An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemFinancialSummary", "description": "The financial details of a fulfillment order line item.\n", "fields": [ { "name": "approximateDiscountedUnitPriceSet", "description": "The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order.For the full picture of applied discounts, see discountAllocations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "The discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FinancialSummaryDiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPriceSet", "description": "The variant unit price without discounts applied, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "Number of line items that this financial summary applies to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "description": "The input fields used to include the quantity of the fulfillment order line item that should be fulfilled.\n", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the fulfillment order line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the fulfillment order line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemWarning", "description": "A fulfillment order line item warning. For example, a warning about why a fulfillment request was rejected.\n", "fields": [ { "name": "description", "description": "The description of warning.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of warning.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemsInput", "description": "The input fields used to include the line items of a specified fulfillment order that should be fulfilled.\n", "fields": null, "inputFields": [ { "name": "fulfillmentOrderId", "description": "The ID of the fulfillment order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be fulfilled.\nIf left blank, all line items of the fulfillment order will be fulfilled.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupInput", "description": "The input fields for marking fulfillment order line items as ready for pickup.", "fields": null, "inputFields": [ { "name": "lineItemsByFulfillmentOrder", "description": "The fulfillment orders associated with the line items which are ready to be picked up by a customer.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PreparedFulfillmentOrderLineItemsInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupPayload", "description": "Return type for `fulfillmentOrderLineItemsPreparedForPickup` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", "description": "An error that occurs during the execution of `FulfillmentOrderLineItemsPreparedForPickup`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderLineItemsPreparedForPickupUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderLineItemsPreparedForPickupUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderLineItemsPreparedForPickupUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NO_LINE_ITEMS_TO_PREPARE_FOR_FULFILLMENT_ORDER", "description": "The fulfillment order does not have any line items that can be prepared.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDER_INVALID", "description": "Invalid fulfillment order ID provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNABLE_TO_PREPARE_QUANTITY", "description": "Unable to prepare quantity.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMove", "description": "A location that a fulfillment order can potentially move to.\n", "fields": [ { "name": "availableLineItems", "description": "Fulfillment order line items that can be moved from their current location to the given location.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "availableLineItemsCount", "description": "Total number of fulfillment order line items that can be moved from their current assigned location to the\ngiven location.\n", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location being considered as the fulfillment order's new assigned location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A human-readable string with the reason why the fulfillment order, or some of its line items, can't be\nmoved to the location.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "movable", "description": "Whether the fulfillment order can be moved to the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unavailableLineItems", "description": "Fulfillment order line items that cannot be moved from their current location to the given location.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unavailableLineItemsCount", "description": "Total number of fulfillment order line items that can't be moved from their current assigned location to the\ngiven location.\n", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMoveConnection", "description": "An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMoveEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentOrderLocationForMoveEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMove", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMoveEdge", "description": "An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentOrderLocationForMoveEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderLocationForMove", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequest", "description": "A request made by the merchant or an order management app to a fulfillment service\nfor a fulfillment order.\n", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order associated with the merchant request.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "kind", "description": "The kind of request made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentOrderMerchantRequestKind", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The optional message that the merchant included in the request.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requestOptions", "description": "Additional options requested by the merchant. These depend on the `kind` of the request.\nFor example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the\nmerchant intends to notify the customer upon fulfillment. The fulfillment service can then set\n`notifyCustomer` when making calls to `FulfillmentCreateV2`.\n", "args": [], "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "responseData", "description": "The response from the fulfillment service.", "args": [], "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sentAt", "description": "The timestamp when the request was made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequestConnection", "description": "An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequestEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in FulfillmentOrderMerchantRequestEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequest", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequestEdge", "description": "An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of FulfillmentOrderMerchantRequestEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequest", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderMerchantRequestKind", "description": "The kinds of request merchants can make to a fulfillment service.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_REQUEST", "description": "The merchant requests fulfillment for an `OPEN` fulfillment order.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLATION_REQUEST", "description": "The merchant requests cancellation of an `IN_PROGRESS` fulfillment order.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderMergeInput", "description": "The input fields for merging fulfillment orders.", "fields": null, "inputFields": [ { "name": "mergeIntents", "description": "The details of the fulfillment orders to be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderMergeInputMergeIntent", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderMergeInputMergeIntent", "description": "The input fields for merging fulfillment orders into a single merged fulfillment order.", "fields": null, "inputFields": [ { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be merged.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } }, "defaultValue": null }, { "name": "fulfillmentOrderId", "description": "The ID of the fulfillment order to be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMergePayload", "description": "Return type for `fulfillmentOrderMerge` mutation.", "fields": [ { "name": "fulfillmentOrderMerges", "description": "The result of the fulfillment order merges.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMergeResult", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderMergeUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMergeResult", "description": "The result of merging a set of fulfillment orders.", "fields": [ { "name": "fulfillmentOrder", "description": "The new fulfillment order as a result of the merge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMergeUserError", "description": "An error that occurs during the execution of `FulfillmentOrderMerge`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderMergeUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderMergeUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderMergeUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDER_NOT_FOUND", "description": "The fulfillment order could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The fulfillment order line item quantity must be greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LINE_ITEM_QUANTITY", "description": "The fulfillment order line item quantity is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMovePayload", "description": "Return type for `fulfillmentOrderMove` mutation.", "fields": [ { "name": "movedFulfillmentOrder", "description": "The fulfillment order which now contains the moved line items and is assigned to the destination location.\n\nIf the original fulfillment order doesn't have any line items which are fully or partially fulfilled, the original fulfillment order will be moved to the new location.\nHowever if this isn't the case, the moved fulfillment order will differ from the original one.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalFulfillmentOrder", "description": "The final state of the original fulfillment order.\n\nAs a result of the move operation, the original fulfillment order might be moved to the new location\nor remain in the original location. The original fulfillment order might have the same status or be closed.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingFulfillmentOrder", "description": "This field is deprecated.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderOpenPayload", "description": "Return type for `fulfillmentOrderOpen` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order that was transitioned to open and is fulfillable.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderRejectCancellationRequestPayload", "description": "Return type for `fulfillmentOrderRejectCancellationRequest` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order whose cancellation request was rejected.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderRejectFulfillmentRequestPayload", "description": "Return type for `fulfillmentOrderRejectFulfillmentRequest` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order whose fulfillment request was rejected.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderRejectionReason", "description": "The reason for a fulfillment order rejection.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INCORRECT_ADDRESS", "description": "The fulfillment order was rejected because of an incorrect address.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_OUT_OF_STOCK", "description": "The fulfillment order was rejected because inventory is out of stock.", "isDeprecated": false, "deprecationReason": null }, { "name": "INELIGIBLE_PRODUCT", "description": "The fulfillment order was rejected because of an ineligible product.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNDELIVERABLE_DESTINATION", "description": "The fulfillment order was rejected because of an undeliverable destination.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The fulfillment order was rejected for another reason.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderReleaseHoldPayload", "description": "Return type for `fulfillmentOrderReleaseHold` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order on which the hold was released.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderReleaseHoldUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderReleaseHoldUserError", "description": "An error that occurs during the execution of `FulfillmentOrderReleaseHold`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderReleaseHoldUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderReleaseHoldUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderReleaseHoldUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDER_NOT_FOUND", "description": "The fulfillment order wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_ZERO", "description": "The fulfillment order line item quantity must be greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LINE_ITEM_QUANTITY", "description": "The fulfillment order line item quantity is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderRequestStatus", "description": "The request status of a fulfillment order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNSUBMITTED", "description": "The initial request status for the newly-created fulfillment orders. This is the only valid\nrequest status for fulfillment orders that aren't assigned to a fulfillment service.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBMITTED", "description": "The merchant requested fulfillment for this fulfillment order.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACCEPTED", "description": "The fulfillment service accepted the merchant's fulfillment request.", "isDeprecated": false, "deprecationReason": null }, { "name": "REJECTED", "description": "The fulfillment service rejected the merchant's fulfillment request.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLATION_REQUESTED", "description": "The merchant requested a cancellation of the fulfillment request for this fulfillment order.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLATION_ACCEPTED", "description": "The fulfillment service accepted the merchant's fulfillment cancellation request.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLATION_REJECTED", "description": "The fulfillment service rejected the merchant's fulfillment cancellation request.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSED", "description": "The fulfillment service closed the fulfillment order without completing it.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderReschedulePayload", "description": "Return type for `fulfillmentOrderReschedule` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "A fulfillment order with the rescheduled line items.\n\nFulfillment orders may be merged if they have the same `fulfillAt` datetime.\n\nIf the fulfillment order is merged then the resulting fulfillment order will be returned.\nOtherwise the original fulfillment order will be returned with an updated `fulfillAt` datetime.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderRescheduleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderRescheduleUserError", "description": "An error that occurs during the execution of `FulfillmentOrderReschedule`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderRescheduleUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderRescheduleUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderRescheduleUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDER_NOT_FOUND", "description": "Fulfillment order could not be found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderSortKeys", "description": "The set of valid sort keys for the FulfillmentOrder query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderSplitInput", "description": "The input fields for the split applied to the fulfillment order.", "fields": null, "inputFields": [ { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be split out.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "fulfillmentOrderId", "description": "The ID of the fulfillment order to be split.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSplitPayload", "description": "Return type for `fulfillmentOrderSplit` mutation.", "fields": [ { "name": "fulfillmentOrderSplits", "description": "The result of the fulfillment order splits.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderSplitResult", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderSplitUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSplitResult", "description": "The result of splitting a fulfillment order.", "fields": [ { "name": "fulfillmentOrder", "description": "The original fulfillment order as a result of the split.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingFulfillmentOrder", "description": "The remaining fulfillment order as a result of the split.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "replacementFulfillmentOrder", "description": "The replacement fulfillment order if the original fulfillment order wasn't in a state to be split.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSplitUserError", "description": "An error that occurs during the execution of `FulfillmentOrderSplit`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrderSplitUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderSplitUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrderSplitUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDER_NOT_FOUND", "description": "The fulfillment order could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The fulfillment order line item quantity must be greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LINE_ITEM_QUANTITY", "description": "The fulfillment order line item quantity is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_LINE_ITEMS_PROVIDED_TO_SPLIT", "description": "The fulfillment order must have at least one line item input to split.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrderStatus", "description": "The status of a fulfillment order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OPEN", "description": "The fulfillment order is ready for fulfillment.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_PROGRESS", "description": "The fulfillment order is being processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLED", "description": "The fulfillment order has been cancelled by the merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCOMPLETE", "description": "The fulfillment order cannot be completed as requested.", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSED", "description": "The fulfillment order has been completed and closed.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "The fulfillment order is deferred and will be ready for fulfillment after the date and time specified in `fulfill_at`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ON_HOLD", "description": "The fulfillment order is on hold. The fulfillment process can't be initiated until the hold on the fulfillment order is released.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSubmitCancellationRequestPayload", "description": "Return type for `fulfillmentOrderSubmitCancellationRequest` mutation.", "fields": [ { "name": "fulfillmentOrder", "description": "The fulfillment order specified in the cancelation request.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSubmitFulfillmentRequestPayload", "description": "Return type for `fulfillmentOrderSubmitFulfillmentRequest` mutation.", "fields": [ { "name": "originalFulfillmentOrder", "description": "The original fulfillment order intended to request fulfillment for.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "submittedFulfillmentOrder", "description": "The fulfillment order that was submitted to the fulfillment service. This will be the same as\nthe original fulfillment order field. The exception to this is partial fulfillment requests or\nfulfillment request for cancelled or incomplete fulfillment orders.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "unsubmittedFulfillmentOrder", "description": "This field will only be present for partial fulfillment requests. This will represent the new\nfulfillment order with the remaining line items not submitted to the fulfillment service.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrderSupportedAction", "description": "One of the actions that the fulfillment order supports in its current state.\n", "fields": [ { "name": "action", "description": "The action value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentOrderAction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "externalUrl", "description": "The external URL to be used to initiate the fulfillment process outside Shopify.\nApplicable only when the `action` value is `EXTERNAL`.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersReleaseHoldsPayload", "description": "Return type for `fulfillmentOrdersReleaseHolds` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that will release the fulfillment holds.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrdersReleaseHoldsUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersReleaseHoldsUserError", "description": "An error that occurs during the execution of `FulfillmentOrdersReleaseHolds`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrdersReleaseHoldsUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrdersReleaseHoldsUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrdersReleaseHoldsUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FAILED_TO_CREATE_JOB", "description": "Failed to create release fulfillment order holds job.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersSetFulfillmentDeadlinePayload", "description": "Return type for `fulfillmentOrdersSetFulfillmentDeadline` mutation.", "fields": [ { "name": "success", "description": "Whether the fulfillment deadline was successfully set.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", "description": "An error that occurs during the execution of `FulfillmentOrdersSetFulfillmentDeadline`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "FulfillmentOrdersSetFulfillmentDeadlineUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentOrdersSetFulfillmentDeadlineUserErrorCode", "description": "Possible error codes that can be returned by `FulfillmentOrdersSetFulfillmentDeadlineUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_ORDERS_NOT_FOUND", "description": "The fulfillment orders could not be found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentOriginAddress", "description": "The address at which the fulfillment occurred. This object is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the `assignedLocation` field on the [`FulfillmentOrder`](/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object instead.", "fields": [ { "name": "address1", "description": "The street address of the fulfillment location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city in which the fulfillment location is located.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The country code of the fulfillment location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The province code of the fulfillment location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip code of the fulfillment location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentOriginAddressInput", "description": "The input fields used to include the address at which the fulfillment occurred. This input object is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the `assignedLocation` field on the [`FulfillmentOrder`](/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object instead.", "fields": null, "inputFields": [ { "name": "address1", "description": "The street address of the fulfillment location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The city in which the fulfillment location is located.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zip", "description": "The zip code of the fulfillment location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "provinceCode", "description": "The province of the fulfillment location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryCode", "description": "The country of the fulfillment location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentService", "description": "A **Fulfillment Service** is a third party warehouse that prepares and ships orders\non behalf of the store owner. Fulfillment services charge a fee to package and ship items\nand update product inventory levels. Some well known fulfillment services with Shopify integrations\ninclude: Amazon, Shipwire, and Rakuten. When an app registers a new `FulfillmentService` on a store,\nShopify automatically creates a `Location` that's associated to the fulfillment service.\nTo learn more about fulfillment services, refer to\n[Manage fulfillments as a fulfillment service app](https://shopify.dev/apps/fulfillment/fulfillment-service-apps)\nguide.\n\n## Mutations\n\nYou can work with the `FulfillmentService` object with the\n[fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate),\n[fulfillmentServiceUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceUpdate),\nand [fulfillmentServiceDelete](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceDelete)\nmutations.\n\n## Hosted endpoints\n\nFulfillment service providers integrate with Shopify by providing Shopify with a set of hosted endpoints that\nShopify can query on certain conditions.\nThese endpoints must have a common prefix, and this prefix should be supplied in the `callbackUrl` parameter\nin the\n[fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate)\nmutation.\n\n- Shopify sends POST requests to the `/fulfillment_order_notification` endpoint\n to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests,\n if `fulfillment_orders_opt_in` is set to `true`.\n\n [As of the 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation),\n it's mandatory for a fulfillment service to follow a fulfillment order based workflow by\n having `fulfillment_orders_opt_in` set to `true`,\n hosting the `/fulfillment_order_notification` endpoint, and acting on fulfillment requests and cancellations.\n\n For more information, refer to\n [Receive fulfillment requests and cancellations](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n- Shopify sends GET requests to the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers for orders,\n if `trackingSupport` is set to `true`.\n\n For more information, refer to\n [Enable tracking support](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-8-enable-tracking-support-optional).\n\n Fulfillment services can also update tracking information with the\n [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation,\n rather than waiting for Shopify to ask for tracking numbers.\n- Shopify sends GET requests to the `/fetch_stock` endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n\n For more information, refer to\n [Sharing inventory levels with Shopify](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-9-share-inventory-levels-with-shopify-optional).\n\nTo make sure you have everything set up correctly, you can test the `callbackUrl`-prefixed endpoints\nin your development store.\n\n## Resources and webhooks\n\nThere are a variety of objects and webhooks that enable a fulfillment service to work.\nTo exchange fulfillment information with Shopify, fulfillment services use the\n[FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder),\n[Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) and\n[Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) objects and related mutations.\nTo act on fulfillment process events that happen on the Shopify side,\nbesides awaiting calls to `callbackUrl`-prefixed endpoints,\nfulfillment services can subscribe to the\n[fulfillment order](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks)\nand [order](https://shopify.dev/api/admin-rest/latest/resources/webhook)\nwebhooks.\n", "fields": [ { "name": "callbackUrl", "description": "The callback URL that the fulfillment service has registered for requests. The following considerations apply:\n\n- Shopify queries the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the `/fetch_stock` endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the `/fulfillment_order_notification` endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations),\n if the fulfillment service has opted in to the fulfillment order based workflow for managing fulfillments\n (`fulfillmentOrdersOptIn` is set to `true`).\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrdersOptIn", "description": "Whether the fulfillment service uses the [fulfillment order based workflow](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments) for managing fulfillments.\n\nAs the migration is now finished, the `fulfillmentOrdersOptIn` property is [deprecated](\nhttps://shopify.dev/changelog/deprecation-of-the-fulfillmentservice-fulfillmentordersoptin-field)\nand is always set to `true` on correctly functioning fulfillment services.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Migration period ended. All correctly functioning fulfillment services have `fulfillmentOrdersOptIn` set to `true`." }, { "name": "handle", "description": "Human-readable unique identifier for this fulfillment service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the fulfillment service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryManagement", "description": "Whether the fulfillment service tracks product inventory and provides updates to Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "Location associated with the fulfillment service.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "permitsSkuSharing", "description": "Whether the fulfillment service can stock inventory alongside other locations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productBased", "description": "Whether the fulfillment service supports local deliveries.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "serviceName", "description": "The name of the fulfillment service as seen by merchants.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingMethods", "description": "Shipping methods associated with the fulfillment service provider. Applies only to Fulfill By Amazon fulfillment service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingMethod", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "The Fulfillment by Amazon feature will no longer be supported from March 30, 2023. To continue using Amazon fulfillment, merchants need to set up a Multi-Channel Fulfillment solution recommended by Amazon: https://help.shopify.com/manual/shipping/fulfillment-services/amazon#activate-fulfillment-by-amazon" }, { "name": "type", "description": "Type associated with the fulfillment service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FulfillmentServiceType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentServiceCreatePayload", "description": "Return type for `fulfillmentServiceCreate` mutation.", "fields": [ { "name": "fulfillmentService", "description": "The created fulfillment service.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentServiceDeletePayload", "description": "Return type for `fulfillmentServiceDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted fulfillment service.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentServiceType", "description": "The type of a fulfillment service.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "GIFT_CARD", "description": "Fulfillment by gift card.", "isDeprecated": false, "deprecationReason": null }, { "name": "MANUAL", "description": "Manual fulfillment by the merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "THIRD_PARTY", "description": "Fullfillment by a third-party fulfillment service.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentServiceUpdatePayload", "description": "Return type for `fulfillmentServiceUpdate` mutation.", "fields": [ { "name": "fulfillmentService", "description": "The updated fulfillment service.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FulfillmentStatus", "description": "The status of a fulfillment.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`.\n", "isDeprecated": true, "deprecationReason": "This is a legacy status and is due to be deprecated." }, { "name": "OPEN", "description": "The third-party fulfillment service has acknowledged the fulfillment and is processing it.\n", "isDeprecated": true, "deprecationReason": "This is a legacy status and is due to be deprecated." }, { "name": "SUCCESS", "description": "The fulfillment was completed successfully.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLED", "description": "The fulfillment was canceled.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERROR", "description": "There was an error with the fulfillment request.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILURE", "description": "The fulfillment request failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentTrackingInfo", "description": "Represents the tracking information for a fulfillment.", "fields": [ { "name": "company", "description": "The name of the tracking company.\n\nFor tracking company names from the list below\nShopify will automatically build tracking URLs for all provided tracking numbers,\nwhich will make the tracking numbers clickable in the interface.\n\nAdditionally, for the tracking companies listed on the\n[Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers)\nShopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process.\n\n### Supported tracking companies\n\nThe following tracking companies display for shops located in any country:\n\n * 4PX\n * AGS\n * Amazon Logistics UK\n * Amazon Logistics US\n * An Post\n * Anjun Logistics\n * APC\n * Asendia USA\n * Australia Post\n * Bonshaw\n * BPost\n * BPost International\n * Canada Post\n * Canpar\n * CDL Last Mile\n * China Post\n * Chronopost\n * Chukou1\n * Colissimo\n * Comingle\n * Coordinadora\n * Correios\n * Correos\n * CTT\n * CTT Express\n * Cyprus Post\n * Delnext\n * Deutsche Post\n * DHL eCommerce\n * DHL eCommerce Asia\n * DHL Express\n * DPD\n * DPD Local\n * DPD UK\n * DTD Express\n * DX\n * Eagle\n * Estes\n * Evri\n * FedEx\n * First Global Logistics\n * First Line\n * FSC\n * Fulfilla\n * GLS\n * Guangdong Weisuyi Information Technology (WSE)\n * Heppner Internationale Spedition GmbH & Co.\n * Iceland Post\n * IDEX\n * Israel Post\n * Japan Post (EN)\n * Japan Post (JA)\n * La Poste\n * Lasership\n * Latvia Post\n * Lietuvos Paštas\n * Logisters\n * Lone Star Overnight\n * M3 Logistics\n * Meteor Space\n * Mondial Relay\n * New Zealand Post\n * NinjaVan\n * North Russia Supply Chain (Shenzhen) Co.\n * OnTrac\n * Packeta\n * Pago Logistics\n * Ping An Da Tengfei Express\n * Pitney Bowes\n * Portal PostNord\n * Poste Italiane\n * PostNL\n * PostNord DK\n * PostNord NO\n * PostNord SE\n * Purolator\n * Qxpress\n * Qyun Express\n * Royal Mail\n * Royal Shipments\n * Sagawa (EN)\n * Sagawa (JA)\n * Sendle\n * SF Express\n * SFC Fulfillment\n * SHREE NANDAN COURIER\n * Singapore Post\n * Southwest Air Cargo\n * StarTrack\n * Step Forward Freight\n * Swiss Post\n * TForce Final Mile\n * Tinghao\n * TNT\n * Toll IPEC\n * United Delivery Service\n * UPS\n * USPS\n * Venipak\n * We Post\n * Whistl\n * Wizmo\n * WMYC\n * Xpedigo\n * XPO Logistics\n * Yamato (EN)\n * Yamato (JA)\n * YiFan Express\n * YunExpress\n\nThe following tracking companies are displayed for shops located in specific countries:\n\n * **Australia**: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics\n * **Austria**: Österreichische Post\n * **Bulgaria**: Speedy\n * **Canada**: Intelcom, BoxKnight, Loomis, GLS\n * **China**: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC\n * **Czechia**: Zásilkovna\n * **Germany**: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS\n * **Spain**: SEUR\n * **France**: Colissimo, Mondial Relay, Colis Privé, GLS\n * **United Kingdom**: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells\n * **Greece**: ACS Courier\n * **Hong Kong SAR**: SF Express\n * **Ireland**: Fastway, DPD Ireland\n * **India**: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart\n * **Italy**: BRT, GLS Italy\n * **Japan**: エコ配, 西濃運輸, 西濃スーパーエキスプレス, 福山通運, 日本通運, 名鉄運輸, 第一貨物\n * **Netherlands**: DHL Parcel, DPD\n * **Norway**: Bring\n * **Poland**: Inpost\n * **Turkey**: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo\n * **United States**: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo\n * **South Africa**: Fastway, Skynet.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The tracking number of the fulfillment.\n\nThe tracking number is clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking url provided in the `url` field.\n* [Shopify-known tracking company name](#supported-tracking-companies) specified in the `company` field.\n Shopify will build the tracking URL automatically based on the tracking number specified.\n* The tracking number has a Shopify-known format.\n Shopify will guess the tracking provider and build the tracking url based on the tracking number format.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URL.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URLs to track the fulfillment.\n\nThe tracking URL is displayed in the merchant's admin on the order page.\nThe tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, it's also displayed in the customer's order history.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FulfillmentTrackingInfoUpdateV2Payload", "description": "Return type for `fulfillmentTrackingInfoUpdateV2` mutation.", "fields": [ { "name": "fulfillment", "description": "The updated fulfillment with tracking information.", "args": [], "type": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentTrackingInput", "description": "The input fields that specify all possible fields for tracking information.\n\n> Note:\n> If you provide the `url` field, you should not provide the `urls` field.\n>\n> If you provide the `number` field, you should not provide the `numbers` field.\n>\n> If you provide the `url` field, you should provide the `number` field.\n>\n> If you provide the `urls` field, you should provide the `numbers` field.\n", "fields": null, "inputFields": [ { "name": "number", "description": "The tracking number of the fulfillment.\n\nThe tracking number will be clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking url provided in the `url` field.\n* [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n specified in the `company` field.\n Shopify will build the tracking URL automatically based on the tracking number specified.\n* The tracking number has a Shopify-known format.\n Shopify will guess the tracking provider and build the tracking url based on the tracking number format.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URL.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "url", "description": "The URL to track the fulfillment.\n\nThe tracking URL is displayed in the merchant's admin on the order page.\nThe tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, it's also displayed in the customer's order history.\n\nThe URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\nFor example, `\"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER\"` is a valid URL.\nIt includes a scheme (`https`) and a host (`myshipping.com`).\n", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "company", "description": "The name of the tracking company.\n\nIf you specify a tracking company name from\n[the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies),\nShopify will automatically build tracking URLs for all provided tracking numbers,\nwhich will make the tracking numbers clickable in the interface.\nThe same tracking company will be applied to all tracking numbers specified.\n\nAdditionally, for the tracking companies listed on the\n[Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers)\nShopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process.\n\n> Note:\n> Send the tracking company name exactly as written in\n> [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n> (capitalization matters).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "numbers", "description": "The tracking numbers of the fulfillment, one or many.\n\nWith multiple tracking numbers, you can provide tracking information\nfor all shipments associated with the fulfillment, if there are more than one.\nFor example, if you're shipping assembly parts of one furniture item in several boxes.\n\nTracking numbers will be clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking URLs provided in the `urls` field.\n The tracking URLs will be matched to the tracking numbers based on their positions in the arrays.\n* [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n specified in the `company` field.\n Shopify will build tracking URLs automatically for all tracking numbers specified.\n The same tracking company will be applied to all tracking numbers.\n* Tracking numbers have a Shopify-known format.\n Shopify will guess tracking providers and build tracking URLs based on the tracking number formats.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URLs.\n\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "urls", "description": "The URLs to track the fulfillment, one or many.\n\nThe tracking URLs are displayed in the merchant's admin on the order page.\nThe tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, the tracking URLs are also displayed in the customer's order history.\n\nIf you're not specifying a\n[Shopify-known](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\ntracking company name in the `company` field,\nthen provide tracking URLs for all tracking numbers from the `numbers` field.\n\nTracking URLs from the `urls` array field are being matched with the tracking numbers from the `numbers` array\nfield correspondingly their positions in the arrays.\n\nEach URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\nFor example, `\"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER\"` is a valid URL.\nIt includes a scheme (`https`) and a host (`myshipping.com`).\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FulfillmentV2Input", "description": "The input fields used to create a fulfillment from fulfillment orders.", "fields": null, "inputFields": [ { "name": "trackingInfo", "description": "The fulfillment's tracking information, including a tracking URL, a tracking number,\nand the company associated with the fulfillment.\n", "type": { "kind": "INPUT_OBJECT", "name": "FulfillmentTrackingInput", "ofType": null }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether the customer is notified.\nIf `true`, then a notification is sent when the fulfillment is created. The default value is `false`.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "lineItemsByFulfillmentOrder", "description": "Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment\norder line items that have to be fulfilled for each fulfillment order. For any given pair, if the\nfulfillment order line items are left blank then all the fulfillment order line items of the\nassociated fulfillment order ID will be fulfilled.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemsInput", "ofType": null } } } }, "defaultValue": null }, { "name": "originAddress", "description": "Address information about the location from which the order was fulfilled.\n", "type": { "kind": "INPUT_OBJECT", "name": "FulfillmentOriginAddressInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FunctionsAppBridge", "description": "The App Bridge information for a Shopify Function.", "fields": [ { "name": "createPath", "description": "The relative path for creating a customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "detailsPath", "description": "The relative path for viewing a customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FunctionsErrorHistory", "description": "The error history from running a Shopify Function.", "fields": [ { "name": "errorsFirstOccurredAt", "description": "The date and time that the first error occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstOccurredAt", "description": "The date and time that the first error occurred.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasBeenSharedSinceLastError", "description": "Whether the merchant has shared all the recent errors with the developer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasSharedRecentErrors", "description": "Whether the merchant has shared all the recent errors with the developer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GenericFile", "description": "Represents any file other than HTML.\n", "fields": [ { "name": "alt", "description": "A word or phrase to describe the contents or the function of a file.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileErrors", "description": "Any errors that have occurred on the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileStatus", "description": "The status of the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FileStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mimeType", "description": "The generic file's MIME type.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalFileSize", "description": "The generic file's size in bytes.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The generic file's URL.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "File", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCard", "description": "Represents an issued gift card.", "fields": [ { "name": "balance", "description": "The gift card's remaining balance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time at which the gift card was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer who will receive the gift card.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "disabledAt", "description": "The date and time at which the gift card was disabled.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Whether the gift card is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiresOn", "description": "The date at which the gift card will expire.", "args": [], "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "initialValue", "description": "The initial value of the gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastCharacters", "description": "The final four characters of the gift card code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maskedCode", "description": "The gift card code. Everything but the final four characters is masked.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note associated with the gift card, which isn't visible to the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the gift card. This value is `null` if the gift card was issued manually.\n", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardConnection", "description": "An auto-generated type for paginating through multiple GiftCards.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in GiftCardEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCard", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "GiftCardCreateInput", "description": "The input fields to issue a gift card.", "fields": null, "inputFields": [ { "name": "initialValue", "description": "The initial value of the gift card.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "defaultValue": null }, { "name": "code", "description": "The gift card's code. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9).\nIt isn't case sensitive. If not provided, then a random code will be generated.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "customerId", "description": "The ID of the customer who will receive the gift card. Requires `write_customers` access_scope.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "expiresOn", "description": "The date at which the gift card will expire. If not provided, then the gift card will never expire.\n", "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "The note associated with the gift card, which isn't visible to the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "templateSuffix", "description": "The suffix of the Liquid template that's used to render the gift card online.\nFor example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`.\nIf not provided, then the default `gift_card.liquid` template is used.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardCreatePayload", "description": "Return type for `giftCardCreate` mutation.", "fields": [ { "name": "giftCard", "description": "The created gift card.", "args": [], "type": { "kind": "OBJECT", "name": "GiftCard", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardCode", "description": "The created gift card's code.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardDisablePayload", "description": "Return type for `giftCardDisable` mutation.", "fields": [ { "name": "giftCard", "description": "The disabled gift card.", "args": [], "type": { "kind": "OBJECT", "name": "GiftCard", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardEdge", "description": "An auto-generated type which holds one GiftCard and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of GiftCardEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCard", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "GiftCardErrorCode", "description": "Possible error codes that can be returned by `GiftCardUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENT", "description": "Missing a required argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardSale", "description": "A sale associated with a gift card.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The line item for the associated sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "GiftCardSortKeys", "description": "The set of valid sort keys for the GiftCard query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_NAME", "description": "Sort by the `customer_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CODE", "description": "Sort by the `code` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "BALANCE", "description": "Sort by the `balance` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMOUNT_SPENT", "description": "Sort by the `amount_spent` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INITIAL_VALUE", "description": "Sort by the `initial_value` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISABLED_AT", "description": "Sort by the `disabled_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRES_ON", "description": "Sort by the `expires_on` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "GiftCardUpdateInput", "description": "The input fields to update a gift card.", "fields": null, "inputFields": [ { "name": "note", "description": "The note associated with the gift card, which isn't visible to the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "expiresOn", "description": "The date at which the gift card will expire. If set to `null`, then the gift card will never expire.\n", "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "defaultValue": null }, { "name": "customerId", "description": "The ID of the customer who will receive the gift card. The ID can't be changed if the gift card already has an assigned customer ID.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "templateSuffix", "description": "The suffix of the Liquid template that's used to render the gift card online.\nFor example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardUpdatePayload", "description": "Return type for `giftCardUpdate` mutation.", "fields": [ { "name": "giftCard", "description": "The updated gift card.", "args": [], "type": { "kind": "OBJECT", "name": "GiftCard", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardUserError", "description": "Represents an error that happens during the execution of a gift card mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "GiftCardErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "HTML", "description": "A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a\ncomplete list of HTML elements.\n\nExample value: `\"

Grey cotton knit sweater.

\"`\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "HasEvents", "description": "Represents an object that has a list of events.", "fields": [ { "name": "events", "description": "The paginated list of events associated with the host subject.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PriceRule", "ofType": null } ] }, { "kind": "INTERFACE", "name": "HasLocalizationExtensions", "description": "Localization extensions associated with the specified resource. For example, the tax id for government invoice.\n", "fields": [ { "name": "localizationExtensions", "description": "List of localization extensions for the resource.", "args": [ { "name": "countryCodes", "description": "The country codes of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "purposes", "description": "The purpose of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionPurpose", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtensionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null } ] }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "description": "Resources that metafield definitions can be applied to.", "fields": [ { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, { "kind": "OBJECT", "name": "Location", "ofType": null }, { "kind": "OBJECT", "name": "Market", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "Validation", "ofType": null } ] }, { "kind": "INTERFACE", "name": "HasMetafields", "description": "Represents information about the metafields associated to the specified resource.", "fields": [ { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppInstallation", "ofType": null }, { "kind": "OBJECT", "name": "CartTransform", "ofType": null }, { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "CustomerSegmentMember", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRule", "ofType": null }, { "kind": "OBJECT", "name": "Image", "ofType": null }, { "kind": "OBJECT", "name": "Location", "ofType": null }, { "kind": "OBJECT", "name": "Market", "ofType": null }, { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "Shop", "ofType": null }, { "kind": "OBJECT", "name": "Validation", "ofType": null } ] }, { "kind": "INTERFACE", "name": "HasPublishedTranslations", "description": "Published translations associated with the resource.", "fields": [ { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "Link", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreArticle", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreBlog", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductOption", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionValue", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlan", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, { "kind": "OBJECT", "name": "Shop", "ofType": null }, { "kind": "OBJECT", "name": "ShopPolicy", "ofType": null } ] }, { "kind": "SCALAR", "name": "ID", "description": "Represents a unique identifier, often used to refetch an object.\nThe ID type appears in a JSON response as a String, but it is not intended to be human-readable.\n\nExample value: `\"gid://shopify/Product/10079785100\"`\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Image", "description": "Represents an image resource.", "fields": [ { "name": "altText", "description": "A word or phrase to share the nature or contents of an image.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "height", "description": "The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A unique ID for the image.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalSrc", "description": "The location of the original image as a URL.\n\nIf there are any existing transformations in the original source URL, they will remain and not be stripped.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `url` instead." }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "src", "description": "The location of the image as a URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `url` instead." }, { "name": "transformedSrc", "description": "The location of the transformed image as a URL.\n\nAll transformation arguments are considered \"best-effort\". If they can be applied to an image, they will be.\nOtherwise any transformations which an image type doesn't support will be ignored.\n", "args": [ { "name": "maxWidth", "description": "Image width in pixels between 1 and 5760.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "maxHeight", "description": "Image height in pixels between 1 and 5760.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "crop", "description": "Crops the image according to the specified region.", "type": { "kind": "ENUM", "name": "CropRegion", "ofType": null }, "defaultValue": null }, { "name": "scale", "description": "Image size multiplier for high-resolution retina displays. Must be between 1 and 3.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "preferredContentType", "description": "Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported).", "type": { "kind": "ENUM", "name": "ImageContentType", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `url(transform:)` instead" }, { "name": "url", "description": "The location of the image as a URL.\n\nIf no transform options are specified, then the original image will be preserved including any pre-applied transforms.\n\nAll transformation options are considered \"best-effort\". Any transformation that the original image type doesn't support will be ignored.\n\nIf you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).\n", "args": [ { "name": "transform", "description": "A set of options to transform the original image.", "type": { "kind": "INPUT_OBJECT", "name": "ImageTransformInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "width", "description": "The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ImageConnection", "description": "An auto-generated type for paginating through multiple Images.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ImageEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ImageEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ImageContentType", "description": "List of supported image content types.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PNG", "description": "A PNG image.", "isDeprecated": false, "deprecationReason": null }, { "name": "JPG", "description": "A JPG image.", "isDeprecated": false, "deprecationReason": null }, { "name": "WEBP", "description": "A WEBP image.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ImageEdge", "description": "An auto-generated type which holds one Image and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ImageEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ImageInput", "description": "The input fields for an image.", "fields": null, "inputFields": [ { "name": "id", "description": "A globally-unique ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "altText", "description": "A word or phrase to share the nature or contents of an image.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "src", "description": "The URL of the image. May be a staged upload URL.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ImageTransformInput", "description": "The available options for transforming an image.\n\nAll transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored.\n", "fields": null, "inputFields": [ { "name": "crop", "description": "The region of the image to remain after cropping.\nMust be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal.\nThe `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while\na smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result\nin an image with a width of 5 and height of 10, where the right side of the image is removed.\n", "type": { "kind": "ENUM", "name": "CropRegion", "ofType": null }, "defaultValue": null }, { "name": "maxWidth", "description": "Image width in pixels between 1 and 5760.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "maxHeight", "description": "Image height in pixels between 1 and 5760.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "scale", "description": "Image size multiplier for high-resolution retina displays. Must be within 1..3.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "preferredContentType", "description": "Convert the source image into the preferred content type.\nSupported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`.\n", "type": { "kind": "ENUM", "name": "ImageContentType", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ImageUploadParameter", "description": "A parameter to upload an image.\n\nDeprecated in favor of\n[StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter),\nwhich is used in\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget)\nand returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", "fields": [ { "name": "name", "description": "The parameter name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The parameter value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "IncomingRequestLineItemInput", "description": "The input fields for the incoming line item.", "fields": null, "inputFields": [ { "name": "fulfillmentOrderLineItemId", "description": "The ID of the rejected line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "The rejection message of the line item.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Int", "description": "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryActivatePayload", "description": "Return type for `inventoryActivate` mutation.", "fields": [ { "name": "inventoryLevel", "description": "The inventory level that was activated.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryAdjustQuantitiesInput", "description": "The input fields required to adjust inventory quantities.", "fields": null, "inputFields": [ { "name": "reason", "description": "The reason for the quantity changes. The value must be one of the [possible \nreasons](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#set-inventory-quantities-on-hand).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The quantity [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)\nto be adjusted.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "referenceDocumentUri", "description": "The reference document URI for the changes. Used to denote what's causing the change.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "changes", "description": "The quantity changes of items at locations to be made.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryChangeInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryAdjustQuantitiesPayload", "description": "Return type for `inventoryAdjustQuantities` mutation.", "fields": [ { "name": "inventoryAdjustmentGroup", "description": "The group of changes made by the operation.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryAdjustmentGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryAdjustQuantitiesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryAdjustQuantitiesUserError", "description": "An error that occurs during the execution of `InventoryAdjustQuantities`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "InventoryAdjustQuantitiesUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "InventoryAdjustQuantitiesUserErrorCode", "description": "Possible error codes that can be returned by `InventoryAdjustQuantitiesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_LEDGER_DOCUMENT", "description": "Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_AVAILABLE_DOCUMENT", "description": "A ledger document URI is not allowed when adjusting available.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INVENTORY_ITEM", "description": "The specified inventory item could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LEDGER_DOCUMENT", "description": "The specified ledger document is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LOCATION", "description": "The specified location could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_DOCUMENT", "description": "A ledger document URI is required except when adjusting available.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_NAME", "description": "The specified quantity name is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_TOO_LOW", "description": "The quantity can't be lower than -2,000,000,000.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_TOO_HIGH", "description": "The quantity can't be higher than 2,000,000,000.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REASON", "description": "The specified reason is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REFERENCE_DOCUMENT", "description": "The specified reference document is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "ADJUST_QUANTITIES_FAILED", "description": "The quantities couldn't be adjusted. Try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAX_ONE_LEDGER_DOCUMENT", "description": "All changes must have the same ledger document URI or, in the case of adjusting available, no ledger document URI.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_NOT_STOCKED_AT_LOCATION", "description": "The inventory item is not stocked at the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_MUTABLE_INVENTORY_ITEM", "description": "The specified inventory item is not allowed to be adjusted via API.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryAdjustmentGroup", "description": "Represents a group of adjustments made as part of the same operation.\n", "fields": [ { "name": "app", "description": "The app that triggered the inventory event, if one exists.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "changes", "description": "The set of inventory quantity changes that occurred in the inventory event.", "args": [ { "name": "inventoryItemIds", "description": "The IDs of the inventory items to filter changes by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "locationIds", "description": "The IDs of the locations to filter changes by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "quantityNames", "description": "The [names](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)\nof the requested inventory quantities.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryChange", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time the inventory adjustment group was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason for the group of adjustments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "referenceDocumentUri", "description": "The reference document URI for the changes. Denotes what's causing the change.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The staff member associated with the inventory event.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryBulkToggleActivationInput", "description": "The input fields to specify whether the inventory item should be activated or not at the specified location.\n", "fields": null, "inputFields": [ { "name": "locationId", "description": "The ID of the location to modify the inventory item's stocked status.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "activate", "description": "Whether the inventory item can be stocked at the specified location. To deactivate, set the value to false which removes an inventory item's quantities from that location, and turns off inventory at that location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryBulkToggleActivationPayload", "description": "Return type for `inventoryBulkToggleActivation` mutation.", "fields": [ { "name": "inventoryItem", "description": "The inventory item that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevels", "description": "The activated inventory levels.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryBulkToggleActivationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryBulkToggleActivationUserError", "description": "An error that occurred while setting the activation status of an inventory item.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "InventoryBulkToggleActivationUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "InventoryBulkToggleActivationUserErrorCode", "description": "Possible error codes that can be returned by `InventoryBulkToggleActivationUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "GENERIC_ERROR", "description": "An error occurred while setting the activation status.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DEACTIVATE_FROM_ONLY_LOCATION", "description": "Cannot unstock an inventory item from the only location at which it is stocked.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMMITTED_AND_INCOMING_INVENTORY_AT_LOCATION", "description": "Cannot unstock this inventory item from this location because it has committed and incoming quantities.", "isDeprecated": true, "deprecationReason": "This error code is deprecated. Both INCOMING_INVENTORY_AT_LOCATION and COMMITTED_INVENTORY_AT_LOCATION codes will be returned as individual errors instead." }, { "name": "INCOMING_INVENTORY_AT_LOCATION", "description": "Cannot unstock this inventory item from this location because it has incoming quantities.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMMITTED_INVENTORY_AT_LOCATION", "description": "Cannot unstock this inventory item from this location because it has committed quantities.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESERVED_INVENTORY_AT_LOCATION", "description": "Cannot unstock this inventory item from this location because it has unavailable quantities.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_UNSTOCK_FROM_LOCATION", "description": "Failed to unstock this inventory item from this location.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_MANAGED_BY_3RD_PARTY", "description": "Cannot stock this inventory item at this location because it is managed by a third-party fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_MANAGED_BY_SHOPIFY", "description": "Cannot stock this inventory item at this location because it is managed by Shopify.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_STOCK_AT_LOCATION", "description": "Failed to stock this inventory item at this location.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_SKU", "description": "Cannot stock this inventory item at this location because the variant is missing a SKU.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_NOT_FOUND", "description": "The location was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ITEM_NOT_FOUND", "description": "The inventory item was not found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryChange", "description": "Represents a change in an inventory quantity of an inventory item at a location.\n", "fields": [ { "name": "delta", "description": "The amount by which the inventory quantity was changed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "item", "description": "The inventory item associated with this inventory change.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ledgerDocumentUri", "description": "The ledger document URI for the change. Denotes who the change is applied to.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location associated with this inventory change.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)\nof the inventory quantity that was changed.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityAfterChange", "description": "The quantity of named inventory after the change.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryChangeInput", "description": "The input fields for the change to be made to an inventory item at a location.\n", "fields": null, "inputFields": [ { "name": "delta", "description": "The amount by which the inventory quantity will be changed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "inventoryItemId", "description": "Specifies the inventory item to which the change will be applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "Specifies the location at which the change will be applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "ledgerDocumentUri", "description": "The ledger document URI to which the quantity change is being applied. Not allowed for 'available' and required for other quantity names.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryDeactivatePayload", "description": "Return type for `inventoryDeactivate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryItem", "description": "Represents the goods available to be shipped to a customer.\nIt holds essential information about the goods, including SKU and whether it is tracked.\n", "fields": [ { "name": "countryCodeOfOrigin", "description": "The ISO 3166-1 alpha-2 country code of where the item originated from.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryHarmonizedSystemCodes", "description": "A list of country specific harmonized system codes.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CountryHarmonizedSystemCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the inventory item was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "duplicateSkuCount", "description": "The number of inventory items that share the same SKU with this item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "harmonizedSystemCode", "description": "The harmonized system code of the item.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryHistoryUrl", "description": "The URL that points to the inventory history for the item.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevel", "description": "The inventory item's quantities at the specified location.", "args": [ { "name": "locationId", "description": "ID of the location for which the inventory level is requested.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevels", "description": "A list of the inventory item's quantities for each location that the inventory item can be stocked at.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| inventory_group_id |\n| inventory_item_id |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevelConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsCount", "description": "The number of locations where this inventory item is stocked.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "measurement", "description": "The packaging dimensions of the inventory item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItemMeasurement", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCodeOfOrigin", "description": "The ISO 3166-2 alpha-2 province code of where the item originated from.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether the inventory item requires shipping.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "Inventory item SKU. Case-sensitive string.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tracked", "description": "Whether inventory levels are tracked for the item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "trackedEditable", "description": "Whether the value of the `tracked` field for the inventory item can be changed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EditableProperty", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unitCost", "description": "Unit cost associated with the inventory item. Note: the user must have \"View product costs\" permission granted in order to access this field once product granular permissions are enabled.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the inventory item was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The variant that owns this inventory item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryItemConnection", "description": "An auto-generated type for paginating through multiple InventoryItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in InventoryItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryItemEdge", "description": "An auto-generated type which holds one InventoryItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of InventoryItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryItemInput", "description": "The input fields for an inventory item.", "fields": null, "inputFields": [ { "name": "cost", "description": "Unit cost associated with the inventory item, the currency is the shop's default currency.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "tracked", "description": "Whether the inventory item is tracked.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "harmonizedSystemCode", "description": "The harmonized system code of the inventory item.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "measurement", "description": "The measurements of an inventory item.", "type": { "kind": "INPUT_OBJECT", "name": "InventoryItemMeasurementInput", "ofType": null }, "defaultValue": null }, { "name": "requiresShipping", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryItemMeasurement", "description": "Represents the packaged dimension for an inventory item.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The weight of the inventory item.", "args": [], "type": { "kind": "OBJECT", "name": "Weight", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryItemMeasurementInput", "description": "The input fields for an inventory item measurement.", "fields": null, "inputFields": [ { "name": "weight", "description": "The weight of the inventory item.", "type": { "kind": "INPUT_OBJECT", "name": "WeightInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryItemUpdateInput", "description": "The input fields for an inventory item.", "fields": null, "inputFields": [ { "name": "cost", "description": "Unit cost associated with the inventory item, the currency is the shop's default currency.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "tracked", "description": "Whether the inventory item is tracked. The value must be true to adjust the item's inventory levels.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "countryCodeOfOrigin", "description": "The ISO 3166-1 alpha-2 country code of where the item originated from.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "provinceCodeOfOrigin", "description": "The ISO 3166-2 alpha-2 province/state code of where the item originated from.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "harmonizedSystemCode", "description": "The harmonized system code of the inventory item. This must be a number between 6 and 13 digits.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryHarmonizedSystemCodes", "description": "List of country-specific harmonized system codes.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CountryHarmonizedSystemCodeInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryItemUpdatePayload", "description": "Return type for `inventoryItemUpdate` mutation.", "fields": [ { "name": "inventoryItem", "description": "The inventory item that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryLevel", "description": "The quantities of an inventory item that are related to a specific location.\n", "fields": [ { "name": "canDeactivate", "description": "Whether the inventory items associated with the inventory level can be deactivated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the inventory level was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deactivationAlert", "description": "Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "item", "description": "Inventory item associated with the inventory level.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location associated with the inventory level.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantities", "description": "Quantities for the requested names.", "args": [ { "name": "names", "description": "The\n[names](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)\nof the requested inventory quantities.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryQuantity", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "scheduledChanges", "description": "Scheduled changes for the requested quantity names.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ScheduledChangeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| expected_at |\n| quantity_names |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryScheduledChangeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the inventory level was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryLevelConnection", "description": "An auto-generated type for paginating through multiple InventoryLevels.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevelEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in InventoryLevelEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryLevelEdge", "description": "An auto-generated type which holds one InventoryLevel and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of InventoryLevelEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryLevelInput", "description": "The input fields for an inventory level.", "fields": null, "inputFields": [ { "name": "availableQuantity", "description": "The available quantity of an inventory item at a location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of a location associated with the inventory level.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantitiesInput", "description": "The input fields required to move inventory quantities.", "fields": null, "inputFields": [ { "name": "reason", "description": "The reason for the quantity changes. The value must be one of the [possible \nreasons](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#set-inventory-quantities-on-hand).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "referenceDocumentUri", "description": "The reference document URI for the changes. Used to denote what's causing the change.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "changes", "description": "The quantity changes of items at locations to be made.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantityChange", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryMoveQuantitiesPayload", "description": "Return type for `inventoryMoveQuantities` mutation.", "fields": [ { "name": "inventoryAdjustmentGroup", "description": "The group of changes made by the operation.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryAdjustmentGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryMoveQuantitiesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryMoveQuantitiesUserError", "description": "An error that occurs during the execution of `InventoryMoveQuantities`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "InventoryMoveQuantitiesUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "InventoryMoveQuantitiesUserErrorCode", "description": "Possible error codes that can be returned by `InventoryMoveQuantitiesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_LEDGER_DOCUMENT", "description": "Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_AVAILABLE_DOCUMENT", "description": "A ledger document URI is not allowed when adjusting available.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INVENTORY_ITEM", "description": "The specified inventory item could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LEDGER_DOCUMENT", "description": "The specified ledger document is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LOCATION", "description": "The specified location could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_DOCUMENT", "description": "A ledger document URI is required except when adjusting available.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_NAME", "description": "The specified quantity name is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_NEGATIVE", "description": "The quantity can't be negative.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_TOO_HIGH", "description": "The quantity can't be higher than 2,000,000,000.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REASON", "description": "The specified reason is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REFERENCE_DOCUMENT", "description": "The specified reference document is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "MOVE_QUANTITIES_FAILED", "description": "The quantities couldn't be moved. Try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "DIFFERENT_LOCATIONS", "description": "The quantities can't be moved between different locations.", "isDeprecated": false, "deprecationReason": null }, { "name": "SAME_QUANTITY_NAME", "description": "The quantity names for each change can't be the same.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_LEDGER_DOCUMENT_URIS", "description": "Only a maximum of 2 ledger document URIs across all changes is allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_NOT_STOCKED_AT_LOCATION", "description": "The inventory item is not stocked at the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_MUTABLE_INVENTORY_ITEM", "description": "The specified inventory item is not allowed to be adjusted via API.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantityChange", "description": "Represents the change to be made to an inventory item at a location.\nThe change can either involve the same quantity name between different locations,\nor involve different quantity names between the same location.\n", "fields": null, "inputFields": [ { "name": "inventoryItemId", "description": "Specifies the inventory item to which the change will be applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The amount by which the inventory quantity will be changed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "from", "description": "Details about where the move will be made from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantityTerminalInput", "ofType": null } }, "defaultValue": null }, { "name": "to", "description": "Details about where the move will be made to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantityTerminalInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantityTerminalInput", "description": "The input fields representing the change to be made to an inventory item at a location.\n", "fields": null, "inputFields": [ { "name": "locationId", "description": "Specifies the location at which the change will be applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The quantity\n[name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states) to be\nmoved.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "ledgerDocumentUri", "description": "The ledger document URI for the quantity move. Not allowed for 'available' and required for other quantity names.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryProperties", "description": "General inventory properties for the shop.", "fields": [ { "name": "quantityNames", "description": "All the quantity names.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryQuantityName", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryQuantity", "description": "Represents a quantity of an inventory item at a specific location, for a specific name.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)\nthat identifies the inventory quantity.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity for the quantity name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "When the quantity was last updated.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryQuantityName", "description": "Details about an individual quantity name.", "fields": [ { "name": "belongsTo", "description": "List of quantity names that this quantity name belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "comprises", "description": "List of quantity names that comprise this quantity name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The display name for quantity names translated into applicable language.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isInUse", "description": "Whether the quantity name has been used by the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states) of\nthe inventory quantity. Used by\n[inventory queries and mutations](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#graphql-queries-and-mutations).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryScheduledChange", "description": "Returns the scheduled changes to inventory states related to the ledger document.\n", "fields": [ { "name": "expectedAt", "description": "The date and time that the scheduled change is expected to happen.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fromName", "description": "The quantity\n[name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#move-inventory-quantities-between-states)\nto transition from.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevel", "description": "The quantities of an inventory item that are related to a specific location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ledgerDocumentUri", "description": "An active reference document associated with the inventory quantity. Must be a valid URI.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the scheduled change associated with the ledger document in the `from_name` state.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "toName", "description": "The quantity\n[name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#move-inventory-quantities-between-states)\nto transition to.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryScheduledChangeConnection", "description": "An auto-generated type for paginating through multiple InventoryScheduledChanges.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryScheduledChangeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in InventoryScheduledChangeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryScheduledChange", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventoryScheduledChangeEdge", "description": "An auto-generated type which holds one InventoryScheduledChange and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of InventoryScheduledChangeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryScheduledChange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryScheduledChangeInput", "description": "The input fields for a scheduled change of an inventory item.", "fields": null, "inputFields": [ { "name": "expectedAt", "description": "The date and time that the scheduled change is expected to happen.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "fromName", "description": "The state to transition from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "toName", "description": "The state to transition to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventoryScheduledChangeItemInput", "description": "The input fields for the inventory item associated with the scheduled changes that need to be applied.", "fields": null, "inputFields": [ { "name": "inventoryItemId", "description": "The ID of the inventory item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "ledgerDocumentUri", "description": "The ledger document URI which will be used to calculate the quantity transfered.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "scheduledChanges", "description": "An array of all the scheduled changes for the item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryScheduledChangeInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventorySetOnHandQuantitiesInput", "description": "The input fields required to set inventory on hand quantities.", "fields": null, "inputFields": [ { "name": "reason", "description": "The reason for the quantity changes. The value must be one of the [possible\nreasons](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#set-inventory-quantities-on-hand).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "referenceDocumentUri", "description": "The reference document URI for the changes. Used to denote what's causing the change.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "setQuantities", "description": "The value to which the on hand quantity will be set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventorySetQuantityInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventorySetOnHandQuantitiesPayload", "description": "Return type for `inventorySetOnHandQuantities` mutation.", "fields": [ { "name": "inventoryAdjustmentGroup", "description": "The group of changes made by the operation.", "args": [], "type": { "kind": "OBJECT", "name": "InventoryAdjustmentGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventorySetOnHandQuantitiesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventorySetOnHandQuantitiesUserError", "description": "An error that occurs during the execution of `InventorySetOnHandQuantities`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "InventorySetOnHandQuantitiesUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "InventorySetOnHandQuantitiesUserErrorCode", "description": "Possible error codes that can be returned by `InventorySetOnHandQuantitiesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID_INVENTORY_ITEM", "description": "The specified inventory item could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LOCATION", "description": "The specified location could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_NEGATIVE", "description": "The quantity can't be negative.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REASON", "description": "The specified reason is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REFERENCE_DOCUMENT", "description": "The specified reference document is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "SET_ON_HAND_QUANTITIES_FAILED", "description": "The on-hand quantities couldn't be set. Try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_NOT_STOCKED_AT_LOCATION", "description": "The inventory item is not stocked at the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_MUTABLE_INVENTORY_ITEM", "description": "The specified inventory item is not allowed to be adjusted via API.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY_TOO_HIGH", "description": "The total quantity can't be higher than 1,000,000,000.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventorySetQuantityInput", "description": "The input fields for the quantity to be set for an inventory item at a location.\n", "fields": null, "inputFields": [ { "name": "inventoryItemId", "description": "Specifies the inventory item to which the quantity will be set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "Specifies the location at which the quantity will be set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity to which the inventory quantity will be set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "InventorySetScheduledChangesInput", "description": "The input fields for setting up scheduled changes of inventory items.", "fields": null, "inputFields": [ { "name": "reason", "description": "The reason for setting up the scheduled changes.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "items", "description": "The list of all the items on which the scheduled changes need to be applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryScheduledChangeItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "referenceDocumentUri", "description": "The reference document URI to indicate how the scheduled changes are related for auditing purposes.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventorySetScheduledChangesPayload", "description": "Return type for `inventorySetScheduledChanges` mutation.", "fields": [ { "name": "scheduledChanges", "description": "The scheduled changes that were created.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryScheduledChange", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventorySetScheduledChangesUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InventorySetScheduledChangesUserError", "description": "An error that occurs during the execution of `InventorySetScheduledChanges`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "InventorySetScheduledChangesUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "InventorySetScheduledChangesUserErrorCode", "description": "Possible error codes that can be returned by `InventorySetScheduledChangesUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ERROR_UPDATING_SCHEDULED", "description": "There was an error updating the scheduled changes.", "isDeprecated": false, "deprecationReason": null }, { "name": "SAME_FROM_TO_NAMES", "description": "The from_name and to_name can't be the same.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_FROM_NAME", "description": "The specified fromName is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TO_NAME", "description": "The specified toName is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_TO_NAME", "description": "The item can only have one scheduled change for %{to_name} as the to_name.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REASON", "description": "The specified reason is invalid. Valid values: %{reasons}.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_FROM_NAME", "description": "The item can only have one scheduled change for %{from_name} as the fromName.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_NOT_FOUND", "description": "The location couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_STATE_NOT_FOUND", "description": "The inventory item was not found at the location specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEMS_EMPTY", "description": "At least 1 item must be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ITEM_NOT_FOUND", "description": "The inventory item was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The specified field is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "SCALAR", "name": "JSON", "description": "A [JSON](https://www.json.org/json-en.html) object.\n\nExample value:\n`{\n \"product\": {\n \"id\": \"gid://shopify/Product/1346443542550\",\n \"title\": \"White T-shirt\",\n \"options\": [{\n \"name\": \"Size\",\n \"values\": [\"M\", \"L\"]\n }]\n }\n}`\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Job", "description": "A job corresponds to some long running task that the client should poll for status.", "fields": [ { "name": "done", "description": "This indicates if the job is still queued or has been run.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID that's returned when running an asynchronous mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "query", "description": "This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job.", "args": [], "type": { "kind": "OBJECT", "name": "QueryRoot", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "JobResult", "description": "A job corresponds to some long running task that the client should poll for status.", "fields": [ { "name": "done", "description": "This indicates if the job is still queued or has been run.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID that's returned when running an asynchronous mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CustomerSegmentMembersQuery", "ofType": null } ] }, { "kind": "ENUM", "name": "LanguageCode", "description": "ISO 639-1 language codes supported by Shopify.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AF", "description": "Afrikaans.", "isDeprecated": false, "deprecationReason": null }, { "name": "AK", "description": "Akan.", "isDeprecated": false, "deprecationReason": null }, { "name": "AM", "description": "Amharic.", "isDeprecated": false, "deprecationReason": null }, { "name": "AR", "description": "Arabic.", "isDeprecated": false, "deprecationReason": null }, { "name": "AS", "description": "Assamese.", "isDeprecated": false, "deprecationReason": null }, { "name": "AZ", "description": "Azerbaijani.", "isDeprecated": false, "deprecationReason": null }, { "name": "BE", "description": "Belarusian.", "isDeprecated": false, "deprecationReason": null }, { "name": "BG", "description": "Bulgarian.", "isDeprecated": false, "deprecationReason": null }, { "name": "BM", "description": "Bambara.", "isDeprecated": false, "deprecationReason": null }, { "name": "BN", "description": "Bangla.", "isDeprecated": false, "deprecationReason": null }, { "name": "BO", "description": "Tibetan.", "isDeprecated": false, "deprecationReason": null }, { "name": "BR", "description": "Breton.", "isDeprecated": false, "deprecationReason": null }, { "name": "BS", "description": "Bosnian.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA", "description": "Catalan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CE", "description": "Chechen.", "isDeprecated": false, "deprecationReason": null }, { "name": "CS", "description": "Czech.", "isDeprecated": false, "deprecationReason": null }, { "name": "CY", "description": "Welsh.", "isDeprecated": false, "deprecationReason": null }, { "name": "DA", "description": "Danish.", "isDeprecated": false, "deprecationReason": null }, { "name": "DE", "description": "German.", "isDeprecated": false, "deprecationReason": null }, { "name": "DZ", "description": "Dzongkha.", "isDeprecated": false, "deprecationReason": null }, { "name": "EE", "description": "Ewe.", "isDeprecated": false, "deprecationReason": null }, { "name": "EL", "description": "Greek.", "isDeprecated": false, "deprecationReason": null }, { "name": "EN", "description": "English.", "isDeprecated": false, "deprecationReason": null }, { "name": "EO", "description": "Esperanto.", "isDeprecated": false, "deprecationReason": null }, { "name": "ES", "description": "Spanish.", "isDeprecated": false, "deprecationReason": null }, { "name": "ET", "description": "Estonian.", "isDeprecated": false, "deprecationReason": null }, { "name": "EU", "description": "Basque.", "isDeprecated": false, "deprecationReason": null }, { "name": "FA", "description": "Persian.", "isDeprecated": false, "deprecationReason": null }, { "name": "FF", "description": "Fulah.", "isDeprecated": false, "deprecationReason": null }, { "name": "FI", "description": "Finnish.", "isDeprecated": false, "deprecationReason": null }, { "name": "FO", "description": "Faroese.", "isDeprecated": false, "deprecationReason": null }, { "name": "FR", "description": "French.", "isDeprecated": false, "deprecationReason": null }, { "name": "FY", "description": "Western Frisian.", "isDeprecated": false, "deprecationReason": null }, { "name": "GA", "description": "Irish.", "isDeprecated": false, "deprecationReason": null }, { "name": "GD", "description": "Scottish Gaelic.", "isDeprecated": false, "deprecationReason": null }, { "name": "GL", "description": "Galician.", "isDeprecated": false, "deprecationReason": null }, { "name": "GU", "description": "Gujarati.", "isDeprecated": false, "deprecationReason": null }, { "name": "GV", "description": "Manx.", "isDeprecated": false, "deprecationReason": null }, { "name": "HA", "description": "Hausa.", "isDeprecated": false, "deprecationReason": null }, { "name": "HE", "description": "Hebrew.", "isDeprecated": false, "deprecationReason": null }, { "name": "HI", "description": "Hindi.", "isDeprecated": false, "deprecationReason": null }, { "name": "HR", "description": "Croatian.", "isDeprecated": false, "deprecationReason": null }, { "name": "HU", "description": "Hungarian.", "isDeprecated": false, "deprecationReason": null }, { "name": "HY", "description": "Armenian.", "isDeprecated": false, "deprecationReason": null }, { "name": "IA", "description": "Interlingua.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Indonesian.", "isDeprecated": false, "deprecationReason": null }, { "name": "IG", "description": "Igbo.", "isDeprecated": false, "deprecationReason": null }, { "name": "II", "description": "Sichuan Yi.", "isDeprecated": false, "deprecationReason": null }, { "name": "IS", "description": "Icelandic.", "isDeprecated": false, "deprecationReason": null }, { "name": "IT", "description": "Italian.", "isDeprecated": false, "deprecationReason": null }, { "name": "JA", "description": "Japanese.", "isDeprecated": false, "deprecationReason": null }, { "name": "JV", "description": "Javanese.", "isDeprecated": false, "deprecationReason": null }, { "name": "KA", "description": "Georgian.", "isDeprecated": false, "deprecationReason": null }, { "name": "KI", "description": "Kikuyu.", "isDeprecated": false, "deprecationReason": null }, { "name": "KK", "description": "Kazakh.", "isDeprecated": false, "deprecationReason": null }, { "name": "KL", "description": "Kalaallisut.", "isDeprecated": false, "deprecationReason": null }, { "name": "KM", "description": "Khmer.", "isDeprecated": false, "deprecationReason": null }, { "name": "KN", "description": "Kannada.", "isDeprecated": false, "deprecationReason": null }, { "name": "KO", "description": "Korean.", "isDeprecated": false, "deprecationReason": null }, { "name": "KS", "description": "Kashmiri.", "isDeprecated": false, "deprecationReason": null }, { "name": "KU", "description": "Kurdish.", "isDeprecated": false, "deprecationReason": null }, { "name": "KW", "description": "Cornish.", "isDeprecated": false, "deprecationReason": null }, { "name": "KY", "description": "Kyrgyz.", "isDeprecated": false, "deprecationReason": null }, { "name": "LB", "description": "Luxembourgish.", "isDeprecated": false, "deprecationReason": null }, { "name": "LG", "description": "Ganda.", "isDeprecated": false, "deprecationReason": null }, { "name": "LN", "description": "Lingala.", "isDeprecated": false, "deprecationReason": null }, { "name": "LO", "description": "Lao.", "isDeprecated": false, "deprecationReason": null }, { "name": "LT", "description": "Lithuanian.", "isDeprecated": false, "deprecationReason": null }, { "name": "LU", "description": "Luba-Katanga.", "isDeprecated": false, "deprecationReason": null }, { "name": "LV", "description": "Latvian.", "isDeprecated": false, "deprecationReason": null }, { "name": "MG", "description": "Malagasy.", "isDeprecated": false, "deprecationReason": null }, { "name": "MI", "description": "Māori.", "isDeprecated": false, "deprecationReason": null }, { "name": "MK", "description": "Macedonian.", "isDeprecated": false, "deprecationReason": null }, { "name": "ML", "description": "Malayalam.", "isDeprecated": false, "deprecationReason": null }, { "name": "MN", "description": "Mongolian.", "isDeprecated": false, "deprecationReason": null }, { "name": "MR", "description": "Marathi.", "isDeprecated": false, "deprecationReason": null }, { "name": "MS", "description": "Malay.", "isDeprecated": false, "deprecationReason": null }, { "name": "MT", "description": "Maltese.", "isDeprecated": false, "deprecationReason": null }, { "name": "MY", "description": "Burmese.", "isDeprecated": false, "deprecationReason": null }, { "name": "NB", "description": "Norwegian (Bokmål).", "isDeprecated": false, "deprecationReason": null }, { "name": "ND", "description": "North Ndebele.", "isDeprecated": false, "deprecationReason": null }, { "name": "NE", "description": "Nepali.", "isDeprecated": false, "deprecationReason": null }, { "name": "NL", "description": "Dutch.", "isDeprecated": false, "deprecationReason": null }, { "name": "NN", "description": "Norwegian Nynorsk.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO", "description": "Norwegian.", "isDeprecated": false, "deprecationReason": null }, { "name": "OM", "description": "Oromo.", "isDeprecated": false, "deprecationReason": null }, { "name": "OR", "description": "Odia.", "isDeprecated": false, "deprecationReason": null }, { "name": "OS", "description": "Ossetic.", "isDeprecated": false, "deprecationReason": null }, { "name": "PA", "description": "Punjabi.", "isDeprecated": false, "deprecationReason": null }, { "name": "PL", "description": "Polish.", "isDeprecated": false, "deprecationReason": null }, { "name": "PS", "description": "Pashto.", "isDeprecated": false, "deprecationReason": null }, { "name": "PT_BR", "description": "Portuguese (Brazil).", "isDeprecated": false, "deprecationReason": null }, { "name": "PT_PT", "description": "Portuguese (Portugal).", "isDeprecated": false, "deprecationReason": null }, { "name": "QU", "description": "Quechua.", "isDeprecated": false, "deprecationReason": null }, { "name": "RM", "description": "Romansh.", "isDeprecated": false, "deprecationReason": null }, { "name": "RN", "description": "Rundi.", "isDeprecated": false, "deprecationReason": null }, { "name": "RO", "description": "Romanian.", "isDeprecated": false, "deprecationReason": null }, { "name": "RU", "description": "Russian.", "isDeprecated": false, "deprecationReason": null }, { "name": "RW", "description": "Kinyarwanda.", "isDeprecated": false, "deprecationReason": null }, { "name": "SD", "description": "Sindhi.", "isDeprecated": false, "deprecationReason": null }, { "name": "SE", "description": "Northern Sami.", "isDeprecated": false, "deprecationReason": null }, { "name": "SG", "description": "Sango.", "isDeprecated": false, "deprecationReason": null }, { "name": "SI", "description": "Sinhala.", "isDeprecated": false, "deprecationReason": null }, { "name": "SK", "description": "Slovak.", "isDeprecated": false, "deprecationReason": null }, { "name": "SL", "description": "Slovenian.", "isDeprecated": false, "deprecationReason": null }, { "name": "SN", "description": "Shona.", "isDeprecated": false, "deprecationReason": null }, { "name": "SO", "description": "Somali.", "isDeprecated": false, "deprecationReason": null }, { "name": "SQ", "description": "Albanian.", "isDeprecated": false, "deprecationReason": null }, { "name": "SR", "description": "Serbian.", "isDeprecated": false, "deprecationReason": null }, { "name": "SU", "description": "Sundanese.", "isDeprecated": false, "deprecationReason": null }, { "name": "SV", "description": "Swedish.", "isDeprecated": false, "deprecationReason": null }, { "name": "SW", "description": "Swahili.", "isDeprecated": false, "deprecationReason": null }, { "name": "TA", "description": "Tamil.", "isDeprecated": false, "deprecationReason": null }, { "name": "TE", "description": "Telugu.", "isDeprecated": false, "deprecationReason": null }, { "name": "TG", "description": "Tajik.", "isDeprecated": false, "deprecationReason": null }, { "name": "TH", "description": "Thai.", "isDeprecated": false, "deprecationReason": null }, { "name": "TI", "description": "Tigrinya.", "isDeprecated": false, "deprecationReason": null }, { "name": "TK", "description": "Turkmen.", "isDeprecated": false, "deprecationReason": null }, { "name": "TO", "description": "Tongan.", "isDeprecated": false, "deprecationReason": null }, { "name": "TR", "description": "Turkish.", "isDeprecated": false, "deprecationReason": null }, { "name": "TT", "description": "Tatar.", "isDeprecated": false, "deprecationReason": null }, { "name": "UG", "description": "Uyghur.", "isDeprecated": false, "deprecationReason": null }, { "name": "UK", "description": "Ukrainian.", "isDeprecated": false, "deprecationReason": null }, { "name": "UR", "description": "Urdu.", "isDeprecated": false, "deprecationReason": null }, { "name": "UZ", "description": "Uzbek.", "isDeprecated": false, "deprecationReason": null }, { "name": "VI", "description": "Vietnamese.", "isDeprecated": false, "deprecationReason": null }, { "name": "WO", "description": "Wolof.", "isDeprecated": false, "deprecationReason": null }, { "name": "XH", "description": "Xhosa.", "isDeprecated": false, "deprecationReason": null }, { "name": "YI", "description": "Yiddish.", "isDeprecated": false, "deprecationReason": null }, { "name": "YO", "description": "Yoruba.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZH_CN", "description": "Chinese (Simplified).", "isDeprecated": false, "deprecationReason": null }, { "name": "ZH_TW", "description": "Chinese (Traditional).", "isDeprecated": false, "deprecationReason": null }, { "name": "ZU", "description": "Zulu.", "isDeprecated": false, "deprecationReason": null }, { "name": "ZH", "description": "Chinese.", "isDeprecated": false, "deprecationReason": null }, { "name": "PT", "description": "Portuguese.", "isDeprecated": false, "deprecationReason": null }, { "name": "CU", "description": "Church Slavic.", "isDeprecated": false, "deprecationReason": null }, { "name": "VO", "description": "Volapük.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "description": "Interoperability metadata for types that directly correspond to a REST Admin API resource.\nFor 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.\n", "fields": [ { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, { "kind": "OBJECT", "name": "Location", "ofType": null }, { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null }, { "kind": "OBJECT", "name": "Metafield", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "Refund", "ofType": null }, { "kind": "OBJECT", "name": "SavedSearch", "ofType": null }, { "kind": "OBJECT", "name": "ScriptTag", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayout", "ofType": null }, { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null } ] }, { "kind": "ENUM", "name": "LengthUnit", "description": "Units of measurement for length.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MILLIMETERS", "description": "1000 millimeters equals 1 meter.", "isDeprecated": false, "deprecationReason": null }, { "name": "CENTIMETERS", "description": "100 centimeters equals 1 meter.", "isDeprecated": false, "deprecationReason": null }, { "name": "METERS", "description": "Metric system unit of length.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCHES", "description": "12 inches equals 1 foot.", "isDeprecated": false, "deprecationReason": null }, { "name": "FEET", "description": "Imperial system unit of length.", "isDeprecated": false, "deprecationReason": null }, { "name": "YARDS", "description": "1 yard equals 3 feet.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LimitedPendingOrderCount", "description": "The total number of pending orders on a shop if less then a maximum, or that maximum.\nThe atMax field indicates when this maximum has been reached.\n", "fields": [ { "name": "atMax", "description": "This is set when the number of pending orders has reached the maximum.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "count", "description": "The number of pendings orders on the shop.\nLimited to a maximum of 10000.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItem", "description": "Represents individual products and quantities purchased in the associated order.", "fields": [ { "name": "canRestock", "description": "Whether the line item can be restocked.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `restockable` instead." }, { "name": "contract", "description": "The subscription contract associated with this line item.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentQuantity", "description": "The number of units ordered, excluding refunded and removed units.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotal", "description": "The total discounted price of the line item in shop currency, including refunded and removed quantities. This value doesn't include order-level discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedTotalSet` instead." }, { "name": "discountedTotalSet", "description": "The total discounted price of the line item in shop and presentment currencies, including refunded and removed quantities. This value doesn't include order-level discounts. Code-based discounts aren't included by default.", "args": [ { "name": "withCodeDiscounts", "description": "Whether to include code-based discounts in the total.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPrice", "description": "The approximate unit price of the line item in shop currency. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedUnitPriceSet` instead." }, { "name": "discountedUnitPriceAfterAllDiscountsSet", "description": "The approximate unit price of the line item in shop and presentment currencies. This value includes discounts applied to refunded and removed quantities.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPriceSet", "description": "The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "duties", "description": "The duties associated with the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Duty", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillableQuantity", "description": "The total number of units to fulfill.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead." }, { "name": "fulfillmentService", "description": "The fulfillment service that stocks the product variant belonging to a line item.\n\nThis is a third-party fulfillment service in the following scenarios:\n\n**Scenario 1**\n- The product variant is stocked by a single fulfillment service.\n- The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n\n**Scenario 2**\n- Multiple fulfillment services stock the product variant.\n- The last time that the line item was unfulfilled, it was awaiting fulfillment by a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n\nIf none of the above conditions are met, then the fulfillment service has the `manual` handle.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": true, "deprecationReason": "\nThe [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked.\n\nIf you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.\n\nAltering the locations which stock a product variant won't change the value of this field for existing orders.\n\nLearn about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states).\n" }, { "name": "fulfillmentStatus", "description": "The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,\n'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead" }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated to the line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the line item represents the purchase of a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItemGroup", "description": "The line item group associated to the line item.", "args": [], "type": { "kind": "OBJECT", "name": "LineItemGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantEditable", "description": "Whether the line item can be edited or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The title of the product, optionally appended with the title of the variant (if applicable).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nonFulfillableQuantity", "description": "The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotal", "description": "In shop currency, the total price of the line item when the order was created.\nThis value doesn't include discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalTotalSet` instead." }, { "name": "originalTotalSet", "description": "In shop and presentment currencies, the total price of the line item when the order was created.\nThis value doesn't include discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPrice", "description": "In shop currency, the unit price of the line item when the order was created. This value doesn't include discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalUnitPriceSet` instead." }, { "name": "originalUnitPriceSet", "description": "In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The Product object associated with this line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units ordered, including refunded and removed units.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundableQuantity", "description": "The number of units ordered, excluding refunded units.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockable", "description": "Whether the line item can be restocked.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlan", "description": "The selling plan details associated with the line item.", "args": [], "type": { "kind": "OBJECT", "name": "LineItemSellingPlan", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The variant SKU number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "Staff attributed to the line item.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The taxes charged for the line item, including taxes charged for refunded and removed quantities.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product at time of order creation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscount", "description": "The total discount allocated to the line item in shop currency, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalDiscountSet` instead." }, { "name": "totalDiscountSet", "description": "The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledDiscountedTotal", "description": "In shop currency, the total discounted price of the unfulfilled quantity for the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unfulfilledDiscountedTotalSet` instead." }, { "name": "unfulfilledDiscountedTotalSet", "description": "In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledOriginalTotal", "description": "In shop currency, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unfulfilledOriginalTotalSet` instead." }, { "name": "unfulfilledOriginalTotalSet", "description": "In shop and presentment currencies, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledQuantity", "description": "The number of units not yet fulfilled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The Variant object associated with this line item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The title of the variant at time of order creation.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who made the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemConnection", "description": "An auto-generated type for paginating through multiple LineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in LineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemEdge", "description": "An auto-generated type which holds one LineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of LineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemGroup", "description": "A line item group (bundle) to which a line item belongs to.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "Quantity of the line item group on the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Title of the line item group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantId", "description": "ID of the variant of the line item group.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantSku", "description": "SKU of the variant of the line item group.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemMutable", "description": "Represents a single line item on an order.", "fields": [ { "name": "canRestock", "description": "Whether the line item can be restocked.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `restockable` instead." }, { "name": "customAttributes", "description": "A list of attributes that represent custom features or special requests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "The discounts that have been allocated onto the line item by discount applications.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedTotal", "description": "The total line price after discounts are applied, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedTotalSet` instead." }, { "name": "discountedTotalSet", "description": "The total line price after discounts are applied, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedUnitPrice", "description": "The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedUnitPriceSet` instead." }, { "name": "discountedUnitPriceSet", "description": "The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillableQuantity", "description": "The total number of units to fulfill.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "The service provider that fulfills the line item.\n\nDeleted fulfillment services will return null.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentStatus", "description": "The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,\n'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image associated to the line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the line item represents the purchase of a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantEditable", "description": "Whether the line item can be edited or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nonFulfillableQuantity", "description": "The total number of units that can't be fulfilled. For example, if items have been refunded, or the item isn't something that can be fulfilled, like a tip.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotal", "description": "The total price without any discounts applied, in shop currency. \"\"This value is based on the unit price of the variant x quantity.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalTotalSet` instead." }, { "name": "originalTotalSet", "description": "The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalUnitPrice", "description": "The variant unit price without discounts applied, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalUnitPriceSet` instead." }, { "name": "originalUnitPriceSet", "description": "The variant unit price without discounts applied, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The Product object associated with this line item's variant.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of variant units ordered.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundableQuantity", "description": "The line item's quantity, minus the refunded quantity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockable", "description": "Whether the line item can be restocked.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The variant SKU number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "Staff attributed to the line item.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The TaxLine object connected to this line item.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscount", "description": "The total amount of the discount allocated to the line item in the shop currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalDiscountSet` instead." }, { "name": "totalDiscountSet", "description": "The total amount of the discount allocated to the line item in the presentment currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledDiscountedTotal", "description": "The total discounted value of unfulfilled units, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unfulfilledDiscountedTotalSet` instead." }, { "name": "unfulfilledDiscountedTotalSet", "description": "The total discounted value of unfulfilled units, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledOriginalTotal", "description": "The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unfulfilledOriginalTotalSet` instead." }, { "name": "unfulfilledOriginalTotalSet", "description": "The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unfulfilledQuantity", "description": "The number of units not yet fulfilled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The Variant object associated with this line item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "The name of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the vendor who made the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemMutableConnection", "description": "An auto-generated type for paginating through multiple LineItemMutables.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemMutableEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in LineItemMutableEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemMutable", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemMutableEdge", "description": "An auto-generated type which holds one LineItemMutable and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of LineItemMutableEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemMutable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LineItemSellingPlan", "description": "Represents the selling plan for a line item.", "fields": [ { "name": "name", "description": "The name of the selling plan for display purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanId", "description": "The ID of the selling plan associated with the line item.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Link", "description": "A link to direct users to.", "fields": [ { "name": "label", "description": "A context-sensitive label for the link.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL that the link visits.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LinkedMetafield", "description": "The identifier for the metafield linked to this option.\n\nThis API is currently in early access. See [Metafield-linked product options](https://shopify.dev/docs/api/admin/migrate/new-product-model/metafield-linked) for more details.\n", "fields": [ { "name": "key", "description": "Key of the metafield the option is linked to.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "Namespace of the metafield the option is linked to.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LinkedMetafieldCreateInput", "description": "The input fields required to link a product option to a metafield.\n\nThis API is currently in early access. See [Metafield-linked product options](https://shopify.dev/docs/api/admin/migrate/new-product-model/metafield-linked) for more details.\n", "fields": null, "inputFields": [ { "name": "namespace", "description": "The namespace of the metafield this option is linked to.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key of the metafield this option is linked to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "values", "description": "Values associated with the option.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LinkedMetafieldUpdateInput", "description": "The input fields required to link a product option to a metafield.\n\nThis API is currently in early access. See [Metafield-linked product options](https://shopify.dev/docs/api/admin/migrate/new-product-model/metafield-linked) for more details.\n", "fields": null, "inputFields": [ { "name": "namespace", "description": "The namespace of the metafield this option is linked to.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key of the metafield this option is linked to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Locale", "description": "A locale.", "fields": [ { "name": "isoCode", "description": "Locale ISO code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "Human-readable locale name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocalizableContentType", "description": "Specifies the type of the underlying localizable content. This can be used to conditionally render different UI elements such as input fields.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "JSON_STRING", "description": "A JSON string.", "isDeprecated": false, "deprecationReason": null }, { "name": "JSON", "description": "A JSON.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST_MULTI_LINE_TEXT_FIELD", "description": "A list of multi-line texts.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST_SINGLE_LINE_TEXT_FIELD", "description": "A list of single-line texts.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST_URL", "description": "A list of URLs.", "isDeprecated": false, "deprecationReason": null }, { "name": "MULTI_LINE_TEXT_FIELD", "description": "A multi-line text.", "isDeprecated": false, "deprecationReason": null }, { "name": "RICH_TEXT_FIELD", "description": "A rich text.", "isDeprecated": false, "deprecationReason": null }, { "name": "SINGLE_LINE_TEXT_FIELD", "description": "A single-line text.", "isDeprecated": false, "deprecationReason": null }, { "name": "STRING", "description": "A string.", "isDeprecated": false, "deprecationReason": null }, { "name": "URL", "description": "A URL.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE_REFERENCE", "description": "A file reference.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST_FILE_REFERENCE", "description": "A list of file references.", "isDeprecated": false, "deprecationReason": null }, { "name": "HTML", "description": "An HTML.", "isDeprecated": false, "deprecationReason": null }, { "name": "URI", "description": "A URI.", "isDeprecated": false, "deprecationReason": null }, { "name": "INLINE_RICH_TEXT", "description": "An inline rich text.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocalizationExtension", "description": "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.", "fields": [ { "name": "countryCode", "description": "Country ISO 3166-1 alpha-2 code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The localized extension keys that are allowed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionKey", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "purpose", "description": "The purpose of this localization extension.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionPurpose", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The localized extension title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the field.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocalizationExtensionConnection", "description": "An auto-generated type for paginating through multiple LocalizationExtensions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtensionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in LocalizationExtensionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtension", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocalizationExtensionEdge", "description": "An auto-generated type which holds one LocalizationExtension and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of LocalizationExtensionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtension", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LocalizationExtensionInput", "description": "The input fields for a LocalizationExtensionInput.\n", "fields": null, "inputFields": [ { "name": "key", "description": "The key for the localization extension.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionKey", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The localization extension value.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocalizationExtensionKey", "description": "The key of a localization extension.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TAX_CREDENTIAL_BR", "description": "Extension key 'tax_credential_br' for country BR.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_CREDENTIAL_BR", "description": "Extension key 'shipping_credential_br' for country BR.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_CREDENTIAL_CN", "description": "Extension key 'shipping_credential_cn' for country CN.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_CREDENTIAL_IT", "description": "Extension key 'tax_credential_it' for country IT.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_EMAIL_IT", "description": "Extension key 'tax_email_it' for country IT.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_CREDENTIAL_KR", "description": "Extension key 'shipping_credential_kr' for country KR.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "LocalizationExtensionPurpose", "description": "The purpose of a localization extension.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHIPPING", "description": "Extensions that are used for shipping purposes, for example, customs clearance.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX", "description": "Extensions that are used for taxes purposes, for example, invoicing.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Location", "description": "Represents the location where the physical good resides.\n", "fields": [ { "name": "activatable", "description": "Whether this location can be reactivated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "address", "description": "The address of this location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "addressVerified", "description": "Whether the location address has been verified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was added to a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deactivatable", "description": "Whether this location can be deactivated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deactivatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `\"2019-09-07T15:50:00Z`\".", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deletable", "description": "Whether this location can be deleted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "Name of the service provider that fulfills from this location.", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillsOnlineOrders", "description": "Whether this location can fulfill online orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasActiveInventory", "description": "Whether this location has active inventory.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasUnfulfilledOrders", "description": "Whether this location has orders that need to be fulfilled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevel", "description": "The quantities of an inventory item at this location.", "args": [ { "name": "inventoryItemId", "description": "The ID of the inventory item to obtain the inventory level for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevels", "description": "A list of the quantities of the inventory items that can be stocked at this location.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| inventory_group_id |\n| inventory_item_id |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryLevelConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isActive", "description": "Whether the location is active.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isFulfillmentService", "description": "Whether this location is a fulfillment service.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPrimary", "description": "Whether the location is your primary location for shipping inventory.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location" }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localPickupSettingsV2", "description": "Local pickup settings for the location.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryLocalPickupSettings", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "shipsInventory", "description": "Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suggestedAddresses", "description": "List of suggested addresses for this location (empty if none).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationSuggestedAddress", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the location was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationActivatePayload", "description": "Return type for `locationActivate` mutation.", "fields": [ { "name": "location", "description": "The location that was activated.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationActivateUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationActivateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationActivateUserError", "description": "An error that occurs while activating a location.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "LocationActivateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationActivateUserErrorCode", "description": "Possible error codes that can be returned by `LocationActivateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "GENERIC_ERROR", "description": "An error occurred while activating the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_LIMIT", "description": "Shop has reached its location limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_ONGOING_RELOCATION", "description": "This location currently cannot be activated as inventory, pending orders or transfers are being relocated from this location.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_NOT_FOUND", "description": "Location not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_NON_UNIQUE_NAME", "description": "There is already an active location with this name.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LocationAddAddressInput", "description": "The input fields to use to specify the address while adding a location.", "fields": null, "inputFields": [ { "name": "address1", "description": "The first line of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address2", "description": "The second line of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number of the location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zip", "description": "The ZIP code or postal code of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryCode", "description": "The two-letter code of country for the address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "defaultValue": null }, { "name": "provinceCode", "description": "The code for the region of the address, such as the state, province, or district.\nFor example CA for California, United States.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LocationAddInput", "description": "The input fields to use to add a location.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "address", "description": "The address of the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "LocationAddAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "fulfillsOnlineOrders", "description": "Whether inventory at this location is available for sale online.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "metafields", "description": "Additional customizable information to associate with the location.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationAddPayload", "description": "Return type for `locationAdd` mutation.", "fields": [ { "name": "location", "description": "The location that was added.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationAddUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationAddUserError", "description": "An error that occurs while adding a location.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "LocationAddUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationAddUserErrorCode", "description": "Possible error codes that can be returned by `LocationAddUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_US_ZIPCODE", "description": "The ZIP code is not a valid US ZIP code.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "An error occurred while adding the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TYPE", "description": "The type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE", "description": "The value is invalid for the metafield type or for the definition options.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_NOT_AUTHORIZED", "description": "ApiPermission metafields can only be created or updated by the app owner.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSTRUCTURED_RESERVED_NAMESPACE", "description": "Unstructured reserved namespace.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_VIOLATION", "description": "The metafield violates a capability restriction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationAddress", "description": "Represents the address of a location.\n", "fields": [ { "name": "address1", "description": "The first line of the address for the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address for the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The country of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The country code of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "formatted", "description": "A formatted version of the address for the location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "latitude", "description": "The approximate latitude coordinates of the location.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "longitude", "description": "The approximate longitude coordinates of the location.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The province of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The code for the province, state, or district of the address of the location.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The ZIP code of the location.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationConnection", "description": "An auto-generated type for paginating through multiple Locations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in LocationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationDeactivatePayload", "description": "Return type for `locationDeactivate` mutation.", "fields": [ { "name": "location", "description": "The location that was deactivated.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationDeactivateUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationDeactivateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationDeactivateUserError", "description": "The possible errors that can be returned when executing the `locationDeactivate` mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "LocationDeactivateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationDeactivateUserErrorCode", "description": "Possible error codes that can be returned by `LocationDeactivateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LOCATION_NOT_FOUND", "description": "Location not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PERMANENTLY_BLOCKED_FROM_DEACTIVATION_ERROR", "description": "Location either has a fulfillment service or is the only location with a shipping address.", "isDeprecated": false, "deprecationReason": null }, { "name": "TEMPORARILY_BLOCKED_FROM_DEACTIVATION_ERROR", "description": "Location has incoming inventory. The location can be deactivated after the inventory has been received.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_ACTIVE_RETAIL_SUBSCRIPTIONS", "description": "Location needs to be removed from Shopify POS for Retail subscription in Point of Sale channel.", "isDeprecated": false, "deprecationReason": null }, { "name": "DESTINATION_LOCATION_IS_THE_SAME_LOCATION", "description": "Destination location is the same as the location to be deactivated.", "isDeprecated": false, "deprecationReason": null }, { "name": "DESTINATION_LOCATION_NOT_FOUND_OR_INACTIVE", "description": "Destination location is not found or inactive.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_ACTIVE_INVENTORY_ERROR", "description": "Location could not be deactivated without specifying where to relocate inventory at the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_FULFILLMENT_ORDERS_ERROR", "description": "Location could not be deactivated because it has pending orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_OPEN_TRANSFERS_ERROR", "description": "Location could not be deactivated because it has open transfers.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_INCOMING_MOVEMENTS_ERROR", "description": "Location could not be deactivated because it has open Shopify Fulfillment Network transfers.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_OPEN_PURCHASE_ORDERS_ERROR", "description": "Location could not be deactivated because it has open purchase orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_RELOCATE_ACTIVE_INVENTORIES", "description": "Failed to relocate active inventories to the destination location.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_RELOCATE_OPEN_TRANSFERS", "description": "Failed to relocate open transfers to the destination location.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_RELOCATE_OPEN_PURCHASE_ORDERS", "description": "Failed to relocate open purchase orders to the destination location.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_RELOCATE_INCOMING_MOVEMENTS", "description": "Failed to relocate incoming movements to the destination location.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT", "description": "At least one location must fulfill online orders.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationDeletePayload", "description": "Return type for `locationDelete` mutation.", "fields": [ { "name": "deletedLocationId", "description": "The ID of the location that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationDeleteUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationDeleteUserError", "description": "An error that occurs while deleting a location.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "LocationDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationDeleteUserErrorCode", "description": "Possible error codes that can be returned by `LocationDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LOCATION_NOT_FOUND", "description": "Location not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_IS_ACTIVE", "description": "The location cannot be deleted while it is active.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "An error occurred while deleting the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_HAS_INVENTORY", "description": "The location cannot be deleted while it has inventory.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_HAS_PENDING_ORDERS", "description": "The location cannot be deleted while it has pending orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION_HAS_ACTIVE_RETAIL_SUBSCRIPTION", "description": "The location cannot be deleted while it has any active Retail subscriptions in the Point of Sale channel.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationEdge", "description": "An auto-generated type which holds one Location and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of LocationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LocationEditAddressInput", "description": "The input fields to use to edit the address of a location.", "fields": null, "inputFields": [ { "name": "address1", "description": "The first line of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address2", "description": "The second line of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number of the location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zip", "description": "The ZIP code or postal code of the location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryCode", "description": "The two-letter code of country for the address.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "provinceCode", "description": "The code for the region of the address, such as the state, province, or district.\nFor example CA for California, United States.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "LocationEditInput", "description": "The input fields to use to edit a location.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address", "description": "The address of the location.", "type": { "kind": "INPUT_OBJECT", "name": "LocationEditAddressInput", "ofType": null }, "defaultValue": null }, { "name": "fulfillsOnlineOrders", "description": "Whether inventory at this location is available for sale online.\n\n**Note:** This can't be disabled for fulfillment service locations.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional customizable information to associate with the location.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationEditPayload", "description": "Return type for `locationEdit` mutation.", "fields": [ { "name": "location", "description": "The location that was edited.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationEditUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationEditUserError", "description": "An error that occurs while editing a location.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "LocationEditUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationEditUserErrorCode", "description": "Possible error codes that can be returned by `LocationEditUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The record with the ID used as the input value couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_US_ZIPCODE", "description": "The ZIP code is not a valid US ZIP code.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "An error occurred while editing the location.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT", "description": "At least one location must fulfill online orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_ONLINE_ORDER_FULFILLMENT_FOR_FS_LOCATION", "description": "Cannot modify the online order fulfillment preference for fulfillment service locations.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TYPE", "description": "The type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE", "description": "The value is invalid for the metafield type or for the definition options.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_NOT_AUTHORIZED", "description": "ApiPermission metafields can only be created or updated by the app owner.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSTRUCTURED_RESERVED_NAMESPACE", "description": "Unstructured reserved namespace.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_VIOLATION", "description": "The metafield violates a capability restriction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationLocalPickupDisablePayload", "description": "Return type for `locationLocalPickupDisable` mutation.", "fields": [ { "name": "locationId", "description": "The ID of the location for which local pickup was disabled.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationLocalPickupSettingsError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationLocalPickupEnablePayload", "description": "Return type for `locationLocalPickupEnable` mutation.", "fields": [ { "name": "localPickupSettings", "description": "The local pickup settings that were enabled.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryLocalPickupSettings", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryLocationLocalPickupSettingsError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "LocationSortKeys", "description": "The set of valid sort keys for the Location query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "LocationSuggestedAddress", "description": "Represents a suggested address for a location.\n", "fields": [ { "name": "address1", "description": "The first line of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The city of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The country of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The country code of the suggested address.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "formatted", "description": "A formatted version of the suggested address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The province of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The code for the province, state, or district of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The ZIP code of the suggested address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MailingAddress", "description": "Represents a customer mailing address.\n\nFor example, a customer's default address and an order's billing address are both mailling addresses.\n", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The name of the customer's company or organization.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "coordinatesValidated", "description": "Whether the address coordinates are valid.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `countryCodeV2` instead." }, { "name": "countryCodeV2", "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name of the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "formatted", "description": "A formatted version of the address, customized by the provided arguments.", "args": [ { "name": "withName", "description": "Whether to include the customer's name in the formatted address.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "withCompany", "description": "Whether to include the customer's company in the formatted address.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedArea", "description": "A comma-separated list of the values for city, province, and country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name of the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "latitude", "description": "The latitude coordinate of the customer address.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "longitude", "description": "The longitude coordinate of the customer address.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The full name of the customer, based on firstName and lastName.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The two-letter code for the region.\n\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "timeZone", "description": "The time zone of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MailingAddressConnection", "description": "An auto-generated type for paginating through multiple MailingAddresses.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MailingAddressEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MailingAddressEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MailingAddressEdge", "description": "An auto-generated type which holds one MailingAddress and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MailingAddressEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "description": "The input fields to create or update a mailing address.", "fields": null, "inputFields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "city", "description": "The name of the city, district, village, or town.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "company", "description": "The name of the customer's company or organization.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.", "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "defaultValue": null }, { "name": "firstName", "description": "The first name of the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lastName", "description": "The last name of the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "provinceCode", "description": "The code for the region of the address, such as the province, state, or district.\nFor example QC for Quebec, Canada.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "zip", "description": "The zip or postal code of the address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ManualDiscountApplication", "description": "Manual discount applications capture the intentions of a discount that was manually created for an order.\n\nDiscount 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.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the discount application.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "index", "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Market", "description": "A market is a group of one or more regions that you want to target for international sales.\nBy creating a market, you can configure a distinct, localized shopping experience for\ncustomers from a specific area of the world. For example, you can\n[change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate),\n[configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists),\nor [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence).\n", "fields": [ { "name": "catalogs", "description": "The catalogs that belong to the market.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCatalogConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogsCount", "description": "The number of catalogs that belong to the market.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencySettings", "description": "The market’s currency settings.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCurrencySettings", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Whether the market is enabled to receive visitors and sales. **Note**: Regions in inactive\nmarkets can't be selected on the storefront or in checkout.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "A short, human-readable unique identifier for the market. This is changeable by the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the market. Not shown to customers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The market’s price list, which specifies a percentage-based price adjustment as well as\nfixed price overrides for specific variants.\n\nMarkets with multiple catalogs can have multiple price lists. To query which price lists are connected to\na market, please query for price lists through the catalogs connection.\n", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `catalogs` instead." }, { "name": "primary", "description": "Whether the market is the shop’s primary market.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "regions", "description": "The regions that comprise the market.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketRegionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPresence", "description": "The market’s web presence, which defines its SEO strategy. This can be a different domain,\nsubdomain, or subfolders of the primary domain. Each web presence comprises one or more\nlanguage variants. If a market doesn't have its own web presence, then the market is accessible on the\nprimary market's domains using [country\nselectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).\nIf it's the primary market and it has multiple web presences, then this field will return the primary domain web presence.\n", "args": [], "type": { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPresences", "description": "The market’s web presences, which defines its SEO strategy. This can be a different domain,\nsubdomain, or subfolders of the primary domain. Each web presence comprises one or more\nlanguage variants. If a market doesn't have any web presences, then the market is accessible on the\nprimary market's domains using [country\nselectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresenceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCatalog", "description": "A list of products with publishing and pricing information associated with markets.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "markets", "description": "The markets associated with the catalog.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "operations", "description": "Most recent catalog operations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list associated with the catalog.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "A group of products and collections that's published to a catalog.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CatalogStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the catalog.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCatalogConnection", "description": "An auto-generated type for paginating through multiple MarketCatalogs.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCatalogEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketCatalogEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCatalog", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCatalogEdge", "description": "An auto-generated type which holds one MarketCatalog and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketCatalogEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCatalog", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketConnection", "description": "An auto-generated type for paginating through multiple Markets.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketCreateInput", "description": "The input fields required to create a market.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the market. Not shown to customers.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "handle", "description": "A unique identifier for the market. For example `\"ca\"`.\nIf the handle isn't provided, then the handle is auto-generated based on the country or name.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "enabled", "description": "Whether the market is enabled to receive visitors and sales. If a\nvalue isn't provided, then the market is enabled by default if all\nincluded regions have shipping rates, and disabled if any regions don't\nhave shipping rates.\n\n**Note**: Regions in inactive markets can't be selected on the\nstorefront or in checkout.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "regions", "description": "The regions to be included in the market. Each region can only be included in one market at\na time.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketRegionCreateInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCreatePayload", "description": "Return type for `marketCreate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCurrencySettings", "description": "A market's currency settings.", "fields": [ { "name": "baseCurrency", "description": "The currency which this market's prices are defined in, and the\ncurrency which its customers must use if local currencies are disabled.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySetting", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localCurrencies", "description": "Whether or not local currencies are enabled. If enabled, then prices will\nbe converted to give each customer the best experience based on their\nregion. If disabled, then all customers in this market will see prices\nin the market's base currency. For single country markets this will be true when\nthe market's base currency is the same as the default currency for the region.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketCurrencySettingsUpdateInput", "description": "The input fields used to update the currency settings of a market.", "fields": null, "inputFields": [ { "name": "baseCurrency", "description": "The currency which this market’s prices are defined in, and the\ncurrency which its customers must use if local currencies are disabled.\n", "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "defaultValue": null }, { "name": "localCurrencies", "description": "Whether or not local currencies are enabled. If enabled, then prices will\nbe converted to give each customer the best experience based on their\nregion. If disabled, then all customers in this market will see prices\nin the market's base currency.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCurrencySettingsUpdatePayload", "description": "Return type for `marketCurrencySettingsUpdate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketCurrencySettingsUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketCurrencySettingsUserError", "description": "Error codes for failed market multi-currency operations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MarketCurrencySettingsUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketCurrencySettingsUserErrorCode", "description": "Possible error codes that can be returned by `MarketCurrencySettingsUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MARKET_NOT_FOUND", "description": "The specified market wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "MANAGED_MARKET", "description": "The currency settings of the given market cannot be changed because the market manager has exclusive control of pricing.", "isDeprecated": false, "deprecationReason": null }, { "name": "MULTIPLE_CURRENCIES_NOT_SUPPORTED", "description": "The shop's payment gateway does not support enabling more than one currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_LOCAL_CURRENCIES_ON_SINGLE_COUNTRY_MARKET", "description": "Can't enable or disable local currencies on a single country market.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_CURRENCY", "description": "The specified currency is not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRIMARY_MARKET_USES_SHOP_CURRENCY", "description": "The primary market must use the shop currency.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketDeletePayload", "description": "Return type for `marketDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted market.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketEdge", "description": "An auto-generated type which holds one Market and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizableContent", "description": "The market localizable content of a resource's field.", "fields": [ { "name": "digest", "description": "The hash digest representation of the content value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The resource field that's being localized.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The content value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizableResource", "description": "A resource that has market localizable fields.", "fields": [ { "name": "marketLocalizableContent", "description": "The market localizable content.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableContent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizations", "description": "Market localizations for the market localizable content.", "args": [ { "name": "marketId", "description": "Filters market localizations by market ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalization", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourceId", "description": "The GID of the resource.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizableResourceConnection", "description": "An auto-generated type for paginating through multiple MarketLocalizableResources.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableResourceEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketLocalizableResourceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableResource", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizableResourceEdge", "description": "An auto-generated type which holds one MarketLocalizableResource and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketLocalizableResourceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableResource", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketLocalizableResourceType", "description": "The type of resources that are market localizable.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "METAFIELD", "description": "A metafield. Market localizable fields: `value`.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECT", "description": "A Metaobject. Market Localizable fields are determined by the Metaobject type.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalization", "description": "The market localization of a field within a resource, which is determined by the market ID.", "fields": [ { "name": "key", "description": "A reference to the value being localized on the resource that this market localization belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The market that the localization is specific to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "outdated", "description": "Whether the original content has changed since this market localization was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the market localization was updated.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the market localization.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketLocalizationRegisterInput", "description": "The input fields and values for creating or updating a market localization.", "fields": null, "inputFields": [ { "name": "marketId", "description": "The ID of the market that the localization is specific to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "A reference to the value being localized on the resource that this market localization belongs to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The value of the market localization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketLocalizableContentDigest", "description": "A hash digest representation of the content being localized.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizationsRegisterPayload", "description": "Return type for `marketLocalizationsRegister` mutation.", "fields": [ { "name": "marketLocalizations", "description": "The market localizations that were created or updated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalization", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketLocalizationsRemovePayload", "description": "Return type for `marketLocalizationsRemove` mutation.", "fields": [ { "name": "marketLocalizations", "description": "The market localizations that were deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalization", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "MarketRegion", "description": "A geographic region which comprises a market.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the region.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "MarketRegionCountry", "ofType": null } ] }, { "kind": "OBJECT", "name": "MarketRegionConnection", "description": "An auto-generated type for paginating through multiple MarketRegions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketRegionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketRegionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "MarketRegion", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketRegionCountry", "description": "A country which comprises a market.", "fields": [ { "name": "code", "description": "The ISO code identifying the country.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currency", "description": "The currency which this country uses given its market settings.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySetting", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the region.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "MarketRegion", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketRegionCreateInput", "description": "The input fields for creating a market region with exactly one required option.", "fields": null, "inputFields": [ { "name": "countryCode", "description": "A country code for the region.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketRegionDeletePayload", "description": "Return type for `marketRegionDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted market region.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The parent market object of the deleted region.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketRegionEdge", "description": "An auto-generated type which holds one MarketRegion and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketRegionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "MarketRegion", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketRegionsCreatePayload", "description": "Return type for `marketRegionsCreate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketRegionsDeletePayload", "description": "Return type for `marketRegionsDelete` mutation.", "fields": [ { "name": "deletedIds", "description": "The ID of the deleted market region.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketUpdateInput", "description": "The input fields used to update a market.", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the market. Not shown to customers.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "handle", "description": "A unique identifier for the market. For example `\"ca\"`.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "enabled", "description": "Whether the market is enabled to receive visitors and sales. **Note**: Regions in\ninactive markets cannot be selected on the storefront or in checkout.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketUpdatePayload", "description": "Return type for `marketUpdate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketUserError", "description": "Defines errors encountered while managing a Market.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MarketUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketUserErrorCode", "description": "Possible error codes that can be returned by `MarketUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_NOT_FOUND", "description": "The market wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "REGION_NOT_FOUND", "description": "The market region wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "WEB_PRESENCE_NOT_FOUND", "description": "The market web presence wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_ADD_REGIONS_TO_PRIMARY_MARKET", "description": "Can't add regions to the primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_ONLY_REGION", "description": "Can't delete the only region in a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRES_EXACTLY_ONE_OPTION", "description": "Exactly one input option is required.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_PRIMARY_MARKET", "description": "Can't delete the primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOMAIN_NOT_FOUND", "description": "Domain was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBFOLDER_SUFFIX_MUST_CONTAIN_ONLY_LETTERS", "description": "The subfolder suffix must contain only letters.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBFOLDER_SUFFIX_CANNOT_BE_SCRIPT_CODE", "description": "The subfolder suffix is invalid, please provide a different value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_LANGUAGES", "description": "No languages selected.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_LANGUAGES", "description": "Duplicates found in languages.", "isDeprecated": false, "deprecationReason": null }, { "name": "REGION_SPECIFIC_LANGUAGE", "description": "Cannot add region-specific language.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_HAVE_SUBFOLDER_AND_DOMAIN", "description": "Can't pass both `subfolderSuffix` and `domainId`.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_ADD_WEB_PRESENCE_TO_PRIMARY_MARKET", "description": "Can't add the web presence to the primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_REACHED_WEB_PRESENCE_LIMIT", "description": "Can't add another web presence to the market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_HAVE_MULTIPLE_SUBFOLDERS_PER_MARKET", "description": "Can't have multiple subfolder web presences per market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_HAVE_BOTH_SUBFOLDER_AND_DOMAIN_WEB_PRESENCES", "description": "Can't have both subfolder and domain web presences.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRES_DOMAIN_OR_SUBFOLDER", "description": "One of `subfolderSuffix` or `domainId` is required.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRIMARY_MARKET_MUST_USE_PRIMARY_DOMAIN", "description": "The primary market must use the primary domain.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_PRIMARY_MARKET_WEB_PRESENCE", "description": "Can't delete the primary market's web presence.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_REACHED_MARKETS_LIMIT", "description": "Can't have more than 50 markets.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DISABLE_PRIMARY_MARKET", "description": "Can't disable the primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNPUBLISHED_LANGUAGE", "description": "The language isn't published to the store.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISABLED_LANGUAGE", "description": "The language isn't enabled on the store.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_SET_DEFAULT_LOCALE_TO_NULL", "description": "Can't set default locale to null.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_COUNTRY_REGION", "description": "Can't add unsupported country or region.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_ADD_CUSTOMER_DOMAIN", "description": "Can't add customer account domain to a market.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresence", "description": "The market’s web presence, which defines its SEO strategy. This can be a different domain\n(e.g. `example.ca`), subdomain (e.g. `ca.example.com`), or subfolders of the primary\ndomain (e.g. `example.com/en-ca`). Each web presence comprises one or more language\nvariants. If a market does not have its own web presence, it is accessible on the shop’s\nprimary domain via [country\nselectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).\n\nNote: while the domain/subfolders defined by a market’s web presence are not applicable to\ncustom storefronts, which must manage their own domains and routing, the languages chosen\nhere do govern [the languages available on the Storefront\nAPI](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in\nthis market.\n", "fields": [ { "name": "alternateLocales", "description": "The ShopLocale object for the alternate locales. When a domain is used, these locales will be\navailable as language-specific subfolders. For example, if English is an\nalternate locale, and `example.ca` is the market’s domain, then\n`example.ca/en` will load in English.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopLocale", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultLocale", "description": "The ShopLocale object for the default locale. When a domain is used, this is the locale that will\nbe used when the domain root is accessed. For example, if French is the default locale,\nand `example.ca` is the market’s domain, then `example.ca` will load in French.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopLocale", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "domain", "description": "The web presence’s domain.\nThis field will be null if `subfolderSuffix` isn't null.\n", "args": [], "type": { "kind": "OBJECT", "name": "Domain", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The associated market.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rootUrls", "description": "The list of root URLs for each of the web presence’s locales. As of version `2024-04` this value will no longer have a trailing slash.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresenceRootUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subfolderSuffix", "description": "The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceConnection", "description": "An auto-generated type for paginating through multiple MarketWebPresences.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresenceEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketWebPresenceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketWebPresenceCreateInput", "description": "The input fields used to create a web presence for a market.", "fields": null, "inputFields": [ { "name": "domainId", "description": "The web presence's domain ID. This field must be `null` if the `subfolderSuffix` isn't `null`.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "defaultLocale", "description": "The default locale for the market’s web presence.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "alternateLocales", "description": "The alternate locales for the market’s web presence.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "subfolderSuffix", "description": "The market-specific suffix of the subfolders defined by the web presence.\nFor example: in `/en-us`, the subfolder suffix is `us`.\nOnly ASCII characters are allowed. This field must be `null` if the `domainId` isn't `null`.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceCreatePayload", "description": "Return type for `marketWebPresenceCreate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceDeletePayload", "description": "Return type for `marketWebPresenceDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted web presence.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The market for which the web presence was deleted.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceEdge", "description": "An auto-generated type which holds one MarketWebPresence and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketWebPresenceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceRootUrl", "description": "The URL for the homepage of the online store in the context of a particular market and a\nparticular locale.\n", "fields": [ { "name": "locale", "description": "The locale that the storefront loads in.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketWebPresenceUpdateInput", "description": "The input fields used to update a web presence for a market.", "fields": null, "inputFields": [ { "name": "domainId", "description": "The web presence's domain ID. This field must be null if `subfolderSuffix` is not null.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "defaultLocale", "description": "The default locale for the market’s web presence.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "alternateLocales", "description": "The alternate locales for the market’s web presence.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "subfolderSuffix", "description": "The market-specific suffix of the subfolders defined by the web presence.\nExample: in `/en-us` the subfolder suffix is `us`.\nOnly ASCII characters are allowed. This field must be null if `domainId` is not null.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketWebPresenceUpdatePayload", "description": "Return type for `marketWebPresenceUpdate` mutation.", "fields": [ { "name": "market", "description": "The market object.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivitiesDeleteAllExternalPayload", "description": "Return type for `marketingActivitiesDeleteAllExternal` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that performs the deletion. The status of the job may be used to determine when it's safe again to create new activities.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivity", "description": "The marketing activity resource represents marketing that a\n merchant created through an app.", "fields": [ { "name": "activityListUrl", "description": "The URL of the marketing activity listing page in the marketing section.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "adSpend", "description": "The amount spent on the marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "The app which created this marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appErrors", "description": "The errors generated when an app publishes the marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivityExtensionAppErrors", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "budget", "description": "The allocated budget for the marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingBudget", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the marketing activity was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formData", "description": "The completed content in the marketing activity creation form.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hierarchyLevel", "description": "The hierarchy level of the marketing activity.", "args": [], "type": { "kind": "ENUM", "name": "MarketingActivityHierarchyLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inMainWorkflowVersion", "description": "Whether the marketing activity is in the main workflow version of the marketing automation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isExternal", "description": "The marketing activity represents an external marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingChannel", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `marketingChannelType` instead." }, { "name": "marketingChannelType", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEvent", "description": "Associated marketing event of this marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "parentActivityId", "description": "ID of the parent activity of this marketing activity.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "parentRemoteId", "description": "ID of the parent activity of this marketing activity.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceAndMedium", "description": "A contextual description of the marketing activity based on the platform and tactic used.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current state of the marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingActivityStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "statusBadgeType", "description": "The severity of the marketing activity's status.", "args": [], "type": { "kind": "ENUM", "name": "MarketingActivityStatusBadgeType", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `statusBadgeTypeV2` instead." }, { "name": "statusBadgeTypeV2", "description": "The severity of the marketing activity's status.", "args": [], "type": { "kind": "ENUM", "name": "BadgeType", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "statusLabel", "description": "The rendered status of the marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "statusTransitionedAt", "description": "The [date and time](\n https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601\n ) when the activity's status last changed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tactic", "description": "The method of marketing used for this marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetStatus", "description": "The status to which the marketing activity is currently transitioning.", "args": [], "type": { "kind": "ENUM", "name": "MarketingActivityStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The marketing activity's title, which is rendered on the marketing listing page.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the marketing activity was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlParameterValue", "description": "A URL parameter value associated with this marketing activity.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "utmParameters", "description": "The set of [Urchin Tracking Module](\n https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters\n ) used in the URL for tracking this marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "UTMParameters", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "description": "The input fields combining budget amount and its marketing budget type.", "fields": null, "inputFields": [ { "name": "budgetType", "description": "Budget type for marketing activity.", "type": { "kind": "ENUM", "name": "MarketingBudgetBudgetType", "ofType": null }, "defaultValue": null }, { "name": "total", "description": "Amount of budget for the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityConnection", "description": "An auto-generated type for paginating through multiple MarketingActivities.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketingActivityEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityCreateExternalInput", "description": "The input fields for creating an externally-managed marketing activity.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "utm", "description": "Specifies the [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) that are associated with a related marketing campaign. Either the URL parameter value or UTM can be set, but not both.", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null }, { "name": "urlParameterValue", "description": "Value for a query parameters that gets inserted into storefront URLs for matching storefront traffic to this activity. This feature is currently available on a limited basis to some partners only. UTMs should continue to be used for most partners. Either the URL parameter value or UTM can be set, but not both.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "budget", "description": "The budget for this marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "ofType": null }, "defaultValue": null }, { "name": "adSpend", "description": "The amount spent on the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "remoteId", "description": "The ID of an activity that's hosted outside of Shopify.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The status of the marketing activity. If status isn't set it will default to UNDEFINED.", "type": { "kind": "ENUM", "name": "MarketingActivityExternalStatus", "ofType": null }, "defaultValue": null }, { "name": "remoteUrl", "description": "The URL for viewing and/or managing the activity outside of Shopify.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "remotePreviewImageUrl", "description": "The URL for a preview image that's used for the marketing activity.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "tactic", "description": "The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null } }, "defaultValue": null }, { "name": "marketingChannelType", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null } }, "defaultValue": null }, { "name": "referringDomain", "description": "The domain from which ad clicks are forwarded to the shop.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "channelHandle", "description": "The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "scheduledStart", "description": "The date and time at which the activity is scheduled to start.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "scheduledEnd", "description": "The date and time at which the activity is scheduled to end.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "start", "description": "The date and time at which the activity started. If omitted or set to `null`, the current time will be used.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "end", "description": "The date and time at which the activity ended. If omitted or set to `null`, the current time will be used if the status is set to `INACTIVE` or `DELETED_EXTERNALLY`.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "parentActivityId", "description": "The ID for the parent marketing activity, if creating hierarchical activities.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "parentRemoteId", "description": "The remote ID for the parent marketing activity, if creating hierarchical activities.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "hierarchyLevel", "description": "The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.", "type": { "kind": "ENUM", "name": "MarketingActivityHierarchyLevel", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityCreateExternalPayload", "description": "Return type for `marketingActivityCreateExternal` mutation.", "fields": [ { "name": "marketingActivity", "description": "The external marketing activity that was created.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityCreateInput", "description": "The input fields required to create a marketing activity.", "fields": null, "inputFields": [ { "name": "marketingActivityTitle", "description": "The title of the marketing activity.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "formData", "description": "The form data in JSON serialized as a string.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "marketingActivityExtensionId", "description": "The ID of the marketing activity extension.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "context", "description": "Encoded context containing marketing campaign id.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "utm", "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. UTMInput is required for all Marketing\ntactics except Storefront App.\n", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The current state of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingActivityStatus", "ofType": null } }, "defaultValue": null }, { "name": "budget", "description": "The budget for this marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityCreatePayload", "description": "Return type for `marketingActivityCreate` mutation.", "fields": [ { "name": "marketingActivity", "description": "The created marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "redirectPath", "description": "The path to return back to shopify admin from embedded editor.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityDeleteExternalPayload", "description": "Return type for `marketingActivityDeleteExternal` mutation.", "fields": [ { "name": "deletedMarketingActivityId", "description": "The ID of the marketing activity that was deleted, if one was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityEdge", "description": "An auto-generated type which holds one MarketingActivity and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketingActivityEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityExtensionAppErrorCode", "description": "The error code resulted from the marketing activity extension integration.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_ONBOARDED_ERROR", "description": "The shop/user must be onboarded to use the app.", "isDeprecated": false, "deprecationReason": null }, { "name": "VALIDATION_ERROR", "description": "The app has returned validation errors.", "isDeprecated": false, "deprecationReason": null }, { "name": "API_ERROR", "description": "The app is either not responding or returning unexpected data.", "isDeprecated": false, "deprecationReason": null }, { "name": "PLATFORM_ERROR", "description": "The app has returned an error when invoking the platform.", "isDeprecated": false, "deprecationReason": null }, { "name": "INSTALL_REQUIRED_ERROR", "description": "The app needs to be installed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityExtensionAppErrors", "description": "Represents errors returned from apps when using the marketing activity extension.", "fields": [ { "name": "code", "description": "The app error type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingActivityExtensionAppErrorCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors returned by the app.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityExternalStatus", "description": "Set of possible statuses for an external marketing activity.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "This marketing activity is currently running.", "isDeprecated": false, "deprecationReason": null }, { "name": "INACTIVE", "description": "This marketing activity has completed running.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAUSED", "description": "This marketing activity is currently not running.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "This marketing activity is scheduled to run.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETED_EXTERNALLY", "description": "This marketing activity was deleted and it was triggered from outside of Shopify.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNDEFINED", "description": "The marketing activity's status is unknown.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityHierarchyLevel", "description": "Hierarchy levels for external marketing activities.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AD", "description": "An advertisement activity. Must be parented by an ad group or a campaign activity, and must be assigned tracking parameters (URL or UTM).", "isDeprecated": false, "deprecationReason": null }, { "name": "AD_GROUP", "description": "A group of advertisement activities. Must be parented by a campaign activity.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAMPAIGN", "description": "A campaign activity. May contain either ad groups or ads as child activities. If childless, then the campaign activity should have tracking parameters assigned (URL or UTM) otherwise it won't appear in marketing reports.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivitySortKeys", "description": "The set of valid sort keys for the MarketingActivity query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityStatus", "description": "Status helps to identify if this marketing activity has been completed, queued, failed etc.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "This marketing activity is currently running.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETED", "description": "This marketing activity is permanently unavailable.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETED_EXTERNALLY", "description": "This marketing activity was deleted and it was triggered from outside of Shopify.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCONNECTED", "description": "This marketing activity is disconnected and no longer editable.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT", "description": "This marketing activity has been edited, but it is not yet created.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "This marketing activity is unable to run.", "isDeprecated": false, "deprecationReason": null }, { "name": "INACTIVE", "description": "This marketing activity has completed running.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAUSED", "description": "This marketing activity is currently not running.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "This marketing activity is pending creation on the app's marketing platform.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "This marketing activity is scheduled to run.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNDEFINED", "description": "The marketing activity's status is unknown.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityStatusBadgeType", "description": "StatusBadgeType helps to identify the color of the status badge.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "This status badge has type default.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUCCESS", "description": "This status badge has type success.", "isDeprecated": false, "deprecationReason": null }, { "name": "ATTENTION", "description": "This status badge has type attention.", "isDeprecated": false, "deprecationReason": null }, { "name": "WARNING", "description": "This status badge has type warning.", "isDeprecated": false, "deprecationReason": null }, { "name": "INFO", "description": "This status badge has type info.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpdateExternalInput", "description": "The input fields required to update an externally managed marketing activity.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the marketing activity.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "budget", "description": "The budget for this marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "ofType": null }, "defaultValue": null }, { "name": "adSpend", "description": "The amount spent on the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "remoteUrl", "description": "The URL for viewing and/or managing the activity outside of Shopify.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "remotePreviewImageUrl", "description": "The URL for a preview image that's used for the marketing activity.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "tactic", "description": "The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.", "type": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null }, "defaultValue": null }, { "name": "marketingChannelType", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "type": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null }, "defaultValue": null }, { "name": "referringDomain", "description": "The domain from which ad clicks are forwarded to the shop.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "scheduledStart", "description": "The date and time at which the activity is scheduled to start.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "scheduledEnd", "description": "The date and time at which the activity is scheduled to end.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "start", "description": "The date and time at which the activity started.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "end", "description": "The date and time at which the activity ended.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The status of the marketing activity.", "type": { "kind": "ENUM", "name": "MarketingActivityExternalStatus", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityUpdateExternalPayload", "description": "Return type for `marketingActivityUpdateExternal` mutation.", "fields": [ { "name": "marketingActivity", "description": "The updated marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpdateInput", "description": "The input fields required to update a marketing activity.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "marketingRecommendationId", "description": "The ID of the recommendation that the marketing activity was created from, if one exists.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the marketing activity.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "budget", "description": "The budget for the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "ofType": null }, "defaultValue": null }, { "name": "status", "description": "The current state of the marketing activity. Learn more about\n[marketing activities statuses](/api/marketing-activities/statuses).\n", "type": { "kind": "ENUM", "name": "MarketingActivityStatus", "ofType": null }, "defaultValue": null }, { "name": "targetStatus", "description": "The target state that the marketing activity is transitioning to. Learn more about [marketing activities statuses](/api/marketing-activities/statuses).", "type": { "kind": "ENUM", "name": "MarketingActivityStatus", "ofType": null }, "defaultValue": null }, { "name": "formData", "description": "The form data of the marketing activity. This is only used if the marketing activity is\n integrated with the external editor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "utm", "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. UTMInput is required for all Marketing\ntactics except Storefront App. The utm field can only be set once and never modified.\n", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null }, { "name": "marketedResources", "description": "A list of the item IDs that were marketed in this marketing activity. Valid types for these items are:\n* `Product`\n* `Shop`\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "errors", "description": "The error messages that were generated when the app was trying to complete the activity.\nLearn more about the\n[JSON format expected for error messages](/api/marketing-activities/statuses#failed-status).\n", "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityUpdatePayload", "description": "Return type for `marketingActivityUpdate` mutation.", "fields": [ { "name": "marketingActivity", "description": "The updated marketing activity.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "redirectPath", "description": "The redirect path from the embedded editor to the Shopify admin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpsertExternalInput", "description": "The input fields for creating or updating an externally-managed marketing activity.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "utm", "description": "Specifies the [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) that are associated with a related marketing campaign. Either the URL parameter value or UTM can be set, but not both.", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null }, { "name": "budget", "description": "The budget for this marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MarketingActivityBudgetInput", "ofType": null }, "defaultValue": null }, { "name": "adSpend", "description": "The amount spent on the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "remoteId", "description": "The ID of an activity that's hosted outside of Shopify.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "status", "description": "The status of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingActivityExternalStatus", "ofType": null } }, "defaultValue": null }, { "name": "remoteUrl", "description": "The URL for viewing and/or managing the activity outside of Shopify.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "remotePreviewImageUrl", "description": "The URL for a preview image that's used for the marketing activity.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "tactic", "description": "The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null } }, "defaultValue": null }, { "name": "marketingChannelType", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null } }, "defaultValue": null }, { "name": "referringDomain", "description": "The domain from which ad clicks are forwarded to the shop.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "channelHandle", "description": "The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "scheduledStart", "description": "The date and time at which the activity is scheduled to start.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "scheduledEnd", "description": "The date and time at which the activity is scheduled to end.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "start", "description": "The date and time at which the activity started. On creation, if this field is omitted or set to `null`, the current time will be used.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "end", "description": "The date and time at which the activity started. On creation, if this field is omitted or set to `null`, the current time will be used if the status is set to `INACTIVE` or `DELETED_EXTERNALLY` .", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "urlParameterValue", "description": "Value for a query parameters that gets inserted into storefront URLs for matching storefront traffic to this activity. This feature is currently available on a limited basis to some partners only. UTMs should continue to be used for most partners. Either the URL parameter value or UTM can be set, but not both.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "parentRemoteId", "description": "The remote ID for the parent marketing activity, if creating hierarchical activities.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "hierarchyLevel", "description": "The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.", "type": { "kind": "ENUM", "name": "MarketingActivityHierarchyLevel", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityUpsertExternalPayload", "description": "Return type for `marketingActivityUpsertExternal` mutation.", "fields": [ { "name": "marketingActivity", "description": "The external marketing activity that was created or updated.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingActivityUserError", "description": "An error that occurs during the execution of marketing activity and engagement mutations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MarketingActivityUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingActivityUserErrorCode", "description": "Possible error codes that can be returned by `MarketingActivityUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING_ACTIVITY_DOES_NOT_EXIST", "description": "Marketing activity does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING_EVENT_DOES_NOT_EXIST", "description": "Marketing activity is not valid, the associated marketing event does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENCY_CODE_MISMATCH_INPUT", "description": "All currency codes provided in the input need to match.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING_ACTIVITY_CURRENCY_CODE_MISMATCH", "description": "The currency codes provided need to match the referenced marketing activity's currency code.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETE_JOB_FAILED_TO_ENQUEUE", "description": "The job to delete all external activities failed to enqueue.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_HIERARCHIAL_REQUIRES_UTM_URL_PARAMETER", "description": "Non-hierarchical marketing activities must have UTM parameters or a URL parameter value.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETE_JOB_ENQUEUED", "description": "A mutation can not be ran because a job to delete all external activities has been enqueued, which happens either from calling the marketingActivitiesDeleteAllExternal mutation or as a result of an app uninstall.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVITY_NOT_EXTERNAL", "description": "The marketing activity must be an external activity.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE_CHANNEL_HANDLE", "description": "The channel handle value cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE_URL_PARAMETER", "description": "The URL parameter value cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE_UTM_PARAMETERS", "description": "The UTM parameters cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE_PARENT_ID", "description": "The parent activity cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE_HIERARCHY_LEVEL", "description": "The hierarchy level cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_REMOTE_ID", "description": "The remote ID does not correspond to an existing activity.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CHANNEL_HANDLE", "description": "The channel handle is not recognized.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DELETE_ACTIVITY_EXTERNAL_ARGUMENTS", "description": "Either the marketing activity ID or remote ID must be provided for the activity to be deleted.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DELETE_ENGAGEMENTS_ARGUMENTS", "description": "Either the channel_handle or delete_engagements_for_all_channels must be provided when deleting a marketing engagement.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MARKETING_ACTIVITY_EXTERNAL_ARGUMENTS", "description": "Either the marketing activity ID, remote ID, or UTM must be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MARKETING_ENGAGEMENT_ARGUMENTS", "description": "For activity level engagement, either the marketing activity ID or remote ID must be provided. For channel level engagement, the channel handle must be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MARKETING_ENGAGEMENT_ARGUMENT_MISSING", "description": "No identifier found. For activity level engagement, either the marketing activity ID or remote ID must be provided. For channel level engagement, the channel handle must be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_ACTIVITY_WITH_CHILD_EVENTS", "description": "This activity has child activities and thus cannot be deleted. Child activities must be deleted before a parent activity.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_UPDATE_TACTIC_TO_STOREFRONT_APP", "description": "The activity's tactic can not be updated to STOREFRONT_APP. This type of tactic can only be specified when creating a new activity.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_UPDATE_TACTIC_IF_ORIGINALLY_STOREFRONT_APP", "description": "The activity's tactic can not be updated from STOREFRONT_APP.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingBudget", "description": "This type combines budget amount and its marketing budget type.\n", "fields": [ { "name": "budgetType", "description": "The budget type for a marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingBudgetBudgetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total", "description": "The amount of budget for marketing activity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingBudgetBudgetType", "description": "The budget type for a marketing activity.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DAILY", "description": "A daily budget.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIFETIME", "description": "A budget for the lifetime of a marketing activity.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingChannel", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SEARCH", "description": "Paid search.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISPLAY", "description": "Displayed ads.", "isDeprecated": false, "deprecationReason": null }, { "name": "SOCIAL", "description": "Social media.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMAIL", "description": "Email.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFERRAL", "description": "Referral links.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEngagement", "description": "Marketing engagement represents customer activity taken on a marketing activity or a marketing channel.", "fields": [ { "name": "adSpend", "description": "The total ad spend for the marketing content. Recurring weekly, monthly, or yearly spend needs to be divided into daily amounts.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelHandle", "description": "The unique string identifier of the channel to which the engagement metrics are being provided. This should be set when and only when providing channel-level engagements. This should be nil when providing activity-level engagements. For the correct handle for your channel, contact your partner manager.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "clicksCount", "description": "The total number of interactions, such as a button press or a screen touch, that occurred on the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "commentsCount", "description": "The total number of comments on the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "complaintsCount", "description": "The total number of complaints on the marketing content. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "failsCount", "description": "The total number of fails for the marketing content. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "favoritesCount", "description": "The total number of favorites, likes, saves, or bookmarks on the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstTimeCustomers", "description": "The number of customers that have placed their first order. Doesn't include adjustments such as edits, exchanges, or returns.", "args": [], "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "impressionsCount", "description": "The total number of times marketing content was displayed to users, whether or not an interaction occurred. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were delivered.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isCumulative", "description": "Whether the engagements are reported as lifetime totals rather than daily increments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivity", "description": "The marketing activity object related to this engagement. This corresponds to the marketingActivityId passed in on creation of the engagement.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "occurredOn", "description": "The date that the engagements occurred on.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Date", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "The number of orders generated from the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returningCustomers", "description": "The number of returning customers that have placed an order. Doesn't include adjustments such as edits, exchanges, or returns.", "args": [], "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The amount of sales generated from the marketing content.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sendsCount", "description": "The total number of marketing emails or messages that were sent.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sessionsCount", "description": "The number of online store sessions generated from the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sharesCount", "description": "The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uniqueClicksCount", "description": "The total number of unique clicks on the marketing content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uniqueViewsCount", "description": "The total number of all users who saw marketing content since it was published. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "unsubscribesCount", "description": "The total number of unsubscribes on the marketing content. For social media platforms, this represents the number of unfollows.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "utcOffset", "description": "The time difference, in hours, between UTC and the time zone used to aggregate these metrics.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UtcOffset", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "viewsCount", "description": "The total number of views on the marketing content. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEngagementCreatePayload", "description": "Return type for `marketingEngagementCreate` mutation.", "fields": [ { "name": "marketingEngagement", "description": "The marketing engagement that was created. This represents customer activity taken on a marketing activity or a marketing channel.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingEngagement", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MarketingEngagementInput", "description": "The input fields for a marketing engagement.", "fields": null, "inputFields": [ { "name": "occurredOn", "description": "The date that the engagements occurred on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Date", "ofType": null } }, "defaultValue": null }, { "name": "impressionsCount", "description": "The total number of times marketing content was displayed to users, whether or not an interaction occurred. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were delivered.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "viewsCount", "description": "The total number of views on the marketing content. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "clicksCount", "description": "The total number of interactions, such as a button press or a screen touch, that occurred on the marketing content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "sharesCount", "description": "The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "favoritesCount", "description": "The total number of favorites, likes, saves, or bookmarks on the marketing content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "commentsCount", "description": "The total number of comments on the marketing content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "unsubscribesCount", "description": "The total number of unsubscribes on the marketing content. For social media platforms, this represents the number of unfollows.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "complaintsCount", "description": "The total number of complaints on the marketing content. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "failsCount", "description": "The total number of fails for the marketing content. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "sendsCount", "description": "The total number of marketing emails or messages that were sent.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "uniqueViewsCount", "description": "The total number of all users who saw marketing content since it was published. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "uniqueClicksCount", "description": "The total number of unique clicks on the marketing content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "adSpend", "description": "The total ad spend for the marketing content. Recurring weekly, monthly, or yearly spend needs to be divided into daily amounts.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "isCumulative", "description": "Whether the engagements are reported as lifetime totals rather than daily increments.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "utcOffset", "description": "The time difference, in hours, between UTC and the time zone used to aggregate these metrics.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UtcOffset", "ofType": null } }, "defaultValue": null }, { "name": "sales", "description": "The amount of sales generated from the marketing content.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "sessionsCount", "description": "The number of online store sessions generated from the marketing content.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "orders", "description": "The number of orders generated from the marketing content.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "firstTimeCustomers", "description": "The number of customers that have placed their first order. Doesn't include adjustments such as edits, exchanges, or returns.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "returningCustomers", "description": "The number of returning customers that have placed an order. Doesn't include adjustments such as edits, exchanges, or returns.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEngagementsDeletePayload", "description": "Return type for `marketingEngagementsDelete` mutation.", "fields": [ { "name": "result", "description": "Informational message about the engagement data that has been marked for deletion.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEvent", "description": "Represents actions that market a merchant's store or products.", "fields": [ { "name": "app", "description": "The app that the marketing event is attributed to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channel", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "args": [], "type": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `marketingChannelType` instead." }, { "name": "channelHandle", "description": "The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "A human-readable description of the marketing event.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "endedAt", "description": "The date and time when the marketing event ended.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "manageUrl", "description": "The URL where the marketing event can be managed.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingChannelType", "description": "The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.", "args": [], "type": { "kind": "ENUM", "name": "MarketingChannel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "previewUrl", "description": "The URL where the marketing event can be previewed.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remoteId", "description": "An optional ID that helps Shopify validate engagement data.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scheduledToEndAt", "description": "The date and time when the marketing event is scheduled to end.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceAndMedium", "description": "Where the `MarketingEvent` occurred and what kind of content was used.\nBecause `utmSource` and `utmMedium` are often used interchangeably, this is\nbased on a combination of `marketingChannel`, `referringDomain`, and `type` to\nprovide a consistent representation for any given piece of marketing\nregardless of the app that created it.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startedAt", "description": "The date and time when the marketing event started.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetTypeDisplayText", "description": "The display text for the marketing event type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `sourceAndMedium` instead." }, { "name": "type", "description": "The marketing event type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketingTactic", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "utmCampaign", "description": "The name of the marketing campaign.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "utmMedium", "description": "The medium that the marketing campaign is using. Example values: `cpc`, `banner`.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "utmSource", "description": "The referrer of the marketing event. Example values: `google`, `newsletter`.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEventConnection", "description": "An auto-generated type for paginating through multiple MarketingEvents.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingEventEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MarketingEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MarketingEventEdge", "description": "An auto-generated type which holds one MarketingEvent and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MarketingEventEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingEventSortKeys", "description": "The set of valid sort keys for the MarketingEvent query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STARTED_AT", "description": "Sort by the `started_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MarketingTactic", "description": "The available types of tactics for a marketing activity.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ABANDONED_CART", "description": "An abandoned cart recovery email.", "isDeprecated": false, "deprecationReason": null }, { "name": "AD", "description": "An ad, such as a Facebook ad.", "isDeprecated": false, "deprecationReason": null }, { "name": "AFFILIATE", "description": "An affiliate link.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINK", "description": "A link.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOYALTY", "description": "A loyalty program.", "isDeprecated": false, "deprecationReason": null }, { "name": "MESSAGE", "description": "A messaging app, such as Facebook Messenger.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEWSLETTER", "description": "A newsletter.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOTIFICATION", "description": "A notification in the Shopify admin.", "isDeprecated": false, "deprecationReason": null }, { "name": "POST", "description": "A blog post.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETARGETING", "description": "A retargeting ad.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSACTIONAL", "description": "A transactional email.", "isDeprecated": false, "deprecationReason": null }, { "name": "STOREFRONT_APP", "description": "A popup on the online store.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "Media", "description": "Represents a media interface.", "fields": [ { "name": "alt", "description": "A word or phrase to share the nature or contents of a media.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaContentType", "description": "The media content type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaErrors", "description": "Any errors which have occurred on the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaWarnings", "description": "The warnings attached to the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Current status of the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ExternalVideo", "ofType": null }, { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, { "kind": "OBJECT", "name": "Model3d", "ofType": null }, { "kind": "OBJECT", "name": "Video", "ofType": null } ] }, { "kind": "OBJECT", "name": "MediaConnection", "description": "An auto-generated type for paginating through multiple Media.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MediaEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Media", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MediaContentType", "description": "The possible content types for a media object.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "VIDEO", "description": "A Shopify-hosted video.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO", "description": "An externally hosted video.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL_3D", "description": "A 3d model.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE", "description": "A Shopify-hosted image.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaEdge", "description": "An auto-generated type which holds one Media and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MediaEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Media", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaError", "description": "Represents a media error. This typically occurs when there is an issue with the media itself causing it to fail validation.\nCheck the media before attempting to upload again.\n", "fields": [ { "name": "code", "description": "Code representing the type of error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaErrorCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "details", "description": "Additional details regarding the error.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Translated error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MediaErrorCode", "description": "Error types for media.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNKNOWN", "description": "Media error has occured for unknown reason.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_SIGNED_URL", "description": "Media could not be processed because the signed URL was invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE_DOWNLOAD_FAILURE", "description": "Media could not be processed because the image could not be downloaded.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE_PROCESSING_FAILURE", "description": "Media could not be processed because the image could not be processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_TIMEOUT_ERROR", "description": "Media timed out because it is currently being modified by another operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_NOT_FOUND", "description": "Media could not be created because the external video could not be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_UNLISTED", "description": "Media could not be created because the external video is not listed or is private.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO", "description": "Media could not be created because the external video has an invalid aspect ratio.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_EMBED_DISABLED", "description": "Media could not be created because embed permissions are disabled for this video.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING", "description": "Media could not be created because video is either not found or still transcoding.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_FILE_DOWNLOAD_FAILURE", "description": "File could not be processed because the source could not be downloaded.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_FILE_INVALID_SIZE", "description": "File could not be created because the size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_METADATA_READ_ERROR", "description": "Media could not be created because the metadata could not be read.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_INVALID_FILETYPE_ERROR", "description": "Media could not be created because it has an invalid file type.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_WIDTH_ERROR", "description": "Media could not be created because it does not meet the minimum width requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_WIDTH_ERROR", "description": "Media could not be created because it does not meet the maximum width requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_HEIGHT_ERROR", "description": "Media could not be created because it does not meet the minimum height requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_HEIGHT_ERROR", "description": "Media could not be created because it does not meet the maximum height requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MIN_DURATION_ERROR", "description": "Media could not be created because it does not meet the minimum duration requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_MAX_DURATION_ERROR", "description": "Media could not be created because it does not meet the maximum duration requirement.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_VALIDATION_ERROR", "description": "Video failed validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_VALIDATION_ERROR", "description": "Model failed validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_THUMBNAIL_GENERATION_ERROR", "description": "Media could not be created because the model's thumbnail generation failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_THUMBNAIL_REGENERATION_ERROR", "description": "There was an issue while trying to generate a new thumbnail.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR", "description": "Media could not be created because the model can't be converted to USDZ format.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_GLB_OUTPUT_CREATION_ERROR", "description": "Media could not be created because the model file failed processing.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_PROCESSING_FAILURE", "description": "Media could not be created because the model file failed processing.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_IMAGE_FILE_TYPE", "description": "Media could not be created because the image is an unsupported file type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_FILE_SIZE", "description": "Media could not be created because the image size is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_ASPECT_RATIO", "description": "Media could not be created because the image has an invalid aspect ratio.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_IMAGE_RESOLUTION", "description": "Media could not be created because the image's resolution exceeds the max limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE_STORAGE_LIMIT_EXCEEDED", "description": "Media could not be created because the cumulative file storage limit would be exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_FILENAME_ERROR", "description": "Media could not be created because a file with the same name already exists.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MediaHost", "description": "Host for a Media Resource.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "YOUTUBE", "description": "Host for YouTube embedded videos.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIMEO", "description": "Host for Vimeo embedded videos.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaImage", "description": "An image hosted on Shopify.\n", "fields": [ { "name": "alt", "description": "A word or phrase to share the nature or contents of a media.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileErrors", "description": "Any errors that have occurred on the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileStatus", "description": "The status of the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FileStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The image for the media. Returns `null` until `status` is `READY`.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaContentType", "description": "The media content type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaErrors", "description": "Any errors which have occurred on the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaWarnings", "description": "The warnings attached to the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mimeType", "description": "The MIME type of the image.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalSource", "description": "The original source of the image.", "args": [], "type": { "kind": "OBJECT", "name": "MediaImageOriginalSource", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "status", "description": "Current status of the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "File", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Media", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaImageOriginalSource", "description": "The original source for an image.\n", "fields": [ { "name": "fileSize", "description": "The size of the original file in bytes.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the original image, valid only for a short period.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaPreviewImage", "description": "Represents the preview image for a media.", "fields": [ { "name": "image", "description": "The preview image for the media. Returns `null` until `status` is `READY`.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Current status of the preview image.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaPreviewImageStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MediaPreviewImageStatus", "description": "The possible statuses for a media preview image.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UPLOADED", "description": "Preview image is uploaded but not yet processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING", "description": "Preview image is being processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY", "description": "Preview image is ready to be displayed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "Preview image processing has failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MediaStatus", "description": "The possible statuses for a media object.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UPLOADED", "description": "Media has been uploaded but not yet processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING", "description": "Media is being processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY", "description": "Media is ready to be displayed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "Media processing has failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaUserError", "description": "Represents an error that happens during execution of a Media query or mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MediaUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MediaUserErrorCode", "description": "Possible error codes that can be returned by `MediaUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_VALIDATION_ERROR", "description": "Video validation failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_VALIDATION_ERROR", "description": "Model validation failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO_THROTTLE_EXCEEDED", "description": "Video creation throttle was exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL3D_THROTTLE_EXCEEDED", "description": "Model3d creation throttle was exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_MEDIA_LIMIT_EXCEEDED", "description": "Exceeded the limit of media per product.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_MEDIA_LIMIT_EXCEEDED", "description": "Exceeded the limit of media per shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_DOES_NOT_EXIST", "description": "Media does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_DOES_NOT_EXIST_ON_PRODUCT", "description": "Media does not exist on the given product.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_MEDIA_PER_INPUT_PAIR", "description": "Only one mediaId is allowed per variant-media input pair.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED", "description": "Exceeded the maximum number of 100 variant-media pairs per mutation call.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MEDIA_TYPE", "description": "Invalid media type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES", "description": "Variant specified in more than one pair.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT", "description": "Variant does not exist on the given product.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_READY_MEDIA", "description": "Non-ready media are not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_ALREADY_HAS_MEDIA", "description": "Product variant already has attached media.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_IS_NOT_ATTACHED_TO_VARIANT", "description": "The specified media is not attached to the specified variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_CANNOT_BE_MODIFIED", "description": "Media cannot be modified. It is currently being modified by another operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENTS", "description": "Missing arguments.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MediaWarning", "description": "Represents a media warning. This occurs when there is a non-blocking concern regarding your media.\nConsider reviewing your media to ensure it is correct and its parameters are as expected.\n", "fields": [ { "name": "code", "description": "The code representing the type of warning.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaWarningCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Translated warning message.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MediaWarningCode", "description": "Warning types for media.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MODEL_SMALL_PHYSICAL_SIZE", "description": "3D model physical size might be invalid. The dimensions of your model are very small. Consider reviewing your model to ensure they are correct.", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL_LARGE_PHYSICAL_SIZE", "description": "3D model physical size might be invalid. The dimensions of your model are very large. Consider reviewing your model to ensure they are correct.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MerchandiseDiscountClass", "description": "The class of the discount for combining purposes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT", "description": "Combined as a product discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER", "description": "Combined as an order discount.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MerchantApprovalSignals", "description": "Merchant approval for accelerated onboarding to channel integration apps.", "fields": [ { "name": "identityVerified", "description": "Whether the shop's Shopify Payments account identity is verified. Returns `false` if the identity is unverified or if the shop doesn't have a Shopify Payments account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "verifiedByShopify", "description": "Whether Shopify has pre-verified the merchant's business for onboarding to channel integration apps. Returns `false` if the shop isn't marked for verification.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "verifiedByShopifyTier", "description": "Which tier of the Shopify verification was determined for the merchant's business for onboarding to channel integration apps.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Metafield", "description": "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).\nFor more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields).\nSome examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers.\nMetafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.\n", "fields": [ { "name": "createdAt", "description": "The date and time when the metafield was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "definition", "description": "The metafield definition that the metafield belongs to, if any.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the metafield.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The unique identifier for the metafield within its namespace.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The container for a group of metafields that the metafield is associated with.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "owner", "description": "The resource that the metafield is attached to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ownerType", "description": "The type of resource that the metafield is attached to.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reference", "description": "Returns a reference object if the metafield definition's type is a resource reference.", "args": [], "type": { "kind": "UNION", "name": "MetafieldReference", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "references", "description": "A list of reference objects if the metafield's type is a resource reference list.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldReferenceConnection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of data that is stored in the metafield.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the metafield was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldAccess", "description": "The access settings for this metafield definition.", "fields": [ { "name": "admin", "description": "The default admin access setting used for the metafields under this definition.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldAdminAccess", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grants", "description": "The explicit grants for this metafield definition, superseding the default admin access\nfor the specified grantees.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldAccessGrant", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefront", "description": "The storefront access setting used for the metafields under this definition.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldStorefrontAccess", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldAccessGrant", "description": "An explicit access grant for the metafields under this definition.\n", "fields": [ { "name": "access", "description": "The level of access the grantee has.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldGrantAccessLevel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "grantee", "description": "The grantee being granted access.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantDeleteInput", "description": "The input fields for an explicit access grant to be deleted for the metafields under this definition.\n", "fields": null, "inputFields": [ { "name": "grantee", "description": "The grantee whose grant should be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantInput", "description": "The input fields for an explicit access grant to be created or updated for the metafields under this definition.\n", "fields": null, "inputFields": [ { "name": "grantee", "description": "The grantee being granted access.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "access", "description": "The level of access being granted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldGrantAccessLevel", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantOperationInput", "description": "The input fields for possible operations for modifying access grants. Exactly one option is required.\n", "fields": null, "inputFields": [ { "name": "create", "description": "The input fields for an explicit access grant to be created or updated for the metafields under this definition.\n", "type": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantInput", "ofType": null }, "defaultValue": null }, { "name": "update", "description": "The input fields for an explicit access grant to be created or updated for the metafields under this definition.\n", "type": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantInput", "ofType": null }, "defaultValue": null }, { "name": "delete", "description": "The input fields for an explicit access grant to be deleted for the metafields under this definition.\n", "type": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantDeleteInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldAccessInput", "description": "The input fields for the access settings for the metafields under the definition.\n", "fields": null, "inputFields": [ { "name": "admin", "description": "The admin access setting to use for the metafields under this definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldAdminAccess", "ofType": null } }, "defaultValue": null }, { "name": "storefront", "description": "The storefront access setting to use for the metafields under this definition.", "type": { "kind": "ENUM", "name": "MetafieldStorefrontAccess", "ofType": null }, "defaultValue": null }, { "name": "grants", "description": "The list of explicit grants to grant for the metafields under this definition.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldAccessUpdateInput", "description": "The input fields for the access settings for the metafields under the definition.\n", "fields": null, "inputFields": [ { "name": "admin", "description": "The admin access setting to use for the metafields under this definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldAdminAccess", "ofType": null } }, "defaultValue": null }, { "name": "storefront", "description": "The storefront access setting to use for the metafields under this definition.", "type": { "kind": "ENUM", "name": "MetafieldStorefrontAccess", "ofType": null }, "defaultValue": null }, { "name": "grants", "description": "The set of grant operations to perform.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessGrantOperationInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldAdminAccess", "description": "Possible admin access settings for metafields.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRIVATE", "description": "Owner gets full access. No one else has access rights.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC_READ", "description": "Owner gets full access. All applications and the merchant have read-only access.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT_READ", "description": "Owner gets full access. The merchant has read-only access. No one else has access rights.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT_READ_WRITE", "description": "Owner gets full access. The merchant has read and write access. No one else has access rights.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldConnection", "description": "An auto-generated type for paginating through multiple Metafields.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetafieldEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Metafield", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinition", "description": "Metafield definitions enable you to define additional validation constraints for metafields, and enable the\nmerchant to edit metafield values in context.\n", "fields": [ { "name": "access", "description": "The access settings associated with the metafield definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldAccess", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the metafield definition.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The unique identifier for the metafield definition within its namespace.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "The metafields that belong to the metafield definition.", "args": [ { "name": "validationStatus", "description": "Returns the metafields filtered by the validation status.", "type": { "kind": "ENUM", "name": "MetafieldValidationStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldsCount", "description": "The count of the metafields that belong to the metafield definition.", "args": [ { "name": "validationStatus", "description": "The current validation status.", "type": { "kind": "ENUM", "name": "MetafieldValidationStatus", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The human-readable name of the metafield definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The container for a group of metafields that the metafield definition is associated with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ownerType", "description": "The resource type that the metafield definition is attached to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pinnedPosition", "description": "The position of the metafield definition in the pinned list.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardTemplate", "description": "The standard metafield definition template associated with the metafield definition.", "args": [], "type": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplate", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of data that each of the metafields that belong to the metafield definition will store.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "useAsCollectionCondition", "description": "Whether the metafield definition can be used as a collection condition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validationStatus", "description": "The validation status for the metafields that belong to the metafield definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldDefinitionValidationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validations", "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionValidation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibleToStorefrontApi", "description": "Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `access.storefront` instead." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "description": "An auto-generated type for paginating through multiple MetafieldDefinitions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetafieldDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionCreatePayload", "description": "Return type for `metafieldDefinitionCreate` mutation.", "fields": [ { "name": "createdDefinition", "description": "The metafield definition that was created.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionCreateUserError", "description": "An error that occurs during the execution of `MetafieldDefinitionCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldDefinitionCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionCreateUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldDefinitionCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_TYPE_LIMIT_EXCEEDED", "description": "The definition limit per owner type has exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIMIT_EXCEEDED", "description": "The maximum limit of definitions per owner type has exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_OPTION", "description": "An invalid option.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_OPTION", "description": "A duplicate option.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESERVED_NAMESPACE_KEY", "description": "This namespace and key combination is reserved for standard definitions.", "isDeprecated": false, "deprecationReason": null }, { "name": "PINNED_LIMIT_REACHED", "description": "The pinned limit has been reached for the owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSTRUCTURED_ALREADY_EXISTS", "description": "This namespace and key combination is already in use for a set of your metafields.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CHARACTER", "description": "A field contains an invalid character.", "isDeprecated": false, "deprecationReason": null }, { "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", "description": "The definition type is not eligible to be used as collection condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS", "description": "You have reached the maximum allowed definitions for automated collections.", "isDeprecated": false, "deprecationReason": null }, { "name": "GRANT_LIMIT_EXCEEDED", "description": "The maximum limit of grants per definition type has been exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INPUT_COMBINATION", "description": "The input combination is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionDeletePayload", "description": "Return type for `metafieldDefinitionDelete` mutation.", "fields": [ { "name": "deletedDefinitionId", "description": "The ID of the deleted metafield definition.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionDeleteUserError", "description": "An error that occurs during the execution of `MetafieldDefinitionDelete`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldDefinitionDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionDeleteUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldDefinitionDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "Definition not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFERENCE_TYPE_DELETION_ERROR", "description": "Deleting a reference type metafield definition requires deletion of its associated metafields.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAFIELD_DEFINITION_IN_USE", "description": "Action cannot proceed. Definition is currently in use.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionEdge", "description": "An auto-generated type which holds one MetafieldDefinition and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetafieldDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionInput", "description": "The input fields required to create a metafield definition.\n", "fields": null, "inputFields": [ { "name": "namespace", "description": "The container for a group of metafields that the metafield definition will be associated with. If omitted, the\napp-reserved namespace will be used.\n\nMust be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The unique identifier for the metafield definition within its namespace.\n\nMust be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The human-readable name for the metafield definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "description", "description": "The description for the metafield definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "ownerType", "description": "The resource type that the metafield definition is attached to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "defaultValue": null }, { "name": "type", "description": "The type of data that each of the metafields that belong to the metafield definition will store.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "validations", "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionValidationInput", "ofType": null } } }, "defaultValue": null }, { "name": "useAsCollectionCondition", "description": "Whether the metafield definition can be used as a collection condition.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "pin", "description": "Whether to [pin](https://help.shopify.com/manual/custom-data/metafields/pinning-metafield-definitions)\nthe metafield definition.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "access", "description": "The access settings that apply to each of the metafields that belong to the metafield definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionPinPayload", "description": "Return type for `metafieldDefinitionPin` mutation.", "fields": [ { "name": "pinnedDefinition", "description": "The metafield definition that was pinned.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionPinUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionPinUserError", "description": "An error that occurs during the execution of `MetafieldDefinitionPin`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionPinUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldDefinitionPinUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "The metafield definition was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PINNED_LIMIT_REACHED", "description": "The pinned limit has been reached for owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALREADY_PINNED", "description": "The metafield definition is already pinned.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "description": "Possible metafield definition pinned statuses.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ANY", "description": "All metafield definitions.", "isDeprecated": false, "deprecationReason": null }, { "name": "PINNED", "description": "Only metafield definitions that are pinned.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNPINNED", "description": "Only metafield definitions that are not pinned.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "description": "The set of valid sort keys for the MetafieldDefinition query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PINNED_POSITION", "description": "Sort by the `pinned_position` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionSupportedValidation", "description": "The type and name for the optional validation configuration of a metafield.\n\nFor example, a supported validation might consist of a `max` name and a `number_integer` type.\nThis validation can then be used to enforce a maximum character length for a `single_line_text_field` metafield.\n", "fields": [ { "name": "name", "description": "The name of the metafield definition validation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of input for the validation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionType", "description": "A metafield definition type provides basic foundation and validation for a metafield.\n", "fields": [ { "name": "category", "description": "The category associated with the metafield definition type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the type for the metafield definition.\nSee the list of [supported types](https://shopify.dev/apps/metafields/types).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "supportedValidations", "description": "The supported validations for a metafield definition type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionSupportedValidation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "supportsDefinitionMigrations", "description": "Whether metafields without a definition can be migrated to a definition of this type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "valueType", "description": "The value type for a metafield created with this definition type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldValueType", "ofType": null } }, "isDeprecated": true, "deprecationReason": "`valueType` is deprecated and `name` should be used for type information." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUnpinPayload", "description": "Return type for `metafieldDefinitionUnpin` mutation.", "fields": [ { "name": "unpinnedDefinition", "description": "The metafield definition that was unpinned.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionUnpinUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUnpinUserError", "description": "An error that occurs during the execution of `MetafieldDefinitionUnpin`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldDefinitionUnpinUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionUnpinUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldDefinitionUnpinUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "The metafield definition was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_PINNED", "description": "The metafield definition isn't pinned.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionUpdateInput", "description": "The input fields required to update a metafield definition.\n", "fields": null, "inputFields": [ { "name": "namespace", "description": "The container for a group of metafields that the metafield definition is associated with. Used to help identify\nthe metafield definition, but cannot be updated itself. If omitted, the app-reserved namespace will be used.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The unique identifier for the metafield definition within its namespace. Used to help identify the metafield\ndefinition, but can't be updated itself.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The human-readable name for the metafield definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "The description for the metafield definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "ownerType", "description": "The resource type that the metafield definition is attached to. Used to help identify the metafield definition,\nbut can't be updated itself.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "defaultValue": null }, { "name": "validations", "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionValidationInput", "ofType": null } } }, "defaultValue": null }, { "name": "pin", "description": "Whether to pin the metafield definition.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "useAsCollectionCondition", "description": "Whether the metafield definition can be used as a collection condition.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "access", "description": "The access settings that apply to each of the metafields that belong to the metafield definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetafieldAccessUpdateInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUpdatePayload", "description": "Return type for `metafieldDefinitionUpdate` mutation.", "fields": [ { "name": "updatedDefinition", "description": "The metafield definition that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validationJob", "description": "The asynchronous job updating the metafield definition's validation_status.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionUpdateUserError", "description": "An error that occurs during the execution of `MetafieldDefinitionUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldDefinitionUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionUpdateUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldDefinitionUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The metafield definition wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INPUT", "description": "An invalid input.", "isDeprecated": false, "deprecationReason": null }, { "name": "PINNED_LIMIT_REACHED", "description": "The pinned limit has been reached for the owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "An internal error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", "description": "The definition type is not eligible to be used as collection condition.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAFIELD_DEFINITION_IN_USE", "description": "Action cannot proceed. Definition is currently in use.", "isDeprecated": false, "deprecationReason": null }, { "name": "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS", "description": "You have reached the maximum allowed definitions for automated collections.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECT_DEFINITION_CHANGED", "description": "You cannot change the metaobject definition pointed to by a metaobject reference metafield definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "GRANT_LIMIT_EXCEEDED", "description": "The maximum limit of grants per definition type has been exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INPUT_COMBINATION", "description": "The input combination is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDefinitionValidation", "description": "A configured metafield definition validation.\n\nFor example, for a metafield definition of `number_integer` type, you can set a validation with the name `max`\nand a value of `15`. This validation will ensure that the value of the metafield is a number less than or equal to 15.\n\nRefer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).\n", "fields": [ { "name": "name", "description": "The validation name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The name for the metafield type of this validation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The validation value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionValidationInput", "description": "The name and value for a metafield definition validation.\n\nFor 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`.\nThis validation will ensure that the value of the metafield is at least 10 characters.\n\nRefer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).\n", "fields": null, "inputFields": [ { "name": "name", "description": "The name for the metafield definition validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The value for the metafield definition validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldDefinitionValidationStatus", "description": "Possible metafield definition validation statuses.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALL_VALID", "description": "All of this definition's metafields are valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_PROGRESS", "description": "Asynchronous validation of this definition's metafields is in progress.", "isDeprecated": false, "deprecationReason": null }, { "name": "SOME_INVALID", "description": "Some of this definition's metafields are invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldDeleteInput", "description": "The input fields to delete a metafield.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the metafield to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldDeletePayload", "description": "Return type for `metafieldDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted metafield.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldEdge", "description": "An auto-generated type which holds one Metafield and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetafieldEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Metafield", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldGrantAccessLevel", "description": "Possible access levels for explicit metafield access grants.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "READ", "description": "Read metafield access.", "isDeprecated": false, "deprecationReason": null }, { "name": "READ_WRITE", "description": "Read and write metafield access.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldIdentifier", "description": "Identifies a metafield by its owner resource, namespace, and key.\n", "fields": [ { "name": "key", "description": "The key of the metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The namespace of the metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ownerId", "description": "GID of the owner resource that the metafield belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldIdentifierInput", "description": "The input fields that identify metafields.\n", "fields": null, "inputFields": [ { "name": "ownerId", "description": "The unique ID of the resource that the metafield is attached to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "namespace", "description": "The namespace of the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key of the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "description": "The input fields to use to create or update a metafield through a mutation on the owning resource.\nAn alternative way to create or update a metafield is by using the\n[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation.\n", "fields": null, "inputFields": [ { "name": "id", "description": "The unique ID of the metafield.\n\nRequired when updating a metafield, but shouldn't be included when creating as it's created automatically.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "namespace", "description": "The container for a group of metafields that the metafield is or will be associated with. Used in tandem with\n`key` to lookup a metafield on a resource, preventing conflicts with other metafields with the same `key`.\n\nRequired when creating a metafield, but optional when updating. Used to help identify the metafield when\nupdating, but can't be updated itself.\n\nMust be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The unique identifier for a metafield within its namespace.\n\nRequired when creating a metafield, but optional when updating. Used to help identify the metafield when\nupdating, but can't be updated itself.\n\nMust be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "type", "description": "The type of data that is stored in the metafield.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n\nRequired when creating a metafield, but optional when updating.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldOwnerType", "description": "Possible types of a metafield's owner resource.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "API_PERMISSION", "description": "The Api Permission metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY", "description": "The Company metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATION", "description": "The Company Location metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_CUSTOMIZATION", "description": "The Payment Customization metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "VALIDATION", "description": "The Validation metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER", "description": "The Customer metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_CUSTOMIZATION", "description": "The Delivery Customization metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFTORDER", "description": "The Draft Order metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET", "description": "The Market metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "CARTTRANSFORM", "description": "The Cart Transform metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION", "description": "The Collection metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIA_IMAGE", "description": "The Media Image metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTIMAGE", "description": "The Product Image metafield owner type.", "isDeprecated": true, "deprecationReason": "`PRODUCTIMAGE` is deprecated. Use `MEDIA_IMAGE` instead." }, { "name": "PRODUCT", "description": "The Product metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTVARIANT", "description": "The Product Variant metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ARTICLE", "description": "The Article metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLOG", "description": "The Blog metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAGE", "description": "The Page metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_CONSTRAINT_RULE", "description": "The Fulfillment Constraint Rule metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_ROUTING_LOCATION_RULE", "description": "The Order Routing Location Rule metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNT", "description": "The Discount metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER", "description": "The Order metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATION", "description": "The Location metafield owner type.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP", "description": "The Shop metafield owner type.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "MetafieldReference", "description": "The resource referenced by the metafield value.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "GenericFile", "ofType": null }, { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, { "kind": "OBJECT", "name": "Model3d", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "Video", "ofType": null } ] }, { "kind": "OBJECT", "name": "MetafieldReferenceConnection", "description": "An auto-generated type for paginating through multiple MetafieldReferences.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldReferenceEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetafieldReferenceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "UNION", "name": "MetafieldReference", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldReferenceEdge", "description": "An auto-generated type which holds one MetafieldReference and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetafieldReferenceEdge.", "args": [], "type": { "kind": "UNION", "name": "MetafieldReference", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "MetafieldReferencer", "description": "Types of resources that may use metafields to reference other resources.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AppInstallation", "ofType": null }, { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, { "kind": "OBJECT", "name": "Location", "ofType": null }, { "kind": "OBJECT", "name": "Market", "ofType": null }, { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreArticle", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreBlog", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "Shop", "ofType": null } ] }, { "kind": "OBJECT", "name": "MetafieldRelation", "description": "Defines a relation between two resources via a reference metafield.\nThe referencer owns the joining field with a given namespace and key,\nwhile the target is referenced by the field.\n", "fields": [ { "name": "key", "description": "The key of the field making the reference.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the field making the reference.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The namespace of the metafield making the reference, or type of the metaobject.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "referencer", "description": "The resource making the reference.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "MetafieldReferencer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "target", "description": "The referenced resource.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "MetafieldReference", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldRelationConnection", "description": "An auto-generated type for paginating through multiple MetafieldRelations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldRelationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetafieldRelationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldRelation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldRelationEdge", "description": "An auto-generated type which holds one MetafieldRelation and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetafieldRelationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldRelation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldStorefrontAccess", "description": "Defines how the metafields of a definition can be accessed in Storefront API surface areas, including Liquid and the GraphQL Storefront API.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PUBLIC_READ", "description": "Metafields are accessible in the GraphQL Storefront API and online store Liquid templates.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "Metafields are not accessible in any Storefront API surface area.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "description": "By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API,\nyou need to create a `MetafieldStorefrontVisibility` record. A `MetafieldStorefrontVisibility` record is a list\nof the metafields, defined by the `owner_type`, `namespace`, and `key`, to make visible in the Storefront API.\n\nLearn about [exposing metafields in the Storefront API]\n(https://shopify.dev/custom-storefronts/products-collections/metafields)\nfor more details.\n", "fields": [ { "name": "createdAt", "description": "The date and time when the metafield was set to visible in the Storefront API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The key of a metafield to make visible in the Storefront API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The namespace of a metafield to make visible in the Storefront API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ownerType", "description": "The owner type of a metafield to make visible in the Storefront API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the `MetafieldStorefrontVisilibty` record was updated.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityConnection", "description": "An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetafieldStorefrontVisibilityEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityCreatePayload", "description": "Return type for `metafieldStorefrontVisibilityCreate` mutation.", "fields": [ { "name": "metafieldStorefrontVisibility", "description": "The `MetafieldStorefrontVisibility` that was created.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityDeletePayload", "description": "Return type for `metafieldStorefrontVisibilityDelete` mutation.", "fields": [ { "name": "deletedMetafieldStorefrontVisibilityId", "description": "The ID of the deleted `MetafieldStorefrontVisibility` record.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityEdge", "description": "An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetafieldStorefrontVisibilityEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldStorefrontVisibilityInput", "description": "The input fields to create a MetafieldStorefrontVisibility record.\n", "fields": null, "inputFields": [ { "name": "namespace", "description": "The namespace of a metafield to make visible in the Storefront API. If omitted the app reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key of a metafield to make visible in the Storefront API.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "ownerType", "description": "The owner type of a metafield to make visible in the Storefront API.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldValidationStatus", "description": "Possible metafield validation statuses.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ANY", "description": "Any validation status (valid or invalid).", "isDeprecated": false, "deprecationReason": null }, { "name": "VALID", "description": "Valid (according to definition).", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "Invalid (according to definition).", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldValueType", "description": "Legacy type information for the stored value.\nReplaced by `type`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STRING", "description": "A text field.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTEGER", "description": "A whole number.", "isDeprecated": false, "deprecationReason": null }, { "name": "JSON_STRING", "description": "A JSON string.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOOLEAN", "description": "A `true` or `false` value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldsDeletePayload", "description": "Return type for `metafieldsDelete` mutation.", "fields": [ { "name": "deletedMetafields", "description": "List of metafield identifiers that were deleted, null if the corresponding metafield isn't found.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldIdentifier", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetafieldsSetInput", "description": "The input fields for a metafield value to set.", "fields": null, "inputFields": [ { "name": "ownerId", "description": "The unique ID of the resource that the metafield is attached to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "namespace", "description": "The container for a group of metafields that the metafield is or will be associated with. Used in tandem\nwith `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the\nsame `key`. If omitted the app-reserved namespace will be used.\n\nMust be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The unique identifier for a metafield within its namespace.\n\nMust be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "type", "description": "The type of data that is stored in the metafield.\nThe type must be one of the [supported types](https://shopify.dev/apps/metafields/types).\n\nRequired when there is no corresponding definition for the given `namespace`, `key`, and\nowner resource type (derived from `ownerId`).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldsSetPayload", "description": "Return type for `metafieldsSet` mutation.", "fields": [ { "name": "metafields", "description": "The list of metafields that were set.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Metafield", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldsSetUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetafieldsSetUserError", "description": "An error that occurs during the execution of `MetafieldsSet`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetafieldsSetUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "elementIndex", "description": "The index of the array element that's causing the error.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetafieldsSetUserErrorCode", "description": "Possible error codes that can be returned by `MetafieldsSetUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE", "description": "The value is invalid for metafield type or for definition options.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TYPE", "description": "The type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_NOT_AUTHORIZED", "description": "ApiPermission metafields can only be created or updated by the app owner.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_VIOLATION", "description": "The metafield violates a capability restriction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Metaobject", "description": "Provides an object instance represented by a MetaobjectDefinition.", "fields": [ { "name": "capabilities", "description": "Metaobject capabilities for this Metaobject.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectCapabilityData", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdBy", "description": "The app used to create the object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdByApp", "description": "The app used to create the object.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdByStaff", "description": "The staff member who created the metaobject.\n", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "definition", "description": "The MetaobjectDefinition that models this object type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The preferred display name field value of the metaobject.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The field for an object key, or null if the key has no field definition.", "args": [ { "name": "key", "description": "The metaobject key to access.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectField", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fields", "description": "All ordered fields of the metaobject with their definitions and values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectField", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "The unique handle of the object, useful as a custom ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "referencedBy", "description": "List of back references metafields that belong to the resource.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldRelationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The staff member who created the metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `createdByStaff` instead." }, { "name": "thumbnailField", "description": "The recommended field to visually represent this metaobject. May be a file reference or color field.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectField", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of the metaobject.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "When the object was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectAccess", "description": "Provides metaobject definition's access configuration.", "fields": [ { "name": "admin", "description": "Access configuration for Admin API surface areas, including the GraphQL Admin API.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetaobjectAdminAccess", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefront", "description": "Access configuration for Storefront surface areas, including the GraphQL Storefront API and Liquid.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetaobjectStorefrontAccess", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectAccessInput", "description": "The input fields for configuring metaobject access controls.", "fields": null, "inputFields": [ { "name": "admin", "description": "Access configuration for Admin API surface areas, including the GraphQL Admin API.\n", "type": { "kind": "ENUM", "name": "MetaobjectAdminAccess", "ofType": null }, "defaultValue": null }, { "name": "storefront", "description": "Access configuration for Storefront API surface areas, including the GraphQL Storefront API and Liquid.\n", "type": { "kind": "ENUM", "name": "MetaobjectStorefrontAccess", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetaobjectAdminAccess", "description": "Defines how the metaobjects of a definition can be accessed in admin API surface areas.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRIVATE", "description": "Only the application that owns a metaobject can read and write to it.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT_READ", "description": "Applications that act on behalf of merchants can read metaobjects.\nOnly the owning application can write metaobjects.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT_READ_WRITE", "description": "The owning application, as well as applications that act on behalf of merchants can read and write metaobjects.\nNo other applications can read or write metaobjects.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC_READ", "description": "All applications with the `metaobjects` access scope can read metaobjects.\nOnly the owning application can write metaobjects.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC_READ_WRITE", "description": "All applications with the `metaobjects` access scope can read and write metaobjects.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectBulkDeletePayload", "description": "Return type for `metaobjectBulkDelete` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job that deletes the metaobjects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectBulkDeleteWhereCondition", "description": "Specifies the condition by which metaobjects are deleted.\nExactly one field of input is required.\n", "fields": null, "inputFields": [ { "name": "type", "description": "Deletes all metaobjects with the specified `type`.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "A list of metaobjects IDs to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilities", "description": "Provides the capabilities of a metaobject definition.", "fields": [ { "name": "onlineStore", "description": "Indicates whether a metaobject definition can be displayed as a page on the Online Store.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilitiesOnlineStore", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishable", "description": "Indicate whether a metaobject definition is publishable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectCapabilitiesPublishable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "renderable", "description": "Indicate whether a metaobject definition is renderable and exposes SEO data.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilitiesRenderable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatable", "description": "Indicate whether a metaobject definition is translatable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectCapabilitiesTranslatable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilitiesOnlineStore", "description": "The Online Store capability of a metaobject definition.", "fields": [ { "name": "data", "description": "The data associated with the Online Store capability.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilityDefinitionDataOnlineStore", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Indicates if the capability is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilitiesPublishable", "description": "The publishable capability of a metaobject definition.", "fields": [ { "name": "enabled", "description": "Indicates if the capability is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilitiesRenderable", "description": "The renderable capability of a metaobject definition.", "fields": [ { "name": "data", "description": "The data associated with the renderable capability.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilityDefinitionDataRenderable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Indicates if the capability is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilitiesTranslatable", "description": "The translatable capability of a metaobject definition.", "fields": [ { "name": "enabled", "description": "Indicates if the capability is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityCreateInput", "description": "The input fields for creating a metaobject capability.", "fields": null, "inputFields": [ { "name": "publishable", "description": "The input for enabling the publishable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityPublishableInput", "ofType": null }, "defaultValue": null }, { "name": "translatable", "description": "The input for enabling the translatable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityTranslatableInput", "ofType": null }, "defaultValue": null }, { "name": "renderable", "description": "The input for enabling the renderable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityRenderableInput", "ofType": null }, "defaultValue": null }, { "name": "onlineStore", "description": "The input for enabling the Online Store capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityOnlineStoreInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilityData", "description": "Provides the capabilities of a metaobject.", "fields": [ { "name": "onlineStore", "description": "The Online Store capability for this metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilityDataOnlineStore", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishable", "description": "The publishable capability for this metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectCapabilityDataPublishable", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataInput", "description": "The input fields for metaobject capabilities.", "fields": null, "inputFields": [ { "name": "publishable", "description": "Publishable capability input.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataPublishableInput", "ofType": null }, "defaultValue": null }, { "name": "onlineStore", "description": "Online Store capability input.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataOnlineStoreInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilityDataOnlineStore", "description": "The Online Store capability for the parent metaobject.", "fields": [ { "name": "templateSuffix", "description": "The theme template used when viewing the metaobject in a store.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataOnlineStoreInput", "description": "The input fields for the Online Store capability to control renderability on the Online Store.", "fields": null, "inputFields": [ { "name": "templateSuffix", "description": "The theme template used when viewing the metaobject in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilityDataPublishable", "description": "The publishable capability for the parent metaobject.", "fields": [ { "name": "status", "description": "The visibility status of this metaobject across all channels.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetaobjectStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataPublishableInput", "description": "The input fields for publishable capability to adjust visibility on channels.", "fields": null, "inputFields": [ { "name": "status", "description": "The visibility status of this metaobject across all channels.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetaobjectStatus", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilityDefinitionDataOnlineStore", "description": "The Online Store capability data for the metaobject definition.", "fields": [ { "name": "canCreateRedirects", "description": "Flag indicating if a sufficient number of redirects are available to redirect all published entries.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlHandle", "description": "The URL handle for accessing pages of this metaobject type in the Online Store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDefinitionDataOnlineStoreInput", "description": "The input fields of the Online Store capability.", "fields": null, "inputFields": [ { "name": "urlHandle", "description": "The URL handle for accessing pages of this metaobject type in the Online Store.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "createRedirects", "description": "Whether to redirect published metaobjects automatically when the URL handle changes.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCapabilityDefinitionDataRenderable", "description": "The renderable capability data for the metaobject definition.", "fields": [ { "name": "metaDescriptionKey", "description": "The metaobject field used as an alias for the SEO page description.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaTitleKey", "description": "The metaobject field used as an alias for the SEO page title.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDefinitionDataRenderableInput", "description": "The input fields of the renderable capability for SEO aliases.", "fields": null, "inputFields": [ { "name": "metaTitleKey", "description": "The metaobject field used as an alias for the SEO page title.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "metaDescriptionKey", "description": "The metaobject field used as an alias for the SEO page description.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityOnlineStoreInput", "description": "The input fields for enabling and disabling the Online Store capability.", "fields": null, "inputFields": [ { "name": "enabled", "description": "Indicates whether the capability should be enabled or disabled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "The data associated with the Online Store capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDefinitionDataOnlineStoreInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityPublishableInput", "description": "The input fields for enabling and disabling the publishable capability.", "fields": null, "inputFields": [ { "name": "enabled", "description": "Indicates whether the capability should be enabled or disabled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityRenderableInput", "description": "The input fields for enabling and disabling the renderable capability.", "fields": null, "inputFields": [ { "name": "enabled", "description": "Indicates whether the capability should be enabled or disabled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "The data associated with the renderable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDefinitionDataRenderableInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityTranslatableInput", "description": "The input fields for enabling and disabling the translatable capability.", "fields": null, "inputFields": [ { "name": "enabled", "description": "Indicates whether the capability should be enabled or disabled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityUpdateInput", "description": "The input fields for updating a metaobject capability.", "fields": null, "inputFields": [ { "name": "publishable", "description": "The input for updating the publishable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityPublishableInput", "ofType": null }, "defaultValue": null }, { "name": "translatable", "description": "The input for updating the translatable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityTranslatableInput", "ofType": null }, "defaultValue": null }, { "name": "renderable", "description": "The input for enabling the renderable capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityRenderableInput", "ofType": null }, "defaultValue": null }, { "name": "onlineStore", "description": "The input for enabling the Online Store capability.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityOnlineStoreInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectConnection", "description": "An auto-generated type for paginating through multiple Metaobjects.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetaobjectEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Metaobject", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectCreateInput", "description": "The input fields for creating a metaobject.", "fields": null, "inputFields": [ { "name": "type", "description": "The type of the metaobject. Must match an existing metaobject definition type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "handle", "description": "A unique handle for the metaobject. This value is auto-generated when omitted.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fields", "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "capabilities", "description": "Capabilities for the metaobject.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectCreatePayload", "description": "Return type for `metaobjectCreate` mutation.", "fields": [ { "name": "metaobject", "description": "The created metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinition", "description": "Provides the definition of a generic object structure composed of metafields.", "fields": [ { "name": "access", "description": "Access configuration for the metaobject definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectAccess", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "capabilities", "description": "The capabilities of the metaobject definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectCapabilities", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdByApp", "description": "The app used to create the metaobject definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdByStaff", "description": "The staff member who created the metaobject definition.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The administrative description.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayNameKey", "description": "The key of a field to reference as the display name for each object.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fieldDefinitions", "description": "The fields defined for this object type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectFieldDefinition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasThumbnailField", "description": "Whether this metaobject definition has field whose type can visually represent a metaobject with the `thumbnailField`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjects", "description": "A paginated connection to the metaobjects associated with the definition.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectsCount", "description": "The count of metaobjects created for the definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The human-readable name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of the object definition. Defines the namespace of associated metafields.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinitionConnection", "description": "An auto-generated type for paginating through multiple MetaobjectDefinitions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectDefinitionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in MetaobjectDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectDefinitionCreateInput", "description": "The input fields for creating a metaobject definition.", "fields": null, "inputFields": [ { "name": "name", "description": "A human-readable name for the definition. This can be changed at any time.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "An administrative description of the definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "type", "description": "The type of the metaobject definition. This can't be changed.\n\nMust be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "fieldDefinitions", "description": "A set of field definitions to create on this metaobject definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionCreateInput", "ofType": null } } } }, "defaultValue": null }, { "name": "access", "description": "Access configuration for the metaobjects created with this definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectAccessInput", "ofType": null }, "defaultValue": null }, { "name": "displayNameKey", "description": "The key of a field to reference as the display name for metaobjects of this type.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "capabilities", "description": "The capabilities of the metaobject definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityCreateInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinitionCreatePayload", "description": "Return type for `metaobjectDefinitionCreate` mutation.", "fields": [ { "name": "metaobjectDefinition", "description": "The created metaobject definition.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinitionDeletePayload", "description": "Return type for `metaobjectDefinitionDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted metaobjects definition.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinitionEdge", "description": "An auto-generated type which holds one MetaobjectDefinition and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetaobjectDefinitionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectDefinitionUpdateInput", "description": "The input fields for updating a metaobject definition.", "fields": null, "inputFields": [ { "name": "name", "description": "A human-readable name for the definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "An administrative description of the definition.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fieldDefinitions", "description": "A set of operations for modifying field definitions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionOperationInput", "ofType": null } } }, "defaultValue": null }, { "name": "access", "description": "Access configuration for the metaobjects created with this definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectAccessInput", "ofType": null }, "defaultValue": null }, { "name": "displayNameKey", "description": "The key of a metafield to reference as the display name for objects of this type.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "resetFieldOrder", "description": "Whether the field order should be reset while updating.\nIf `true`, then the order is assigned based on submitted fields followed by alphabetized field omissions.\nIf `false`, then no changes are made to the existing field order and new fields are appended at the end.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "capabilities", "description": "The capabilities of the metaobject definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityUpdateInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDefinitionUpdatePayload", "description": "Return type for `metaobjectDefinitionUpdate` mutation.", "fields": [ { "name": "metaobjectDefinition", "description": "The updated metaobject definition.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectDeletePayload", "description": "Return type for `metaobjectDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted metaobject.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectEdge", "description": "An auto-generated type which holds one Metaobject and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of MetaobjectEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Metaobject", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectField", "description": "Provides a field definition and the data value assigned to it.", "fields": [ { "name": "definition", "description": "The field definition for this object key.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectFieldDefinition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The object key of this field.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reference", "description": "For resource reference fields, provides the referenced object.", "args": [], "type": { "kind": "UNION", "name": "MetafieldReference", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "references", "description": "For resource reference list fields, provides the list of referenced objects.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldReferenceConnection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "For file reference or color fields, provides visual attributes for this field.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectThumbnail", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of the field.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The assigned field value, always stored as a string regardless of the field type.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectFieldDefinition", "description": "Defines a field for a MetaobjectDefinition with properties\nsuch as the field's data type and validations.\n", "fields": [ { "name": "description", "description": "The administrative description.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "A key name used to identify the field within the metaobject composition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The human-readable name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Required status of the field within the metaobject composition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of data that the field stores.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validations", "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe field. For example, a field with the type `date` can set a minimum date requirement.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionValidation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionCreateInput", "description": "The input fields for creating a metaobject field definition.", "fields": null, "inputFields": [ { "name": "key", "description": "The key of the new field definition. This can't be changed.\n\nMust be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "type", "description": "The metafield type applied to values of the field.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "A human-readable name for the field. This can be changed at any time.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "An administrative description of the field.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "required", "description": "Whether metaobjects require a saved value for the field.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "validations", "description": "Custom validations that apply to values assigned to the field.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionValidationInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionDeleteInput", "description": "The input fields for deleting a metaobject field definition.", "fields": null, "inputFields": [ { "name": "key", "description": "The key of the field definition to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionOperationInput", "description": "The input fields for possible operations for modifying field definitions. Exactly one option is required.\n", "fields": null, "inputFields": [ { "name": "create", "description": "The input fields for creating a metaobject field definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionCreateInput", "ofType": null }, "defaultValue": null }, { "name": "update", "description": "The input fields for updating a metaobject field definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "delete", "description": "The input fields for deleting a metaobject field definition.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionDeleteInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldDefinitionUpdateInput", "description": "The input fields for updating a metaobject field definition.", "fields": null, "inputFields": [ { "name": "key", "description": "The key of the field definition to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "A human-readable name for the field.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "An administrative description of the field.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "required", "description": "Whether metaobjects require a saved value for the field.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "validations", "description": "Custom validations that apply to values assigned to the field.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionValidationInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldInput", "description": "The input fields for a metaobject field value.", "fields": null, "inputFields": [ { "name": "key", "description": "The key of the field.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The value of the field.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectHandleInput", "description": "The input fields for retrieving a metaobject by handle.", "fields": null, "inputFields": [ { "name": "type", "description": "The type of the metaobject. Must match an existing metaobject definition type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "handle", "description": "The handle of the metaobject to create or update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetaobjectStatus", "description": "Defines visibility status for metaobjects.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DRAFT", "description": "The metaobjects is an internal record.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE", "description": "The metaobjects is active for public use.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MetaobjectStorefrontAccess", "description": "Defines how the metaobjects of a definition can be accessed in Storefront API surface areas, including Liquid and the GraphQL Storefront API.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NONE", "description": "Metaobjects are not accessible in any Storefront API surface area.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC_READ", "description": "Metaobjects are accessible in the GraphQL Storefront API by any application with the `unauthenticated_read_metaobjects` access scope.\nMetaobjects are accessible in online store Liquid templates.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectThumbnail", "description": "Provides attributes for visual representation.", "fields": [ { "name": "file", "description": "The file to be used for visual representation of this metaobject.", "args": [], "type": { "kind": "INTERFACE", "name": "File", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hex", "description": "The hexadecimal color code to be used for respresenting this metaobject.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectUpdateInput", "description": "The input fields for updating a metaobject.", "fields": null, "inputFields": [ { "name": "handle", "description": "A unique handle for the metaobject.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fields", "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "capabilities", "description": "Capabilities for the metaobject.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataInput", "ofType": null }, "defaultValue": null }, { "name": "redirectNewHandle", "description": "Whether to create a redirect for the metaobject.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectUpdatePayload", "description": "Return type for `metaobjectUpdate` mutation.", "fields": [ { "name": "metaobject", "description": "The updated metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MetaobjectUpsertInput", "description": "The input fields for upserting a metaobject.", "fields": null, "inputFields": [ { "name": "handle", "description": "The handle of the metaobject.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fields", "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectFieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "capabilities", "description": "Capabilities for the metaobject.", "type": { "kind": "INPUT_OBJECT", "name": "MetaobjectCapabilityDataInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectUpsertPayload", "description": "Return type for `metaobjectUpsert` mutation.", "fields": [ { "name": "metaobject", "description": "The created or updated metaobject.", "args": [], "type": { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MetaobjectUserError", "description": "Defines errors encountered while managing metaobject resources.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "MetaobjectUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "elementIndex", "description": "The index of the failing list element in an array.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "elementKey", "description": "The key of the failing object element.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "MetaobjectUserErrorCode", "description": "Possible error codes that can be returned by `MetaobjectUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TYPE", "description": "The metafield type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE", "description": "The value is invalid for the metafield type or the definition options.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_OPTION", "description": "The value for the metafield definition option was invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_FIELD_INPUT", "description": "Duplicate inputs were provided for this field key.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNDEFINED_OBJECT_TYPE", "description": "No metaobject definition found for this type.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNDEFINED_OBJECT_FIELD", "description": "No field definition found for this key.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT_FIELD_TAKEN", "description": "The specified field key is already in use.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT_FIELD_REQUIRED", "description": "Missing required fields were found for this object.", "isDeprecated": false, "deprecationReason": null }, { "name": "RECORD_NOT_FOUND", "description": "The requested record couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "An unexpected error occurred.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAX_DEFINITIONS_EXCEEDED", "description": "The maximum number of metaobjects definitions has been exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAX_OBJECTS_EXCEEDED", "description": "The maximum number of metaobjects per shop has been exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "IMMUTABLE", "description": "The targeted object cannot be modified.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_AUTHORIZED", "description": "Not authorized.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESERVED_NAME", "description": "The provided name is reserved for system use.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_NOT_ENABLED", "description": "The capability you are using is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "URL_HANDLE_TAKEN", "description": "The Online Store URL handle is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "URL_HANDLE_INVALID", "description": "The Online Store URL handle is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "URL_HANDLE_BLANK", "description": "The Online Store URL handle cannot be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIELD_TYPE_INVALID", "description": "Renderable data input is referencing an invalid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_REQUIRED_KEYS", "description": "The input is missing required keys.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "MethodDefinitionSortKeys", "description": "The set of valid sort keys for the MethodDefinition query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RATE_PROVIDER_TYPE", "description": "Sort by the `rate_provider_type` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Model3d", "description": "Represents a Shopify hosted 3D model.\n", "fields": [ { "name": "alt", "description": "A word or phrase to share the nature or contents of a media.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "boundingBox", "description": "The 3d model's bounding box information.", "args": [], "type": { "kind": "OBJECT", "name": "Model3dBoundingBox", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "filename", "description": "The 3d model's filename.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaContentType", "description": "The media content type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaErrors", "description": "Any errors which have occurred on the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaWarnings", "description": "The warnings attached to the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalSource", "description": "The 3d model's original source.", "args": [], "type": { "kind": "OBJECT", "name": "Model3dSource", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sources", "description": "The 3d model's sources.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Model3dSource", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Current status of the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Media", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Model3dBoundingBox", "description": "Bounding box information of a 3d model.\n", "fields": [ { "name": "size", "description": "Size in meters of the smallest volume which contains the 3d model.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Vector3", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Model3dSource", "description": "A source for a Shopify-hosted 3d model.\n\nTypes of sources include GLB and USDZ formatted 3d models, where the former\nis an original 3d model and the latter has been converted from the original.\n\nIf the original source is in GLB format and over 15 MBs in size, then both the\noriginal and the USDZ formatted source are optimized to reduce the file size.\n", "fields": [ { "name": "filesize", "description": "The 3d model source's filesize.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": "The 3d model source's format.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mimeType", "description": "The 3d model source's MIME type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The 3d model source's URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Money", "description": "A monetary value string without a currency symbol or code. Example value: `\"100.57\"`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MoneyBag", "description": "A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions,\nwhen an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency).\n", "fields": [ { "name": "presentmentMoney", "description": "Amount in presentment currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopMoney", "description": "Amount in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MoneyInput", "description": "The input fields for a monetary value with currency.", "fields": null, "inputFields": [ { "name": "amount", "description": "Decimal money amount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "defaultValue": null }, { "name": "currencyCode", "description": "Currency of the money.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MoneyV2", "description": "A monetary value with currency.\n", "fields": [ { "name": "amount", "description": "Decimal money amount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "Currency of the money.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "MoveInput", "description": "The input fields for a single move of an object to a specific position in a set, using a zero-based index.\n", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the object to be moved.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "newPosition", "description": "The new position of the object in the set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Mutation", "description": "The schema's entry point for all mutation operations.", "fields": [ { "name": "abandonmentEmailStateUpdate", "description": "Updates the email state value for an abandonment.", "args": [ { "name": "id", "description": "The ID of the abandonment that needs to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "emailState", "description": "The new email state of the abandonment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AbandonmentEmailState", "ofType": null } }, "defaultValue": null }, { "name": "emailSentAt", "description": "The date and time for when the email was sent, if that is the case.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "emailStateChangeReason", "description": "The reason why the email was or was not sent.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AbandonmentEmailStateUpdatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `abandonmentUpdateActivitiesDeliveryStatuses` instead." }, { "name": "abandonmentUpdateActivitiesDeliveryStatuses", "description": "Updates the marketing activities delivery statuses for an abandonment.", "args": [ { "name": "abandonmentId", "description": "The ID of the abandonment that needs to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "marketingActivityId", "description": "The ID of the marketing activity that needs to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "deliveryStatus", "description": "The new delivery status of the marketing activity for this abandonment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "AbandonmentDeliveryState", "ofType": null } }, "defaultValue": null }, { "name": "deliveredAt", "description": "The delivery timestamp if the activity delivered.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "deliveryStatusChangeReason", "description": "The reason why the activity was or was not delivered.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AbandonmentUpdateActivitiesDeliveryStatusesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appPurchaseOneTimeCreate", "description": "Charges a shop for features or services one time.\nThis type of charge is recommended for apps that aren't billed on a recurring basis.\nTest and demo shops aren't charged.\n", "args": [ { "name": "name", "description": "The name of the one-time purchase from the app.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "price", "description": "The amount to be charged to the store for the app one-time purchase.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "returnUrl", "description": "The URL where the merchant is redirected after approving the app one-time purchase.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "test", "description": "Whether the app one-time purchase is a test transaction.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "AppPurchaseOneTimeCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appSubscriptionCancel", "description": "Cancels an app subscription on a store.", "args": [ { "name": "id", "description": "The ID of the app subscription to be cancelled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "prorate", "description": "Whether to issue prorated credits for the unused portion of the app subscription. There will\nbe a corresponding deduction (based on revenue share) to your Partner account.\nFor example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way\nthrough the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted\nfrom your Partner account.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "AppSubscriptionCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appSubscriptionCreate", "description": "Allows an app to charge a store for features or services on a recurring basis.", "args": [ { "name": "name", "description": "A descriptive name for the app subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "lineItems", "description": "Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AppSubscriptionLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "test", "description": "Whether the app subscription is a test transaction.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "trialDays", "description": "The number of days of the free trial period, beginning on the day that the merchant approves the app charges.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "returnUrl", "description": "The URL pointing to the page where the merchant is redirected after approving the app subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "replacementBehavior", "description": "The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.", "type": { "kind": "ENUM", "name": "AppSubscriptionReplacementBehavior", "ofType": null }, "defaultValue": "STANDARD" } ], "type": { "kind": "OBJECT", "name": "AppSubscriptionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appSubscriptionLineItemUpdate", "description": "Updates the capped amount on the usage pricing plan of an app subscription line item.", "args": [ { "name": "id", "description": "The ID of the app subscription line item to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "cappedAmount", "description": "The new maximum amount of usage charges that can be incurred within a subscription billing interval.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AppSubscriptionLineItemUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appSubscriptionTrialExtend", "description": "Extends the trial of an app subscription.", "args": [ { "name": "id", "description": "The ID of the app subscription to extend the trial for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "days", "description": "The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AppSubscriptionTrialExtendPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appUsageRecordCreate", "description": "Enables an app to charge a store for features or services on a per-use basis.\nThe usage charge value is counted towards the `cappedAmount` limit that was specified in the `appUsagePricingDetails` field when the app subscription was created.\nIf you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then a `Total price exceeds balance remaining` error is returned.\n", "args": [ { "name": "subscriptionLineItemId", "description": "The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "price", "description": "The price of the app usage record.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "description", "description": "The description of the app usage record.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "idempotencyKey", "description": "A unique key generated by the client to avoid duplicate charges. Maximum length of 255 characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AppUsageRecordCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bulkOperationCancel", "description": "Starts the cancelation process of a running bulk operation.\n\nThere may be a short delay from when a cancelation starts until the operation is actually canceled.\n", "args": [ { "name": "id", "description": "The ID of the bulk operation to cancel.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "BulkOperationCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bulkOperationRunMutation", "description": "Creates and runs a bulk operation mutation.\n\nTo learn how to bulk import large volumes of data asynchronously, refer to the\n[bulk import data guide](https://shopify.dev/api/usage/bulk-operations/imports).\n", "args": [ { "name": "mutation", "description": "The mutation to be executed in bulk.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "stagedUploadPath", "description": "The staged upload path of the file containing mutation variables.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "clientIdentifier", "description": "An optional identifier which may be used for querying.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "BulkOperationRunMutationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bulkOperationRunQuery", "description": "Creates and runs a bulk operation query.\n\nSee the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.\n", "args": [ { "name": "query", "description": "The query to be executed in bulk.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "BulkOperationRunQueryPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bulkProductResourceFeedbackCreate", "description": "Creates product feedback for multiple products.", "args": [ { "name": "feedbackInput", "description": "An array of inputs to create the feedback. Limited to 50.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductResourceFeedbackInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "BulkProductResourceFeedbackCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartTransformCreate", "description": "Create a CartTransform function to the Shop.", "args": [ { "name": "functionId", "description": "The identifier of the Function providing the cart transform.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "blockOnFailure", "description": "Whether a run failure should block cart and checkout operations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CartTransformCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartTransformDelete", "description": "Destroy a cart transform function from the Shop.", "args": [ { "name": "id", "description": "A globally-unique identifier for the cart transform.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CartTransformDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogContextUpdate", "description": "Updates the context of a catalog.", "args": [ { "name": "catalogId", "description": "The ID of the catalog for which to update the context.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "contextsToAdd", "description": "The contexts to add to the catalog.", "type": { "kind": "INPUT_OBJECT", "name": "CatalogContextInput", "ofType": null }, "defaultValue": null }, { "name": "contextsToRemove", "description": "The contexts to remove from the catalog.", "type": { "kind": "INPUT_OBJECT", "name": "CatalogContextInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CatalogContextUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogCreate", "description": "Creates a new catalog.", "args": [ { "name": "input", "description": "The properties of the new catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CatalogCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CatalogCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogDelete", "description": "Delete a catalog.", "args": [ { "name": "id", "description": "The ID of the catalog to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "deleteDependentResources", "description": "Whether to also delete the price list and the publication owned by the catalog.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CatalogDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogUpdate", "description": "Updates an existing catalog.", "args": [ { "name": "id", "description": "The ID of the catalog to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the updated catalog.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CatalogUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CatalogUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkoutBrandingUpsert", "description": "Updates the checkout branding settings for a\n[checkout profile](https://shopify.dev/api/admin-graphql/unstable/queries/checkoutProfile).\n\nIf the settings don't exist, then new settings are created. The checkout branding settings applied to a\npublished checkout profile will be immediately visible within the store's checkout. The checkout branding\nsettings applied to a draft checkout profile could be previewed within the admin checkout editor.\n\nTo learn more about updating checkout branding settings, refer to the checkout branding\n[tutorial](https://shopify.dev/docs/apps/checkout/styling).\n", "args": [ { "name": "checkoutProfileId", "description": "A globally-unique identifier.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "checkoutBrandingInput", "description": "The input fields to use to upsert the checkout branding settings (pass null to reset them to default).\n", "type": { "kind": "INPUT_OBJECT", "name": "CheckoutBrandingInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CheckoutBrandingUpsertPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionAddProducts", "description": "Adds products to a collection.", "args": [ { "name": "id", "description": "The ID of the collection that's being updated. This can't be a smart collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of the products that are being added to the collection.\nIf any of the products is already present in the input collection,\nthen an error is raised and no products are added.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionAddProductsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionAddProductsV2", "description": "Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled.", "args": [ { "name": "id", "description": "The ID of the collection that's being updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of the products that are being added to the collection. If the collection's sort order is manual, the products will be added in the order in which they are provided.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionAddProductsV2Payload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionCreate", "description": "Creates a collection.\n", "args": [ { "name": "input", "description": "The properties to use when creating the collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionDelete", "description": "Deletes a collection.", "args": [ { "name": "input", "description": "The collection to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionPublish", "description": "Publishes a collection to a channel.", "args": [ { "name": "input", "description": "Specify a collection to publish and the sales channels to publish it to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionPublishInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionPublishPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publishablePublish` instead." }, { "name": "collectionRemoveProducts", "description": "Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). For use with manual collections only.", "args": [ { "name": "id", "description": "The ID of the collection to remove products from. The ID must reference an existing manual collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of products to remove from the collection. The mutation doesn't validate that the products belong to the collection or whether the products exist.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionRemoveProductsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionReorderProducts", "description": "Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. Displaced products will have their position altered in a consistent manner, with no gaps.", "args": [ { "name": "id", "description": "The ID of the collection on which to reorder products.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "moves", "description": "A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the `newPosition` does not have to be unique.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoveInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionReorderProductsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionUnpublish", "description": "Unpublishes a collection.", "args": [ { "name": "input", "description": "Specify a collection to unpublish and the sales channels to remove it from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionUnpublishInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionUnpublishPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publishableUnpublish` instead." }, { "name": "collectionUpdate", "description": "Updates a collection.", "args": [ { "name": "input", "description": "The updated properties for the collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CollectionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CollectionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companiesDelete", "description": "Deletes a list of companies.", "args": [ { "name": "companyIds", "description": "A list of IDs of companies to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompaniesDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyAddressDelete", "description": "Deletes a company address.", "args": [ { "name": "addressId", "description": "The ID of the address to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyAddressDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyAssignCustomerAsContact", "description": "Assigns the customer as a company contact.", "args": [ { "name": "companyId", "description": "The ID of the company to assign the contact to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "customerId", "description": "The ID of the customer to assign as the contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyAssignCustomerAsContactPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyAssignMainContact", "description": "Assigns the main contact for the company.", "args": [ { "name": "companyId", "description": "The ID of the company to assign the main contact to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyContactId", "description": "The ID of the company contact to be assigned as the main contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyAssignMainContactPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactAssignRole", "description": "Assigns a role to a contact for a location.", "args": [ { "name": "companyContactId", "description": "The ID of the contact to assign a role to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyContactRoleId", "description": "The ID of the role to assign to a contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyLocationId", "description": "The ID of the location to assign a role to a contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactAssignRolePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactAssignRoles", "description": "Assigns roles on a company contact.", "args": [ { "name": "companyContactId", "description": "The contact whose roles are being assigned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "rolesToAssign", "description": "The new roles to assign.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyContactRoleAssign", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactAssignRolesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactCreate", "description": "Creates a company contact.", "args": [ { "name": "companyId", "description": "The ID of the company that the company contact belongs to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The fields to use to create the company contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyContactInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactDelete", "description": "Deletes a company contact.", "args": [ { "name": "companyContactId", "description": "The ID of the company contact to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactRemoveFromCompany", "description": "Removes a company contact from a Company.", "args": [ { "name": "companyContactId", "description": "The ID of the company contact to remove from the Company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactRemoveFromCompanyPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactRevokeRole", "description": "Revokes a role on a company contact.", "args": [ { "name": "companyContactId", "description": "The ID of the contact to revoke a role from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyContactRoleAssignmentId", "description": "The ID of the role assignment to revoke from a contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactRevokeRolePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactRevokeRoles", "description": "Revokes roles on a company contact.", "args": [ { "name": "companyContactId", "description": "The contact whose roles are being revoked.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "roleAssignmentIds", "description": "The current role assignment IDs to revoke.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "revokeAll", "description": "Flag to revoke all roles on the contact.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CompanyContactRevokeRolesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactSendWelcomeEmail", "description": "Sends the company contact a welcome email.", "args": [ { "name": "companyContactId", "description": "The ID of the company contact to send welcome email to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "The welcome email fields.", "type": { "kind": "INPUT_OBJECT", "name": "EmailInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactSendWelcomeEmailPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactUpdate", "description": "Updates a company contact.", "args": [ { "name": "companyContactId", "description": "The ID of the company contact to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The fields to use to update the company contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyContactInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactsDelete", "description": "Deletes one or more company contacts.", "args": [ { "name": "companyContactIds", "description": "The list of IDs of the company contacts to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyCreate", "description": "Creates a company.", "args": [ { "name": "input", "description": "The fields to use when creating the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyDelete", "description": "Deletes a company.", "args": [ { "name": "id", "description": "The ID of the company to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationAssignAddress", "description": "Updates an address on a company location.", "args": [ { "name": "locationId", "description": "The ID of the company location to update addresses on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "address", "description": "The input fields to use to update the address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "addressTypes", "description": "The list of address types on the location to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CompanyAddressType", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationAssignAddressPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationAssignRoles", "description": "Assigns roles on a company location.", "args": [ { "name": "companyLocationId", "description": "The location whose roles are being assigned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "rolesToAssign", "description": "The roles to assign.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyLocationRoleAssign", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationAssignRolesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationAssignTaxExemptions", "description": "Assigns tax exemptions to the company location.", "args": [ { "name": "companyLocationId", "description": "The location to which the tax exemptions will be assigned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxExemptions", "description": "The tax exemptions that are being assigned to the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationAssignTaxExemptionsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationCreate", "description": "Creates a company location.", "args": [ { "name": "companyId", "description": "The ID of the company that the company location belongs to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The fields to use to create the company location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyLocationInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationCreateTaxRegistration", "description": "Creates a tax registration for a company location.", "args": [ { "name": "locationId", "description": "The ID of the company location that the tax registration gets assigned to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxId", "description": "The unique tax id for the tax registration.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationCreateTaxRegistrationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationDelete", "description": "Deletes a company location.", "args": [ { "name": "companyLocationId", "description": "The ID of the company location to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationRevokeRoles", "description": "Revokes roles on a company location.", "args": [ { "name": "companyLocationId", "description": "The location whose roles are being revoked.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "rolesToRevoke", "description": "The current roles to revoke.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationRevokeRolesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationRevokeTaxExemptions", "description": "Revokes tax exemptions from the company location.", "args": [ { "name": "companyLocationId", "description": "The location from which the tax exemptions will be revoked.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxExemptions", "description": "The tax exemptions that are being revoked from the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationRevokeTaxExemptionsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationRevokeTaxRegistration", "description": "Revokes tax registration on a company location.", "args": [ { "name": "companyLocationId", "description": "The location whose tax registration is being revoked.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationRevokeTaxRegistrationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationUpdate", "description": "Updates a company location.", "args": [ { "name": "companyLocationId", "description": "The ID of the company location to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input fields to update in the company location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyLocationUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocationsDelete", "description": "Deletes a list of company locations.", "args": [ { "name": "companyLocationIds", "description": "A list of IDs of company locations to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocationsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyRevokeMainContact", "description": "Revokes the main contact from the company.", "args": [ { "name": "companyId", "description": "The ID of the company to revoke the main contact from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyRevokeMainContactPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyUpdate", "description": "Updates a company.", "args": [ { "name": "companyId", "description": "The ID of the company to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input fields to update the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CompanyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerAddTaxExemptions", "description": "Add tax exemptions for the customer.", "args": [ { "name": "customerId", "description": "The ID of the customer to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxExemptions", "description": "The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"CA_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerAddTaxExemptionsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerCancelDataErasure", "description": "Cancels a pending erasure of a customer's data.\n\nTo request an erasure of a customer's data use the [customerRequestDataErasure mutation](https://shopify.dev/api/admin-graphql/unstable/mutations/customerRequestDataErasure).\n", "args": [ { "name": "customerId", "description": "The ID of the customer for whom to cancel a pending data erasure.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerCancelDataErasurePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerCreate", "description": "Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", "args": [ { "name": "input", "description": "The input fields to create a customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerDelete", "description": "Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", "args": [ { "name": "input", "description": "Specifies the customer to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerEmailMarketingConsentUpdate", "description": "Update a customer's email marketing information information.\n", "args": [ { "name": "input", "description": "Specifies the input fields to update a customer's email marketing consent information.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerEmailMarketingConsentUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerEmailMarketingConsentUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerGenerateAccountActivationUrl", "description": "Generate an account activation URL for a customer.", "args": [ { "name": "customerId", "description": "The ID of the customer that the URL is generated for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerGenerateAccountActivationUrlPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerMerge", "description": "Merges two customers.", "args": [ { "name": "customerOneId", "description": "The ID of the first customer that will be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "customerTwoId", "description": "The ID of the second customer that will be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "overrideFields", "description": "The fields to override the default customer merge rules.", "type": { "kind": "INPUT_OBJECT", "name": "CustomerMergeOverrideFields", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerMergePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodCreateFromDuplicationData", "description": "Creates a vaulted payment method for a customer from duplication data.\n\nThis data must be obtained from another shop within the same organization.\n\nCurrently, this only supports Shop Pay payment methods. This is only available for selected partner apps.\n", "args": [ { "name": "customerId", "description": "The ID of the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingAddress", "description": "The billing address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "encryptedDuplicationData", "description": "The encrypted payment method data.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodCreateFromDuplicationDataPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodCreditCardCreate", "description": "Creates a credit card payment method for a customer using a session id.\nThese values are only obtained through card imports happening from a PCI compliant environment.\nPlease use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.\n", "args": [ { "name": "customerId", "description": "The ID of the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingAddress", "description": "The billing address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "sessionId", "description": "The Cardserver session ID. Obtained by storing card data with Shopify's Cardsink. Exchanging raw card data for a session ID must be done in a PCI complaint environment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodCreditCardCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodCreditCardUpdate", "description": "Updates the credit card payment method for a customer.", "args": [ { "name": "id", "description": "The ID of the customer payment method.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingAddress", "description": "The billing address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "sessionId", "description": "The Cardserver session ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodCreditCardUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodGetDuplicationData", "description": "Returns encrypted data that can be used to duplicate the payment method in another shop within the same organization.\n\nCurrently, this only supports Shop Pay payment methods. This is only available for selected partner apps.\n", "args": [ { "name": "customerPaymentMethodId", "description": "The payment method to be duplicated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "targetShopId", "description": "The shop the payment method will be duplicated into.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "targetCustomerId", "description": "The customer the payment method will be duplicated into.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodGetDuplicationDataPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodGetUpdateUrl", "description": "Returns a URL that allows the customer to update a specific payment method.\n\nCurrently, `customerPaymentMethodGetUpdateUrl` only supports Shop Pay.\n", "args": [ { "name": "customerPaymentMethodId", "description": "The payment method to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodGetUpdateUrlPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodPaypalBillingAgreementCreate", "description": "Creates a PayPal billing agreement for a customer.", "args": [ { "name": "customerId", "description": "The ID of the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingAddress", "description": "The billing address.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "billingAgreementId", "description": "The billing agreement ID from PayPal that starts with 'B-' (for example, `B-1234XXXXX`).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "inactive", "description": "Whether the PayPal billing agreement is inactive.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodPaypalBillingAgreementCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodPaypalBillingAgreementUpdate", "description": "Updates a PayPal billing agreement for a customer.", "args": [ { "name": "id", "description": "The ID of the customer payment method.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingAddress", "description": "The billing address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodPaypalBillingAgreementUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodRemoteCreate", "description": "Create a payment method from remote gateway identifiers.", "args": [ { "name": "customerId", "description": "The ID of the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "remoteReference", "description": "Remote gateway payment method details.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerPaymentMethodRemoteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodRemoteCreditCardCreate", "description": "Create a payment method from a credit card stored by Stripe.", "args": [ { "name": "customerId", "description": "The ID of the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "stripeCustomerId", "description": "The Stripe Customer ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "stripePaymentMethodId", "description": "The Stripe Payment Method ID.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodRemoteCreditCardCreatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerPaymentMethodRemoteCreate` instead." }, { "name": "customerPaymentMethodRevoke", "description": "Revokes a customer's payment method.", "args": [ { "name": "customerPaymentMethodId", "description": "The ID of the customer payment method to be revoked.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodRevokePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethodSendUpdateEmail", "description": "Sends a link to the customer so they can update a specific payment method.", "args": [ { "name": "customerPaymentMethodId", "description": "The payment method to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "Specifies the payment method update email fields.", "type": { "kind": "INPUT_OBJECT", "name": "EmailInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethodSendUpdateEmailPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerRemoveTaxExemptions", "description": "Remove tax exemptions from a customer.", "args": [ { "name": "customerId", "description": "The ID of the customer to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxExemptions", "description": "The list of tax exemptions to remove for the customer, in the format of an array or a comma-separated list. Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"A_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerRemoveTaxExemptionsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerReplaceTaxExemptions", "description": "Replace tax exemptions for a customer.", "args": [ { "name": "customerId", "description": "The ID of the customer to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "taxExemptions", "description": "The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list.\n Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"A_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxExemption", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerReplaceTaxExemptionsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerRequestDataErasure", "description": "Enqueues a request to erase customer's data. Read more [here](https://help.shopify.com/manual/privacy-and-security/privacy/processing-customer-data-requests#erase-customer-personal-data).\n\nTo cancel the data erasure request use the [customerCancelDataErasure mutation](https://shopify.dev/api/admin-graphql/unstable/mutations/customerCancelDataErasure).\n", "args": [ { "name": "customerId", "description": "The ID of the customer to erase.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerRequestDataErasurePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSegmentMembersQueryCreate", "description": "Creates a customer segment members query.", "args": [ { "name": "input", "description": "The input fields to create a customer segment members query.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerSegmentMembersQueryInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerSegmentMembersQueryCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSmsMarketingConsentUpdate", "description": "Update a customer's SMS marketing consent information.\n", "args": [ { "name": "input", "description": "Specifies the input fields to update a customer's SMS marketing consent information.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerSmsMarketingConsentUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerSmsMarketingConsentUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerUpdate", "description": "Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", "args": [ { "name": "input", "description": "Provides updated fields for the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerUpdateDefaultAddress", "description": "Updates a customer's default address.", "args": [ { "name": "customerId", "description": "The ID of the customer whose default address is being updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "addressId", "description": "The ID of the customer's new default address.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerUpdateDefaultAddressPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "delegateAccessTokenCreate", "description": "Creates a delegate access token.\n\nTo learn more about creating delegate access tokens, refer to\n[Delegate OAuth access tokens to subsystems]\n(https://shopify.dev/apps/auth/oauth/delegate-access-tokens).\n", "args": [ { "name": "input", "description": "The input fields for creating a delegate access token.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DelegateAccessTokenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DelegateAccessTokenCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "delegateAccessTokenDestroy", "description": "Destroys a delegate access token.", "args": [ { "name": "accessToken", "description": "Provides the delegate access token to destroy.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DelegateAccessTokenDestroyPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomizationActivation", "description": "Activates and deactivates delivery customizations.", "args": [ { "name": "ids", "description": "The global IDs of the delivery customizations.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "enabled", "description": "The enabled status of the delivery customizations.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCustomizationActivationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomizationCreate", "description": "Creates a delivery customization.", "args": [ { "name": "deliveryCustomization", "description": "The input data used to create the delivery customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryCustomizationInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCustomizationCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomizationDelete", "description": "Creates a delivery customization.", "args": [ { "name": "id", "description": "The global ID of the delivery customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCustomizationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomizationUpdate", "description": "Updates a delivery customization.", "args": [ { "name": "id", "description": "The global ID of the delivery customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "deliveryCustomization", "description": "The input data used to update the delivery customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryCustomizationInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCustomizationUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfileCreate", "description": "Create a delivery profile.", "args": [ { "name": "profile", "description": "Specifies the input fields for a delivery profile.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProfileInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "deliveryProfileCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfileRemove", "description": "Enqueue the removal of a delivery profile.", "args": [ { "name": "id", "description": "The ID of the delivery profile to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "deliveryProfileRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfileUpdate", "description": "Update a delivery profile.", "args": [ { "name": "id", "description": "The ID of the delivery profile to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "profile", "description": "Specifies the input fields for a delivery profile.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryProfileInput", "ofType": null } }, "defaultValue": null }, { "name": "leaveLegacyModeProfiles", "description": "Whether this delivery profile should leave legacy mode.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "deliveryProfileUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliverySettingUpdate", "description": "Set the delivery settings for a shop.", "args": [ { "name": "setting", "description": "Specifies the input fields for the delivery shop level settings.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliverySettingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliverySettingUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryShippingOriginAssign", "description": "Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.\n", "args": [ { "name": "locationId", "description": "The ID of the location to assign as the shipping origin.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryShippingOriginAssignPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticActivate", "description": "Activates an automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to activate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticAppCreate", "description": "Creates an app discount.", "args": [ { "name": "automaticAppDiscount", "description": "The input data used to create the app discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticAppInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticAppCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticAppUpdate", "description": "Updates an automatic app discount.", "args": [ { "name": "id", "description": "The ID of the automatic app discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "automaticAppDiscount", "description": "The input fields required to update the automatic app discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticAppInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticAppUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticBasicCreate", "description": "Creates a basic automatic discount.", "args": [ { "name": "automaticBasicDiscount", "description": "The input data used to create the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBasicInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticBasicCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticBasicUpdate", "description": "Updates a basic automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "automaticBasicDiscount", "description": "The input data used to update the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBasicInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticBasicUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticBulkDelete", "description": "Asynchronously delete automatic discounts in bulk if a `search` or `saved_search_id` argument is provided or if a\nmaximum discount threshold is reached (1,000). Otherwise, deletions will occur inline.\n**Warning:** All automatic discounts will be deleted if a blank `search` argument is provided.\n", "args": [ { "name": "search", "description": "The search query for filtering automatic discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [AutomaticDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/automaticDiscountNodes#argument-automaticdiscountnodes-query).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the saved search to use for filtering automatic discounts to delete.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the automatic discounts to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticBxgyCreate", "description": "Creates a BXGY automatic discount.", "args": [ { "name": "automaticBxgyDiscount", "description": "The input data used to create the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBxgyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticBxgyCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticBxgyUpdate", "description": "Updates an existing Buy X, Get Y (BXGY) automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "automaticBxgyDiscount", "description": "The input data used to update the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticBxgyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticBxgyUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticDeactivate", "description": "Deactivates an automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to deactivate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticDeactivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticDelete", "description": "Deletes an automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticFreeShippingCreate", "description": "Creates a free shipping automatic discount.", "args": [ { "name": "freeShippingAutomaticDiscount", "description": "The input data used to create the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticFreeShippingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticFreeShippingCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAutomaticFreeShippingUpdate", "description": "Updates a free shipping automatic discount.", "args": [ { "name": "id", "description": "The ID of the automatic discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "freeShippingAutomaticDiscount", "description": "The input data used to update the automatic discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountAutomaticFreeShippingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticFreeShippingUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeActivate", "description": "Activates a code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to activate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeAppCreate", "description": "Creates a code app discount.", "args": [ { "name": "codeAppDiscount", "description": "The input data used to create the app discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeAppInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeAppCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeAppUpdate", "description": "Updates a code app discount.", "args": [ { "name": "id", "description": "The ID of the code app discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "codeAppDiscount", "description": "The input fields required to update the code app discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeAppInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeAppUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBasicCreate", "description": "Creates a basic code discount.", "args": [ { "name": "basicCodeDiscount", "description": "The input data used to create the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeBasicInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBasicCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBasicUpdate", "description": "Updates a basic code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "basicCodeDiscount", "description": "The input data used to update the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeBasicInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBasicUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBulkActivate", "description": "Asynchronously activate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", "args": [ { "name": "search", "description": "The search query for filtering code discounts.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the saved search.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the code discounts to activate.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBulkActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBulkDeactivate", "description": "Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", "args": [ { "name": "search", "description": "The search query for filtering code discounts.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the saved search.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the code discounts to deactivate.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBulkDeactivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBulkDelete", "description": "Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", "args": [ { "name": "search", "description": "The search query for filtering code discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the saved search to use for filtering code discounts to delete.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the code discounts to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBxgyCreate", "description": "Creates a Buy X get Y (BXGY) code discount.", "args": [ { "name": "bxgyCodeDiscount", "description": "The input data used to create the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeBxgyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBxgyCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeBxgyUpdate", "description": "Updates a Buy X, Get Y (BXGY) code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "bxgyCodeDiscount", "description": "The input data used to update the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeBxgyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeBxgyUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeDeactivate", "description": "Deactivates a code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to deactivate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeDeactivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeDelete", "description": "Deletes a code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeFreeShippingCreate", "description": "Creates a free shipping code discount.", "args": [ { "name": "freeShippingCodeDiscount", "description": "The input data used to create the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeFreeShippingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeFreeShippingCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeFreeShippingUpdate", "description": "Updates a free shipping code discount.", "args": [ { "name": "id", "description": "The ID of the code discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "freeShippingCodeDiscount", "description": "The input data used to update the code discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountCodeFreeShippingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeFreeShippingUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodeRedeemCodeBulkDelete", "description": "Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a\nsearch query, a saved search ID, or a list of redeem code IDs.\n", "args": [ { "name": "discountId", "description": "The ID of the redeem code's discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "search", "description": "The search query for filtering discount redeem codes.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the saved search.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the discount redeem codes to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeRedeemCodeBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountRedeemCodeBulkAdd", "description": "Asynchronously add discount redeem codes in bulk. Specify the codes to add\nand the discount code ID that the codes will belong to.\n", "args": [ { "name": "discountId", "description": "The ID of the code discount that the codes will be added to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "codes", "description": "The list of codes that will be added to the code discount. Maximum 100 codes permitted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DiscountRedeemCodeInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "disputeEvidenceUpdate", "description": "Updates a dispute evidence.", "args": [ { "name": "id", "description": "The ID of the dispute evidence to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The updated properties for a dispute evidence.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeEvidenceUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DisputeEvidenceUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderBulkAddTags", "description": "Adds tags to multiple draft orders.", "args": [ { "name": "search", "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the draft order saved search for filtering draft orders on.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the draft orders to add tags to.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "tags", "description": "List of tags to be added.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderBulkAddTagsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderBulkDelete", "description": "Deletes multiple draft orders.", "args": [ { "name": "search", "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the draft order saved search for filtering draft orders on.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the draft orders to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderBulkRemoveTags", "description": "Removes tags from multiple draft orders.", "args": [ { "name": "search", "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of the draft order saved search for filtering draft orders on.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "The IDs of the draft orders to remove tags from.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "tags", "description": "List of tags to be removed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderBulkRemoveTagsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderCalculate", "description": "Calculates the properties of a draft order. Useful for determining information\nsuch as total taxes or price without actually creating a draft order.\n", "args": [ { "name": "input", "description": "The fields for the draft order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DraftOrderInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderCalculatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderComplete", "description": "Completes a draft order and creates an order.", "args": [ { "name": "id", "description": "The draft order to complete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentPending", "description": "Whether the payment is pending.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "paymentGatewayId", "description": "The gateway for the completed draft order.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "sourceName", "description": "A channel definition handle used for sales channel attribution.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderCompletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderCreate", "description": "Creates a draft order.", "args": [ { "name": "input", "description": "The fields used to create the draft order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DraftOrderInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderCreateFromOrder", "description": "Creates a Draft Order from Order.", "args": [ { "name": "orderId", "description": "Specifies the Order's id that we create the Draft Order from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderCreateFromOrderPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderCreateMerchantCheckout", "description": "Creates a merchant checkout for the given draft order.", "args": [ { "name": "id", "description": "Specifies the Draft order's id that we create the checkout for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderCreateMerchantCheckoutPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderDelete", "description": "Deletes a draft order.", "args": [ { "name": "input", "description": "Specify the draft order to delete by its ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DraftOrderDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderDuplicate", "description": "Duplicates a draft order.", "args": [ { "name": "id", "description": "The ID of the draft order to duplicate.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderDuplicatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderInvoicePreview", "description": "Previews a draft order invoice email.", "args": [ { "name": "id", "description": "Specifies the draft order invoice email to preview.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "Specifies the draft order invoice email fields.", "type": { "kind": "INPUT_OBJECT", "name": "EmailInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderInvoicePreviewPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderInvoiceSend", "description": "Sends an email invoice for a draft order.", "args": [ { "name": "id", "description": "Specifies the draft order to send the invoice for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "Specifies the draft order invoice email fields.", "type": { "kind": "INPUT_OBJECT", "name": "EmailInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderInvoiceSendPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderUpdate", "description": "Updates a draft order.\n\nIf a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts\nare created but not immediately completed when opening the merchant credit card modal in the admin, and when a\nbuyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress\nand the draft is updated before the checkout completes. This will not interfere with the checkout and order\ncreation, but if the link from draft to checkout is broken the draft will remain open even after the order is\ncreated.\n", "args": [ { "name": "id", "description": "Specifies the draft order to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The draft order properties to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DraftOrderInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "eventBridgeServerPixelUpdate", "description": "Updates the server pixel to connect to an EventBridge endpoint.\nRunning this mutation deletes any previous subscriptions for the server pixel.\n", "args": [ { "name": "arn", "description": "The ARN for the EventBridge endpoint to which customer events are to be sent.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ARN", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "EventBridgeServerPixelUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "eventBridgeWebhookSubscriptionCreate", "description": "Creates a new Amazon EventBridge webhook subscription.\n", "args": [ { "name": "topic", "description": "The type of event that triggers the webhook.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "ofType": null } }, "defaultValue": null }, { "name": "subTopic", "description": "An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to [sub-topics](https://shopify.dev/docs/apps/webhooks/sub-topics) for more.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for an EventBridge webhook subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EventBridgeWebhookSubscriptionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "EventBridgeWebhookSubscriptionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "eventBridgeWebhookSubscriptionUpdate", "description": "Updates an Amazon EventBridge webhook subscription.\n", "args": [ { "name": "id", "description": "The ID of the webhook subscription to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for an EventBridge webhook subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EventBridgeWebhookSubscriptionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "EventBridgeWebhookSubscriptionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileAcknowledgeUpdateFailed", "description": "Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors.", "args": [ { "name": "fileIds", "description": "Specifies the file(s) to acknowledge the failed updates of.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FileAcknowledgeUpdateFailedPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileCreate", "description": "Creates file assets using an external URL or for files that were previously uploaded using the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\nThese files are added to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin.\n", "args": [ { "name": "files", "description": "List of new files to be created.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FileCreateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FileCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileDelete", "description": "Deletes existing file assets that were uploaded to Shopify.", "args": [ { "name": "fileIds", "description": "The IDs of the files to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FileDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileUpdate", "description": "Updates an existing file asset that was uploaded to Shopify.", "args": [ { "name": "files", "description": "List of files to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FileUpdateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FileUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "flowGenerateSignature", "description": "Generates a signature for a Flow action payload.", "args": [ { "name": "id", "description": "The unique identifier of the Flow action definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "payload", "description": "The request payload used to generate the signature.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FlowGenerateSignaturePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "flowTriggerReceive", "description": "Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers).", "args": [ { "name": "handle", "description": "The handle of the trigger.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "payload", "description": "The payload needed to run the Trigger.", "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FlowTriggerReceivePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentCancel", "description": "Cancels a fulfillment.", "args": [ { "name": "id", "description": "The ID of the fulfillment to be canceled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentConstraintRuleCreate", "description": "Creates a fulfillment constraint rule and its metafield.", "args": [ { "name": "functionId", "description": "The identifier of the function providing the constraint rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "metafields", "description": "Metafields to associate to the fulfillment constraint rule.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" } ], "type": { "kind": "OBJECT", "name": "FulfillmentConstraintRuleCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentConstraintRuleDelete", "description": "Deletes a fulfillment constraint rule and its metafields.", "args": [ { "name": "id", "description": "A globally-unique identifier for the fulfillment constraint rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentConstraintRuleDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentCreateV2", "description": "Creates a fulfillment for one or many fulfillment orders.\nThe fulfillment orders are associated with the same order and are assigned to the same location.\n", "args": [ { "name": "fulfillment", "description": "The input fields used to create a fulfillment from fulfillment orders.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentV2Input", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional message for the fulfillment request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentCreateV2Payload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentEventCreate", "description": "Creates a fulfillment event for a specified fulfillment.", "args": [ { "name": "fulfillmentEvent", "description": "The input fields used to create a fulfillment event for a fulfillment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentEventInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentEventCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderAcceptCancellationRequest", "description": "Accept a cancellation request sent to a fulfillment service for a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with the cancellation request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional reason for accepting the cancellation request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderAcceptCancellationRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderAcceptFulfillmentRequest", "description": "Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with the fulfillment request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional reason for accepting the fulfillment request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderAcceptFulfillmentRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderCancel", "description": "Marks a fulfillment order as canceled.", "args": [ { "name": "id", "description": "The ID of the fulfillment order to mark as canceled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderClose", "description": "Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order to mark as incomplete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional reason for marking the fulfillment order as incomplete.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderClosePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderHold", "description": "Applies a fulfillment hold on an open fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order on which a fulfillment hold is applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "fulfillmentHold", "description": "The details of the fulfillment hold applied on the fulfillment order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderHoldInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderHoldPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderLineItemsPreparedForPickup", "description": "Mark line items associated with a fulfillment order as being ready for pickup by a customer.\n\nSends a Ready For Pickup notification to the customer to let them know that their order is ready\nto be picked up.\n", "args": [ { "name": "input", "description": "The input for marking fulfillment order line items as ready for pickup.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderLineItemsPreparedForPickupPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderMerge", "description": "Merges a set or multiple sets of fulfillment orders together into one based on\nline item inputs and quantities.\n", "args": [ { "name": "fulfillmentOrderMergeInputs", "description": "One or more sets of fulfillment orders to be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderMergeInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderMergePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderMove", "description": "Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.\n\nMoving a fulfillment order will fail in the following circumstances:\n\n* The fulfillment order is closed.\n* The destination location has never stocked the requested inventory item.\n* The API client doesn't have the correct permissions.\n\nLine items which have already been fulfilled can't be re-assigned\nand will always remain assigned to the original location.\n\nYou can't change the assigned location while a fulfillment order has a\n[request status](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus)\nof `SUBMITTED`, `ACCEPTED`, `CANCELLATION_REQUESTED`, or `CANCELLATION_REJECTED`.\nThese request statuses mean that a fulfillment order is awaiting action by a fulfillment service\nand can't be re-assigned without first having the fulfillment service accept a cancellation request.\nThis behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.\n\n### How re-assigning line items affects fulfillment orders\n\n**First scenario:** Re-assign all line items belonging to a fulfillment order to a new location.\n\nIn this case, the\n[assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation)\nof the original fulfillment order will be updated to the new location.\n\n**Second scenario:** Re-assign a subset of the line items belonging to a fulfillment order to a new location.\nYou can specify a subset of line items using the `fulfillmentOrderLineItems` parameter\n(available as of the `2023-04` API version),\nor specify that the original fulfillment order contains line items which have already been fulfilled.\n\nIf the new location is already assigned to another active fulfillment order, on the same order, then\na new fulfillment order is created. The existing fulfillment order is closed and line items are recreated\nin a new fulfillment order.\n", "args": [ { "name": "id", "description": "The ID of the fulfillment order to be moved.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "newLocationId", "description": "The ID of the location where the fulfillment order will be moved.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be moved.\nIf left blank, all unfulfilled line items belonging to the fulfillment order are moved.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderMovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderOpen", "description": "Marks a scheduled fulfillment order as open.", "args": [ { "name": "id", "description": "The ID of the fulfillment order to mark as open.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderOpenPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderRejectCancellationRequest", "description": "Rejects a cancellation request sent to a fulfillment service for a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with the cancellation request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional reason for rejecting the cancellation request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderRejectCancellationRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderRejectFulfillmentRequest", "description": "Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with the fulfillment request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "reason", "description": "The reason for the fulfillment order rejection.", "type": { "kind": "ENUM", "name": "FulfillmentOrderRejectionReason", "ofType": null }, "defaultValue": null }, { "name": "message", "description": "An optional reason for rejecting the fulfillment request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lineItems", "description": "An optional array of line item rejection details. If none are provided, all line items will be assumed to be unfulfillable.\n\n**Note**: After the fulfillment request has been rejected, none of the line items will be able to be fulfilled. This field documents which line items specifically were unable to be fulfilled and why.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "IncomingRequestLineItemInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderRejectFulfillmentRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderReleaseHold", "description": "Releases the fulfillment hold on a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order for which to release the fulfillment hold.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "externalId", "description": "A configurable ID used to track the automation system releasing this hold.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderReleaseHoldPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderReschedule", "description": "Reschedules a scheduled fulfillment order.\n\nUpdates the value of the `fulfillAt` field on a scheduled fulfillment order.\n\nThe fulfillment order will be marked as ready for fulfillment at this date and time.\n", "args": [ { "name": "id", "description": "The ID of the fulfillment order to reschedule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "fulfillAt", "description": "A future date and time when the fulfillment order will be marked as ready for fulfillment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderReschedulePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderSplit", "description": "Splits a fulfillment order or orders based on line item inputs and quantities.", "args": [ { "name": "fulfillmentOrderSplits", "description": "The fulfillment orders, line items and quantities to be split into new fulfillment orders.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderSplitInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderSplitPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderSubmitCancellationRequest", "description": "Sends a cancellation request to the fulfillment service of a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with the cancellation request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional reason for the cancellation request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderSubmitCancellationRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrderSubmitFulfillmentRequest", "description": "Sends a fulfillment request to the fulfillment service of a fulfillment order.", "args": [ { "name": "id", "description": "The ID of the fulfillment order associated with fulfillment request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "An optional message for the fulfillment request.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether the customer should be notified when fulfillments are created for this fulfillment order.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "fulfillmentOrderLineItems", "description": "The fulfillment order line items to be requested for fulfillment.\nIf left blank, all line items of the fulfillment order are requested for fulfillment.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentOrderLineItemInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrderSubmitFulfillmentRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrdersReleaseHolds", "description": "Releases the fulfillment holds on a list of fulfillment orders.", "args": [ { "name": "ids", "description": "The IDs of the fulfillment orders for which to release the fulfillment holds.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "externalId", "description": "A configurable ID used to track the automation system releasing these holds.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrdersReleaseHoldsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrdersSetFulfillmentDeadline", "description": "Sets the latest date and time by which the fulfillment orders need to be fulfilled.", "args": [ { "name": "fulfillmentOrderIds", "description": "The IDs of the fulfillment orders for which the deadline is being set.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "fulfillmentDeadline", "description": "The new fulfillment deadline of the fulfillment orders.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrdersSetFulfillmentDeadlinePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentServiceCreate", "description": "Creates a fulfillment service.\n\n## Fulfillment service location\n\nWhen creating a fulfillment service, a new location will be automatically created on the shop\nand will be associated with this fulfillment service.\nThis location will be named after the fulfillment service and inherit the shop's address.\n\nIf you are using API version `2023-10` or later, and you need to specify custom attributes for the fulfillment service location\n(for example, to change its address to a country different from the shop's country),\nuse the\n[LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit)\nmutation after creating the fulfillment service.\n", "args": [ { "name": "name", "description": "The name of the fulfillment service.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "callbackUrl", "description": "The URL to send requests for the fulfillment service. The following considerations apply:\n\n- Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the callback_url/fulfillment_order_notification endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null }, { "name": "trackingSupport", "description": "Whether the fulfillment service provides tracking numbers for packages.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "permitsSkuSharing", "description": "Whether the fulfillment service can stock inventory alongside other locations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "inventoryManagement", "description": "Whether the fulfillment service manages product inventory and provides updates to Shopify.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "FulfillmentServiceCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentServiceDelete", "description": "Deletes a fulfillment service.", "args": [ { "name": "id", "description": "The ID of the fulfillment service to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "destinationLocationId", "description": "The ID of the location where inventory and commitments will be relocated\nafter the fulfillment service is deleted.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentServiceDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentServiceUpdate", "description": "Updates a fulfillment service.\n\nIf you are using API version `2023-10` or later,\nand you need to update the location managed by the fulfillment service\n(for example, to change the address of a fulfillment service),\nuse the\n[LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit)\nmutation.\n", "args": [ { "name": "id", "description": "The id of the fulfillment service.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The name of the fulfillment service.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "callbackUrl", "description": "The URL to send requests for the fulfillment service. The following considerations apply:\n\n- Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the callback_url/fulfillment_order_notification endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "trackingSupport", "description": "Whether the fulfillment service provides tracking numbers for packages.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "permitsSkuSharing", "description": "Whether the fulfillment service can stock inventory alongside other locations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "inventoryManagement", "description": "Whether the fulfillment service tracks product inventory and provides updates to Shopify.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentServiceUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentTrackingInfoUpdateV2", "description": "Updates tracking information for a fulfillment.", "args": [ { "name": "fulfillmentId", "description": "The ID of the fulfillment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "trackingInfoInput", "description": "The tracking input for the mutation, including tracking URL, number, and company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "FulfillmentTrackingInput", "ofType": null } }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether the customer will be notified of this update and future updates for the fulfillment.\nIf this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentTrackingInfoUpdateV2Payload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardCreate", "description": "Create a gift card.", "args": [ { "name": "input", "description": "The input fields to create a gift card.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "GiftCardCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCardCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardDisable", "description": "Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled.\n", "args": [ { "name": "id", "description": "The ID of the gift card to disable.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCardDisablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardUpdate", "description": "Update a gift card.", "args": [ { "name": "id", "description": "The ID of the gift card to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input fields to update the gift card.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "GiftCardUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCardUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryActivate", "description": "Activate an inventory item at a location.", "args": [ { "name": "inventoryItemId", "description": "The ID of the inventory item to activate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the location of the inventory item being activated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "available", "description": "The initial available quantity of the inventory item being activated at the location.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "onHand", "description": "The initial on_hand quantity of the inventory item being activated at the location.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryAdjustQuantities", "description": "Apply changes to inventory quantities.", "args": [ { "name": "input", "description": "The information required to adjust inventory quantities.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryAdjustQuantitiesInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryAdjustQuantitiesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryBulkToggleActivation", "description": "Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item's quantities and turns off the inventory item from that location.", "args": [ { "name": "inventoryItemId", "description": "The ID of the inventory item to modify the activation status locations for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "inventoryItemUpdates", "description": "A list of pairs of locations and activate status to update for the specified inventory item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryBulkToggleActivationInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryBulkToggleActivationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryDeactivate", "description": "Removes an inventory item's quantities from a location, and turns off inventory at the location.", "args": [ { "name": "inventoryLevelId", "description": "The ID of the inventory level to deactivate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryDeactivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItemUpdate", "description": "Updates an inventory item.", "args": [ { "name": "id", "description": "The ID of the inventory item to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input fields that update an\n[`inventoryItem`](https://shopify.dev/api/admin-graphql/latest/queries/inventoryitem).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryItemUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryItemUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryMoveQuantities", "description": "Moves inventory between inventory quantity names at a single location.", "args": [ { "name": "input", "description": "The information required to move inventory quantities.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryMoveQuantitiesInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryMoveQuantitiesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventorySetOnHandQuantities", "description": "Set inventory on-hand quantities using absolute values.", "args": [ { "name": "input", "description": "The information required to set inventory on hand quantities.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventorySetOnHandQuantitiesInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventorySetOnHandQuantitiesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventorySetScheduledChanges", "description": "Set up scheduled changes of inventory items.\n", "args": [ { "name": "input", "description": "The input fields for setting up scheduled changes of inventory items.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventorySetScheduledChangesInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventorySetScheduledChangesPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationActivate", "description": "Activates a location.", "args": [ { "name": "locationId", "description": "The ID of a location to activate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationAdd", "description": "Adds a new location.", "args": [ { "name": "input", "description": "The properties of the location to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "LocationAddInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationDeactivate", "description": "Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location.", "args": [ { "name": "locationId", "description": "The ID of a location to deactivate.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "destinationLocationId", "description": "The ID of a destination location to which inventory, pending orders and moving transfers will be moved from the location to deactivate.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationDeactivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationDelete", "description": "Deletes a location.", "args": [ { "name": "locationId", "description": "The ID of a location to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationEdit", "description": "Edits an existing location.\n\n[As of the 2023-10 API version](https://shopify.dev/changelog/apps-can-now-change-the-name-and-address-of-their-fulfillment-service-locations), apps can change the name and address of their fulfillment service locations.\n", "args": [ { "name": "id", "description": "The ID of a location to edit.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The updated properties for the location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "LocationEditInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationEditPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationLocalPickupDisable", "description": "Disables local pickup for a location.", "args": [ { "name": "locationId", "description": "The ID of the location to disable local pickup for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationLocalPickupDisablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationLocalPickupEnable", "description": "Enables local pickup for a location.", "args": [ { "name": "localPickupSettings", "description": "The settings required to enable local pickup for a location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DeliveryLocationLocalPickupEnableInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "LocationLocalPickupEnablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketCreate", "description": "Creates a new market.", "args": [ { "name": "input", "description": "The properties of the new market.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketCurrencySettingsUpdate", "description": "Updates currency settings of a market.", "args": [ { "name": "marketId", "description": "The ID of the market definition to target.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "Properties to update for the market currency settings.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketCurrencySettingsUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketCurrencySettingsUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketDelete", "description": "Deletes a market definition.", "args": [ { "name": "id", "description": "The ID of the market to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizationsRegister", "description": "Creates or updates market localizations.", "args": [ { "name": "resourceId", "description": "The ID of the resource that is being localized within the context of a market.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "marketLocalizations", "description": "The input fields for a market localization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketLocalizationRegisterInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketLocalizationsRegisterPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizationsRemove", "description": "Deletes market localizations.", "args": [ { "name": "resourceId", "description": "The ID of the resource for which market localizations are being deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "marketLocalizationKeys", "description": "The list of market localization keys.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null }, { "name": "marketIds", "description": "The list of market IDs.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketLocalizationsRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketRegionDelete", "description": "Deletes a market region.", "args": [ { "name": "id", "description": "The ID of the market region to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketRegionDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketRegionsCreate", "description": "Creates regions that belong to an existing market.", "args": [ { "name": "marketId", "description": "The ID of the market to add the regions to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "regions", "description": "The regions to be created.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketRegionCreateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketRegionsCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketRegionsDelete", "description": "Deletes a list of market regions.", "args": [ { "name": "ids", "description": "A list of IDs of the market regions to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketRegionsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketUpdate", "description": "Updates the properties of a market.", "args": [ { "name": "id", "description": "The ID of the market to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketWebPresenceCreate", "description": "Creates a web presence for a market.", "args": [ { "name": "marketId", "description": "The ID of the market for which to create a web presence.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webPresence", "description": "The details of the web presence to be created.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketWebPresenceCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketWebPresenceCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketWebPresenceDelete", "description": "Deletes a market web presence.", "args": [ { "name": "webPresenceId", "description": "The ID of the web presence to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketWebPresenceDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketWebPresenceUpdate", "description": "Updates a market web presence.", "args": [ { "name": "webPresenceId", "description": "The ID of the web presence to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webPresence", "description": "The web_presence fields used to update the market's web presence.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketWebPresenceUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketWebPresenceUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivitiesDeleteAllExternal", "description": "Deletes all external marketing activities. Deletion is performed by a background job, as it may take a bit of time to complete if a large number of activities are to be deleted. Attempting to create or modify external activities before the job has completed will result in the create/update/upsert mutation returning an error.", "args": [], "type": { "kind": "OBJECT", "name": "MarketingActivitiesDeleteAllExternalPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityCreate", "description": "Create new marketing activity.", "args": [ { "name": "input", "description": "The Input of marketing activity create.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingActivityCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityCreateExternal", "description": "Creates a new external marketing activity.", "args": [ { "name": "input", "description": "The input field for creating an external marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingActivityCreateExternalInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityCreateExternalPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityDeleteExternal", "description": "Deletes an external marketing activity.", "args": [ { "name": "marketingActivityId", "description": "The ID of the marketing activity. A marketing activity ID or remote ID must be provided.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "remoteId", "description": "The ID of an activity that's hosted outside of Shopify. A marketing activity ID or remote ID must be provided.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityDeleteExternalPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityUpdate", "description": "Updates a marketing activity with the latest information.", "args": [ { "name": "input", "description": "The Input of the marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityUpdateExternal", "description": "Update an external marketing activity.", "args": [ { "name": "input", "description": "The input field for updating an external marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpdateExternalInput", "ofType": null } }, "defaultValue": null }, { "name": "marketingActivityId", "description": "The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "remoteId", "description": "The ID of an activity that's hosted outside of Shopify. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "utm", "description": "Specifies the [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) that are associated with a related marketing campaign. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityUpdateExternalPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivityUpsertExternal", "description": "Creates a new external marketing activity or updates an existing one. When optional fields are absent or null, associated information will be removed from an existing marketing activity.", "args": [ { "name": "input", "description": "The input field for creating or updating an external marketing activity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingActivityUpsertExternalInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivityUpsertExternalPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEngagementCreate", "description": "Creates a new marketing engagement for a marketing activity or a marketing channel.", "args": [ { "name": "marketingActivityId", "description": "The identifier of the marketing activity for which the engagement metrics are being provided. This or the remoteId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "remoteId", "description": "The ID of an activity that's hosted outside of Shopify. This or the marketingActivityId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "channelHandle", "description": "The unique string identifier of the channel to which the engagement metrics are being provided. This should be set when and only when providing channel-level engagements. This should be nil when providing activity-level engagements. For the correct handle for your channel, contact your partner manager.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "marketingEngagement", "description": "The marketing engagement's attributes.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MarketingEngagementInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingEngagementCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEngagementsDelete", "description": "Marks channel-level engagement data such that it no longer appears in reports.\n Activity-level data cannot be deleted directly, instead the MarketingActivity itself should be deleted to\n hide it from reports.", "args": [ { "name": "channelHandle", "description": "The handle of the channel for which engagement data should be deleted.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "deleteEngagementsForAllChannels", "description": "When true, engagements for all channels that belong to the api client will be deleted.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "MarketingEngagementsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionCreate", "description": "Creates a metafield definition. Any metafields existing under the same owner type, namespace, and key will be\nchecked against this definition and will have their type updated accordingly. For metafields that are not\nvalid, they will remain unchanged but any attempts to update them must align with this definition.\n", "args": [ { "name": "definition", "description": "Specifies the input fields for a metafield definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinitionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionDelete", "description": "Delete a metafield definition.\nOptionally deletes all associated metafields asynchronously when specified.\n", "args": [ { "name": "id", "description": "The id of the metafield definition to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "deleteAllAssociatedMetafields", "description": "Whether to delete all associated metafields.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinitionDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionPin", "description": "You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.\nThe order of your pinned metafield definitions determines the order in which your metafields are displayed\non the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.\n", "args": [ { "name": "definitionId", "description": "The ID of the metafield definition to pin.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinitionPinPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionUnpin", "description": "You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.\nThe order of your pinned metafield definitions determines the order in which your metafields are displayed\non the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.\n", "args": [ { "name": "definitionId", "description": "The ID of the metafield definition to unpin.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinitionUnpinPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionUpdate", "description": "Updates a metafield definition.\n", "args": [ { "name": "definition", "description": "The input fields for the metafield definition update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDefinitionUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinitionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDelete", "description": "Deletes a metafield.", "args": [ { "name": "input", "description": null, "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldStorefrontVisibilityCreate", "description": "Creates a `MetafieldStorefrontVisibility` record to make all metafields that belong to the specified resource\nand have the established `namespace` and `key` combination visible in the Storefront API.\n", "args": [ { "name": "input", "description": "Specifies the input fields for a `MetafieldStorefrontVisibility` record.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldStorefrontVisibilityInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityCreatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "This mutation will be removed in a future version. Use the `metafieldDefinitionCreate` or `metafieldDefinitionUpdate` mutations with `access.storefront` set instead.\n" }, { "name": "metafieldStorefrontVisibilityDelete", "description": "Deletes a `MetafieldStorefrontVisibility` record. All metafields that belongs to the specified record will no\nlonger be visible in the Storefront API.\n", "args": [ { "name": "id", "description": "The ID of the `MetafieldStorefrontVisibility` record to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityDeletePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "This mutation will be removed in a future version. Use the `metafieldDefinitionUpdate` mutation with `access.storefront` set instead.\n" }, { "name": "metafieldsDelete", "description": "Deletes multiple metafields in bulk.", "args": [ { "name": "metafields", "description": "A list of identifiers specifying metafields to delete. At least one identifier must be specified.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldIdentifierInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldsSet", "description": "Sets metafield values. Metafield values will be set regardless if they were previously created or not.\n\nAllows a maximum of 25 metafields to be set at a time.\n\nNote that this operation is atomic as of `2023-01`, meaning no changes are persisted if any error is\nencountered.\n", "args": [ { "name": "metafields", "description": "The list of metafield values to set. Maximum of 25.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldsSetInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldsSetPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectBulkDelete", "description": "Asynchronously delete metaobjects and their associated metafields in bulk.", "args": [ { "name": "where", "description": "Specifies the condition by which metaobjects are deleted.\nExactly one field of input is required.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectBulkDeleteWhereCondition", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectCreate", "description": "Creates a new metaobject.", "args": [ { "name": "metaobject", "description": "The parameters for the metaobject to create.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinitionCreate", "description": "Creates a new metaobject definition.", "args": [ { "name": "definition", "description": "The input fields for creating a metaobject definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectDefinitionCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDefinitionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinitionDelete", "description": "Deletes the specified metaobject definition.\nAlso deletes all related metafield definitions, metaobjects, and metafields asynchronously.\n", "args": [ { "name": "id", "description": "The ID of the metaobjects definition to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDefinitionDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinitionUpdate", "description": "Updates a metaobject definition with new settings and metafield definitions.", "args": [ { "name": "id", "description": "The ID of the metaobject definition to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "definition", "description": "The input fields for updating a metaobject definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectDefinitionUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDefinitionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDelete", "description": "Deletes the specified metaobject and its associated metafields.", "args": [ { "name": "id", "description": "The ID of the metaobject to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectUpdate", "description": "Updates an existing metaobject.", "args": [ { "name": "id", "description": "The ID of the metaobject to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "metaobject", "description": "Specifies parameters to update on the metaobject.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectUpsert", "description": "Retrieves a metaobject by handle, then updates it with the provided input values.\nIf no matching metaobject is found, a new metaobject is created with the provided input values.\n", "args": [ { "name": "handle", "description": "The identifier of the metaobject to upsert.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectHandleInput", "ofType": null } }, "defaultValue": null }, { "name": "metaobject", "description": "The parameters to upsert the metaobject.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectUpsertInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectUpsertPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCancel", "description": "Cancels an order.", "args": [ { "name": "orderId", "description": "The ID of the order to be canceled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "refund", "description": "Whether to refund the amount paid by the customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "restock", "description": "Whether to restock the inventory committed to the order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "reason", "description": "The reason for canceling the order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderCancelReason", "ofType": null } }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether to send a notification to the customer about the order cancellation.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "staffNote", "description": "A staff-facing note about the order cancellation. This is not visible to the customer.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "null" } ], "type": { "kind": "OBJECT", "name": "OrderCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCapture", "description": "Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. orderCapture can be used to capture multiple times as long as the OrderTransaction is multi-capturable. To capture a partial payment, the included `amount` value should be less than the total order amount. Multi-capture is available only to stores on a Shopify Plus plan.", "args": [ { "name": "input", "description": "The input for the mutation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderCaptureInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderCapturePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderClose", "description": "Closes an open order.\n", "args": [ { "name": "input", "description": "The input for the mutation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderCloseInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderClosePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCreateMandatePayment", "description": "Creates a payment for an order by mandate.", "args": [ { "name": "id", "description": "The ID of the order to collect the balance for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentScheduleId", "description": "The ID of the payment schedule to collect the balance for.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "idempotencyKey", "description": "A unique key to identify the payment request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "mandateId", "description": "The mandate ID used for payment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "amount", "description": "The payment amount to collect.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "autoCapture", "description": "Whether the payment should be authorized or captured. If `false`, then the authorization of\n the payment is triggered.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "OrderCreateMandatePaymentPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditAddCustomItem", "description": "Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto which the custom item is added.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "title", "description": "The name of the custom item to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the retail [location](https://shopify.dev/api/admin-graphql/latest/objects/location)\n(if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The unit price of the custom item. This value can't be negative.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the custom item. This value must be greater than zero.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "taxable", "description": "Whether the custom item is taxable. Defaults to `true`.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "requiresShipping", "description": "Whether the custom item requires shipping. Defaults to `false`.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditAddCustomItemPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditAddLineItemDiscount", "description": "Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto update.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "lineItemId", "description": "The ID of the calculated line item to add the discount to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discount", "description": "The discount to add to the line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderEditAppliedDiscountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditAddLineItemDiscountPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditAddShippingLine", "description": "Adds a shipping line to an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto edit.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "shippingLine", "description": "The shipping line to be added.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderEditAddShippingLineInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditAddShippingLinePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditAddVariant", "description": "Adds a line item from an existing product variant.", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto edit.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "variantId", "description": "The ID of the variant to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the [location](https://shopify.dev/api/admin-graphql/latest/objects/location)\nto check for inventory availability. A default location ID is chosen automatically if none is provided.\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the item to add to the order. Must be a positive value.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "allowDuplicates", "description": "Whether the mutation can create a line item for a variant that's already on the calculated order.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "OrderEditAddVariantPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditBegin", "description": "Starts editing an order. Mutations are operating on `OrderEdit`.\nAll order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`.\n", "args": [ { "name": "id", "description": "The ID of the order to begin editing.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditBeginPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditCommit", "description": "Applies and saves staged changes to an order. Mutations are operating on `OrderEdit`.\nAll order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`.\n", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nthat will have its changes applied to the order.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether to notify the customer or not.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "staffNote", "description": "Note for staff members.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditCommitPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditRemoveDiscount", "description": "Removes a discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to remove the discount.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discountApplicationId", "description": "The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication)\nto remove.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditRemoveDiscountPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditRemoveLineItemDiscount", "description": "Removes a line item discount that was applied as part of an order edit.", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to remove the discount.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discountApplicationId", "description": "The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication)\nto remove.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditRemoveLineItemDiscountPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use generic OrderEditRemoveDiscount mutation instead." }, { "name": "orderEditRemoveShippingLine", "description": "Removes a shipping line from an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto edit.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "shippingLineId", "description": "The ID of the calculated shipping line to remove.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditRemoveShippingLinePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditSetQuantity", "description": "Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto edit. The edit changes the quantity on the line item.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "lineItemId", "description": "The ID of the calculated line item to edit.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The new quantity to set for the line item. This value cannot be negative.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "restock", "description": "Whether or not to restock the line item when the updated quantity is less than the original quantity.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditSetQuantityPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditUpdateDiscount", "description": "Updates a manual line level discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to update the discount.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discount", "description": "The updated discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderEditAppliedDiscountInput", "ofType": null } }, "defaultValue": null }, { "name": "discountApplicationId", "description": "The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication)\nto update.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditUpdateDiscountPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderEditUpdateShippingLine", "description": "Updates a shipping line on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", "args": [ { "name": "id", "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to update the shipping line.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "shippingLine", "description": "The updated shipping line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderEditUpdateShippingLineInput", "ofType": null } }, "defaultValue": null }, { "name": "shippingLineId", "description": "The ID of the calculated shipping line to update.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderEditUpdateShippingLinePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderInvoiceSend", "description": "Sends an email invoice for an order.", "args": [ { "name": "id", "description": "The order associated with the invoice.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "The email input fields for the order invoice. The `bcc` and `from` fields should be store or staff account emails.", "type": { "kind": "INPUT_OBJECT", "name": "EmailInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderInvoiceSendPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderMarkAsPaid", "description": "Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.\n", "args": [ { "name": "input", "description": "The input for the mutation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderMarkAsPaidInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderMarkAsPaidPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderOpen", "description": "Opens a closed order.\n", "args": [ { "name": "input", "description": "The input for the mutation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderOpenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderOpenPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderRiskAssessmentCreate", "description": "Create a risk assessment for an order.", "args": [ { "name": "orderRiskAssessmentInput", "description": "The input fields required to create a risk assessment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderRiskAssessmentCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderRiskAssessmentCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderUpdate", "description": "Updates the fields of an order.", "args": [ { "name": "input", "description": "The input for the mutation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomizationActivation", "description": "Activates and deactivates payment customizations.", "args": [ { "name": "ids", "description": "The global IDs of the payment customizations.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "enabled", "description": "The enabled status of the payment customizations.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentCustomizationActivationPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomizationCreate", "description": "Creates a payment customization.", "args": [ { "name": "paymentCustomization", "description": "The input data used to create the payment customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentCustomizationInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentCustomizationCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomizationDelete", "description": "Deletes a payment customization.", "args": [ { "name": "id", "description": "The global ID of the payment customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentCustomizationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomizationUpdate", "description": "Updates a payment customization.", "args": [ { "name": "id", "description": "The global ID of the payment customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentCustomization", "description": "The input data used to update the payment customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentCustomizationInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentCustomizationUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentReminderSend", "description": "Sends an email payment reminder for a payment schedule.", "args": [ { "name": "paymentScheduleId", "description": "The payment schedule id associated with the reminder.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentReminderSendPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsCreate", "description": "Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", "args": [ { "name": "referenceId", "description": "Specifies the reference orderId to add the payment terms for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentTermsAttributes", "description": "The attributes used to create the payment terms.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentTermsCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentTermsCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsDelete", "description": "Delete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", "args": [ { "name": "input", "description": "The input fields used to delete the payment terms.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentTermsDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentTermsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsUpdate", "description": "Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", "args": [ { "name": "input", "description": "The input fields used to update the payment terms.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentTermsUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentTermsUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListCreate", "description": "Creates a price list. You can use the `priceListCreate` mutation to create a new price list and associate it with a catalog. This enables you to sell your products with contextual pricing.", "args": [ { "name": "input", "description": "The properties of the new price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListDelete", "description": "Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.", "args": [ { "name": "id", "description": "The ID of the price list to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListFixedPricesAdd", "description": "Creates or updates fixed prices on a price list. You can use the `priceListFixedPricesAdd` mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten.", "args": [ { "name": "priceListId", "description": "The ID of the price list to which the fixed prices will be added or updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "prices", "description": "The list of fixed prices to add or update in the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListPriceInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListFixedPricesAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListFixedPricesByProductUpdate", "description": "Updates the fixed prices for all variants for a product on a price list. You can use the `priceListFixedPricesByProductUpdate` mutation to set or remove a fixed price for all variants of a product associated with the price list.", "args": [ { "name": "pricesToAdd", "description": "A list of `PriceListProductPriceInput` that identifies which products to update the fixed prices for.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListProductPriceInput", "ofType": null } } }, "defaultValue": null }, { "name": "pricesToDeleteByProductIds", "description": "A list of product IDs that identifies which products to remove the fixed prices for.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "priceListId", "description": "The price list to update the prices for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListFixedPricesByProductUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListFixedPricesDelete", "description": "Deletes specific fixed prices from a price list using a product variant ID. You can use the `priceListFixedPricesDelete` mutation to delete a set of fixed prices from a price list. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment.", "args": [ { "name": "priceListId", "description": "The ID of the price list from which the fixed prices will be removed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "variantIds", "description": "A list of product variant IDs whose fixed prices will be removed from the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListFixedPricesDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListFixedPricesUpdate", "description": "Updates fixed prices on a price list. You can use the `priceListFixedPricesUpdate` mutation to set a fixed price for specific product variants or to delete prices for variants associated with the price list.", "args": [ { "name": "priceListId", "description": "The price list that the prices will be updated against.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "pricesToAdd", "description": "The fixed prices to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListPriceInput", "ofType": null } } } }, "defaultValue": null }, { "name": "variantIdsToDelete", "description": "A list of product variant IDs to remove from the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListFixedPricesUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceListUpdate", "description": "Updates a price list.\nIf you modify the currency, then any fixed prices set on the price list will be deleted.\n", "args": [ { "name": "id", "description": "The ID of the price list to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input data used to update the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceListUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleActivate", "description": "Activate a price rule.", "args": [ { "name": "id", "description": "ID of the price rule to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleActivatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeActivate` instead." }, { "name": "priceRuleCreate", "description": "Create a price rule using the input.", "args": [ { "name": "priceRule", "description": "The input fields to create a price rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceRuleInput", "ofType": null } }, "defaultValue": null }, { "name": "priceRuleDiscountCode", "description": "The input fields to create a discount code for the price rule.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleDiscountCodeInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleCreatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeBasicCreate` instead." }, { "name": "priceRuleDeactivate", "description": "Deactivate a price rule.", "args": [ { "name": "id", "description": "ID of the price rule to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleDeactivatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeDeactivate` instead." }, { "name": "priceRuleDelete", "description": "Delete a price rule.", "args": [ { "name": "id", "description": "The ID of the price rule object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleDeletePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeDelete` instead." }, { "name": "priceRuleDiscountCodeCreate", "description": "Create a discount code for a price rule.", "args": [ { "name": "priceRuleId", "description": "The ID of the price rule object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "code", "description": "The code to create for the price rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCodeCreatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountRedeemCodeBulkAdd` instead." }, { "name": "priceRuleDiscountCodeUpdate", "description": "Update a discount code for a price rule.", "args": [ { "name": "priceRuleId", "description": "The ID of the price rule object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "code", "description": "The new code of a price rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCodeUpdatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeBasicUpdate` instead." }, { "name": "priceRuleUpdate", "description": "Updates a price rule using its ID and an input.", "args": [ { "name": "id", "description": "ID of the price rule to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "priceRule", "description": "The input fields to update a price rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceRuleInput", "ofType": null } }, "defaultValue": null }, { "name": "priceRuleDiscountCode", "description": "The input fields to update the discount code of the price rule.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleDiscountCodeInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRuleUpdatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `discountCodeBasicUpdate` instead." }, { "name": "privateMetafieldDelete", "description": "Deletes a private metafield.\nPrivate metafields are automatically deleted when the app that created them is uninstalled.\n", "args": [ { "name": "input", "description": "The input fields for the private metafield to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafieldDeletePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafieldUpsert", "description": "Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps.\nPrivate metafields are accessible only by the application that created them and only from the GraphQL Admin API.\n\nAn application can create a maximum of 10 private metafields per shop resource.\n", "args": [ { "name": "input", "description": "Specifies the input fields for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafieldUpsertPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "productAppendImages", "description": "Appends images to a product.", "args": [ { "name": "input", "description": "Specifies the new images and the product that they're being added to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductAppendImagesInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductAppendImagesPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `productCreateMedia` instead." }, { "name": "productChangeStatus", "description": "Changes the status of a product. This allows you to set the availability of the product across all channels.", "args": [ { "name": "productId", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "status", "description": "The status to be assigned to the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductStatus", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductChangeStatusPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productCreate", "description": "Creates a product.\n\nFor versions `2024-01` and older:\n\nIf you need to create a product with many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nespecially with a lot of\n[collections](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-collectionstojoin)\nand\n[tags](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-tags),\nthen you should first create the product with just the variants.\n\nAfter the product is created, you can activate the variants at locations\nand add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will\ncomplete before the operation times out.\n\nThe following example shows how you might break up product creation and object association into multiple steps:\n\n1. Create the product with variants. Don't specify any tags or collections on the product, and don't specify\n[inventory quantities](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput#field-productvariantinput-inventoryquantities)\nfor each variant.\n\n2. After the product is created, add tags to the product using the\n[tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsAdd) mutation, and add collections using the\n[collectionsAddProducts](https://shopify.dev/api/admin-graphql/latest/mutations/collectionAddProducts) mutation.\n\n3. Use the [inventoryBulkToggleActivation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkToggleActivation) mutation\non each [inventory item](https://shopify.dev/api/admin-graphql/latest/objects/InventoryItem) to activate it at the appropriate locations.\n\n4. After activating the variants at the locations, adjust inventory quantities at each location using the\n[inventoryBulkAdjustQuantityAtLocation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkAdjustQuantityAtLocation) mutation.\n", "args": [ { "name": "input", "description": "The properties of the new product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductInput", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "List of new media to be added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productCreateMedia", "description": "Creates media for a product.", "args": [ { "name": "productId", "description": "Specifies the product associated with the media.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "List of new media to be added to a product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductCreateMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDelete", "description": "Deletes a product, including all associated variants and media.\n\nAs of API version `2023-01`, if you need to delete a large product, such as one that has many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nyou may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous\n[ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync)\nmutation.\n", "args": [ { "name": "input", "description": "Specifies the product to delete by its ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDeleteAsync", "description": "Deletes a product asynchronously, including all associated variants and media.\n", "args": [ { "name": "productId", "description": "The ID of the product to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductDeleteAsyncPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDeleteImages", "description": "Removes product images from the product.", "args": [ { "name": "id", "description": "This is the ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "imageIds", "description": "This is the array of image IDs to delete from the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductDeleteImagesPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `productDeleteMedia` instead." }, { "name": "productDeleteMedia", "description": "Deletes media for a product.", "args": [ { "name": "productId", "description": "Specifies the product ID from which the media will be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "mediaIds", "description": "The media IDs to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductDeleteMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDuplicate", "description": "Duplicates a product.\n\nAs of API version `2023-01`, if you need to duplicate a large product, such as one that has many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nyou may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous\n[ProductDuplicateAsyncV2](https://shopify.dev/api/admin-graphql/latest/mutations/productDuplicateAsyncV2)\nmutation.\n", "args": [ { "name": "productId", "description": "The ID of the product to be duplicated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "newTitle", "description": "The new title of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "newStatus", "description": "The new status of the product. If no value is provided the status will be inherited from the original product.", "type": { "kind": "ENUM", "name": "ProductStatus", "ofType": null }, "defaultValue": null }, { "name": "includeImages", "description": "Specifies whether or not to duplicate images.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "includeTranslations", "description": "Specifies whether or not to duplicate translations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "ProductDuplicatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDuplicateAsyncV2", "description": "Asynchronously duplicate a single product.\n", "args": [ { "name": "input", "description": "The params for duplicating the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductDuplicateAsyncInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductDuplicateAsyncV2Payload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productFeedCreate", "description": "Creates a product feed for a specific publication.", "args": [ { "name": "input", "description": "The properties of the new product feed.", "type": { "kind": "INPUT_OBJECT", "name": "ProductFeedInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductFeedCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productFeedDelete", "description": "Deletes a product feed for a specific publication.", "args": [ { "name": "id", "description": "The ID of the product feed to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductFeedDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productFullSync", "description": "Runs the full product sync for a given shop.", "args": [ { "name": "beforeUpdatedAt", "description": "Syncs only products that haven't changed since the specified timestamp.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "The product feed which needs syncing.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "updatedAtSince", "description": "Syncs only products that have changed since the specified timestamp.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductFullSyncPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productImageUpdate", "description": "Updates an image of a product.", "args": [ { "name": "productId", "description": "The ID of the product on which to update the image.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "image", "description": "Image to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ImageInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductImageUpdatePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `productUpdateMedia` instead." }, { "name": "productJoinSellingPlanGroups", "description": "Adds multiple selling plan groups to a product.\n", "args": [ { "name": "id", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sellingPlanGroupIds", "description": "The IDs of the selling plan groups to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductJoinSellingPlanGroupsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productLeaveSellingPlanGroups", "description": "Removes multiple groups from a product.\n", "args": [ { "name": "id", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sellingPlanGroupIds", "description": "The IDs of the selling plan groups to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductLeaveSellingPlanGroupsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productOptionUpdate", "description": "Updates a product option.\n", "args": [ { "name": "option", "description": "Option to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionUpdateInput", "ofType": null } }, "defaultValue": null }, { "name": "productId", "description": "The ID of the Product the Option belongs to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "optionValuesToAdd", "description": "New option values to create.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionValueCreateInput", "ofType": null } } }, "defaultValue": null }, { "name": "optionValuesToUpdate", "description": "Existing option values to update.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionValueUpdateInput", "ofType": null } } }, "defaultValue": null }, { "name": "optionValuesToDelete", "description": "IDs of the existing option values to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "variantStrategy", "description": "The strategy defines which behavior the mutation should observe regarding variants,\nsuch as creating variants or deleting them in response to option values to add or to delete.\nIf not provided or set to null, the strategy `LEAVE_AS_IS` will be used.\n", "type": { "kind": "ENUM", "name": "ProductOptionUpdateVariantStrategy", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductOptionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productOptionsCreate", "description": "Creates options on a product.\n", "args": [ { "name": "productId", "description": "The ID of the product to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "options", "description": "Options to add to the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionCreateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductOptionsCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productOptionsDelete", "description": "Deletes the specified options.\n", "args": [ { "name": "productId", "description": "ID of the product from which to delete the options.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "options", "description": "IDs of the options to delete from the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "strategy", "description": "The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.", "type": { "kind": "ENUM", "name": "ProductOptionDeleteStrategy", "ofType": null }, "defaultValue": "DEFAULT" } ], "type": { "kind": "OBJECT", "name": "ProductOptionsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productOptionsReorder", "description": "Reorders options and option values on a product, causing product variants to alter their position.\n\nOptions order take precedence over option values order. Depending on the existing product variants,\nsome input orders might not be achieved.\n\nExample:\n Existing product variants:\n [\"Red / Small\", \"Green / Medium\", \"Blue / Small\"].\n\n New order:\n [\n {\n name: \"Size\", values: [{ name: \"Small\" }, { name: \"Medium\" }],\n name: \"Color\", values: [{ name: \"Green\" }, { name: \"Red\" }, { name: \"Blue\" }]\n }\n ].\n\n Description:\n Variants with \"Green\" value are expected to appear before variants with \"Red\" and \"Blue\" values.\n However, \"Size\" option appears before \"Color\".\n\n Therefore, output will be:\n [\"Small / \"Red\", \"Small / Blue\", \"Medium / Green\"].\n", "args": [ { "name": "productId", "description": "The ID of the product to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "options", "description": "Options to reorder on the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionReorderInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductOptionsReorderPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productPublish", "description": "Publishes a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be published on online stores.", "args": [ { "name": "input", "description": "Specifies the product to publish and the channels to publish it to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductPublishInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductPublishPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publishablePublish` instead." }, { "name": "productReorderImages", "description": "Asynchronously reorders a set of images for a given product.", "args": [ { "name": "id", "description": "The ID of the product on which to reorder images.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "moves", "description": "A list of moves to perform which will be evaluated in order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoveInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductReorderImagesPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `productReorderMedia` instead." }, { "name": "productReorderMedia", "description": "Asynchronously reorders the media attached to a product.", "args": [ { "name": "id", "description": "The ID of the product on which to reorder medias.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "moves", "description": "A list of moves to perform which will be evaluated in order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoveInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductReorderMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productSet", "description": "Creates or updates a product in a single request.\n\nUse this mutation when syncing information from an external data source into Shopify.\n\nWhen using this mutation to update a product, specify that product's `id` in the input.\n\nAny list field (e.g.\n[collections](https://shopify.dev/api/admin-graphql/current/input-objects/ProductSetInput#field-productsetinput-collections),\n[metafields](https://shopify.dev/api/admin-graphql/current/input-objects/ProductSetInput#field-productsetinput-metafields),\n[variants](https://shopify.dev/api/admin-graphql/current/input-objects/ProductSetInput#field-productsetinput-variants))\nwill be updated so that all included entries are either created or updated, and all existing entries not\nincluded will be deleted.\n\nAll other fields will be updated to the value passed. Omitted fields will not be updated.\n\nWhen run in synchronous mode, the `productSet` mutation has an input limit of 100 variants. If you anticipate\nany of your use cases requiring support for more than 100 variants, please use the mutation in asynchronous\nmode (default).\n\nWhen run in synchronous mode, you will get the product back in the response.\n\nIn asynchronous mode, you will instead get a\n[ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation)\nobject back. You can then use the\n[productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query to\nretrieve the updated product data. This query uses the `ProductSetOperation` object to\ncheck the status of the operation and to retrieve the details of the updated product and its variants.\n\nIf you need to update a subset of variants, use one of the bulk variant mutations:\n- [productVariantsBulkCreate](https://shopify.dev/api/admin-graphql/current/mutations/productVariantsBulkCreate)\n- [productVariantsBulkUpdate](https://shopify.dev/api/admin-graphql/current/mutations/productVariantsBulkUpdate)\n- [productVariantsBulkDelete](https://shopify.dev/api/admin-graphql/current/mutations/productVariantsBulkDelete)\n\nIf you need to update options, use one of the product option mutations:\n- [productOptionsCreate](https://shopify.dev/api/admin-graphql/current/mutations/productOptionsCreate)\n- [productOptionUpdate](https://shopify.dev/api/admin-graphql/current/mutations/productOptionUpdate)\n- [productOptionsDelete](https://shopify.dev/api/admin-graphql/current/mutations/productOptionsDelete)\n- [productOptionsReorder](https://shopify.dev/api/admin-graphql/current/mutations/productOptionsReorder)\n\nSee our guide to\n[sync product data from an external source](https://shopify.dev/api/admin/migrate/new-product-model/sync-data)\nfor more.\n", "args": [ { "name": "input", "description": "The properties of the new product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductSetInput", "ofType": null } }, "defaultValue": null }, { "name": "synchronous", "description": "Whether the mutation should be run synchronously or asynchronously.\n\nTo use this mutation with more than 100\nvariants in the `input`, the mutation must be run asynchronously.\n\nIf `true`, the mutation will return the updated `product`.\n\nIf `false`, the mutation will return a `productSetOperation`.\n\nDefaults to `false`.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "ProductSetPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productUnpublish", "description": "Unpublishes a product.", "args": [ { "name": "input", "description": "Specifies the product to unpublish and the channel to unpublish it from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductUnpublishInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductUnpublishPayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publishableUnpublish` instead." }, { "name": "productUpdate", "description": "Updates a product.\n\nFor versions `2024-01` and older:\nIf you update a product and only include some variants in the update,\nthen any variants not included will be deleted.\n\nTo safely manage variants without the risk of\ndeleting excluded variants, use\n[productVariantsBulkUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantsbulkupdate).\n\nIf you want to update a single variant, then use\n[productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate).\n", "args": [ { "name": "input", "description": "The updated properties for a product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductInput", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "List of new media to be added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productUpdateMedia", "description": "Updates media for a product.", "args": [ { "name": "productId", "description": "Specifies the product on which media will be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "A list of media updates.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "UpdateMediaInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductUpdateMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantAppendMedia", "description": "Appends media from a product to variants of the product.", "args": [ { "name": "productId", "description": "Specifies the product associated to the media.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "variantMedia", "description": "A list of pairs of variants and media to be attached to the variants.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantAppendMediaInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantAppendMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantCreate", "description": "Creates a product variant.", "args": [ { "name": "input", "description": "The properties for the new product variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantDelete", "description": "Deletes a product variant.", "args": [ { "name": "id", "description": "The ID of the product variant to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantDetachMedia", "description": "Detaches media from product variants.", "args": [ { "name": "productId", "description": "Specifies the product to which the variants and media are associated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "variantMedia", "description": "A list of pairs of variants and media to be deleted from the variants.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantDetachMediaInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantDetachMediaPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantJoinSellingPlanGroups", "description": "Adds multiple selling plan groups to a product variant.\n", "args": [ { "name": "id", "description": "The ID of the product variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sellingPlanGroupIds", "description": "The IDs of the selling plan groups to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantJoinSellingPlanGroupsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantLeaveSellingPlanGroups", "description": "Remove multiple groups from a product variant.\n", "args": [ { "name": "id", "description": "The ID of the product variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sellingPlanGroupIds", "description": "The IDs of the selling plan groups to leave.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantLeaveSellingPlanGroupsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantRelationshipBulkUpdate", "description": "Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles.", "args": [ { "name": "input", "description": "The input options for the product variant being updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantRelationshipUpdateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantRelationshipBulkUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantUpdate", "description": "Updates a product variant.", "args": [ { "name": "input", "description": "The updated properties for the product variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsBulkCreate", "description": "Creates product variants in bulk. If you want to create a single variant, then use\n[productVariantCreate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantcreate).\n", "args": [ { "name": "variants", "description": "An array of product variants to be created.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantsBulkInput", "ofType": null } } } }, "defaultValue": null }, { "name": "productId", "description": "The ID of the product on which to create the variants.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "List of new media to be added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "ofType": null } } }, "defaultValue": null }, { "name": "strategy", "description": "The strategy defines which behavior the mutation should observe, such as whether to keep or delete the standalone variant (when product has only a single or default variant) when creating new variants in bulk.", "type": { "kind": "ENUM", "name": "ProductVariantsBulkCreateStrategy", "ofType": null }, "defaultValue": "DEFAULT" } ], "type": { "kind": "OBJECT", "name": "ProductVariantsBulkCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsBulkDelete", "description": "Deletes product variants in bulk. If you want to delete a single variant, then use\n[productVariantDelete](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantdelete).\n", "args": [ { "name": "variantsIds", "description": "An array of product variants IDs to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "productId", "description": "The ID of the product with the variants to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantsBulkDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsBulkReorder", "description": "Reorder product variants in bulk.", "args": [ { "name": "productId", "description": "The product ID of the variants to be reordered.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "positions", "description": "An array of variant positions.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantPositionInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariantsBulkReorderPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsBulkUpdate", "description": "Updates product variants in bulk. If you want to update a single variant, then use\n[productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate).\n", "args": [ { "name": "variants", "description": "An array of product variants to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantsBulkInput", "ofType": null } } } }, "defaultValue": null }, { "name": "productId", "description": "The ID of the product associated with the variants to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "media", "description": "List of new media to be added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateMediaInput", "ofType": null } } }, "defaultValue": null }, { "name": "allowPartialUpdates", "description": "When partial updates are allowed, valid variant changes may be persisted even if some of\nthe variants updated have invalid data and cannot be persisted.\nWhen partial updates are not allowed, any error will prevent all variants from updating.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "ProductVariantsBulkUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pubSubServerPixelUpdate", "description": "Updates the server pixel to connect to a Google PubSub endpoint.\nRunning this mutation deletes any previous subscriptions for the server pixel.\n", "args": [ { "name": "pubSubProject", "description": "The Google PubSub project ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "pubSubTopic", "description": "The Google PubSub topic ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PubSubServerPixelUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pubSubWebhookSubscriptionCreate", "description": "Creates a new Google Cloud Pub/Sub webhook subscription.", "args": [ { "name": "topic", "description": "The type of event that triggers the webhook.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "ofType": null } }, "defaultValue": null }, { "name": "subTopic", "description": "An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to [sub-topics](https://shopify.dev/docs/apps/webhooks/sub-topics) for more.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PubSubWebhookSubscriptionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pubSubWebhookSubscriptionUpdate", "description": "Updates a Google Cloud Pub/Sub webhook subscription.", "args": [ { "name": "id", "description": "The ID of the webhook subscription to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.", "type": { "kind": "INPUT_OBJECT", "name": "PubSubWebhookSubscriptionInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationCreate", "description": "Creates a publication.\n", "args": [ { "name": "input", "description": "The input fields to use when creating the publication.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PublicationCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublicationCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationDelete", "description": "Deletes a publication.\n", "args": [ { "name": "id", "description": "The ID of the publication to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublicationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationUpdate", "description": "Updates a publication.\n", "args": [ { "name": "id", "description": "The ID of the publication to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input fields to use when updating the publication.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PublicationUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublicationUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishablePublish", "description": "Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores.", "args": [ { "name": "id", "description": "The resource to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "Specifies the input fields required to publish a resource.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PublicationInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublishablePublishPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishablePublishToCurrentChannel", "description": "Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores.", "args": [ { "name": "id", "description": "The resource to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublishablePublishToCurrentChannelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishableUnpublish", "description": "Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`.", "args": [ { "name": "id", "description": "The resource to delete or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "Specifies the input fields required to unpublish a resource.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PublicationInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublishableUnpublishPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishableUnpublishToCurrentChannel", "description": "Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`.", "args": [ { "name": "id", "description": "The resource to delete or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PublishableUnpublishToCurrentChannelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityPricingByVariantUpdate", "description": "Updates quantity pricing on a price list. You can use the `quantityPricingByVariantUpdate` mutation to set fixed prices, quantity rules, and quantity price breaks. This mutation does not allow partial successes. If any of the requested resources fail to update, none of the requested resources will be updated. Delete operations are executed before create operations.", "args": [ { "name": "priceListId", "description": "The ID of the price list for which quantity pricing will be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The input data used to update the quantity pricing in the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "QuantityPricingByVariantUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "QuantityPricingByVariantUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityRulesAdd", "description": "Creates or updates existing quantity rules on a price list.\nYou can use the `quantityRulesAdd` mutation to set order level minimums, maximumums and increments for specific product variants.\n", "args": [ { "name": "priceListId", "description": "The ID of the price list to which the quantity rules will be added or updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantityRules", "description": "The list of quantity rules to add or update in the price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "QuantityRuleInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "QuantityRulesAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityRulesDelete", "description": "Deletes specific quantity rules from a price list using a product variant ID.\nYou can use the `quantityRulesDelete` mutation to delete a set of quantity rules from a price list.\n", "args": [ { "name": "priceListId", "description": "The ID of the price list from which the quantity rules will be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "variantIds", "description": "A list of product variant IDs whose quantity rules will be removed from the price list.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "QuantityRulesDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundCreate", "description": "Creates a refund.", "args": [ { "name": "input", "description": "The input fields that are used in the mutation for creating a refund.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RefundCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnApproveRequest", "description": "Approves a customer's return request.\nIf this mutation is successful, then the `Return.status` field of the\napproved return is set to `OPEN`.\n", "args": [ { "name": "input", "description": "The input fields to approve a return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnApproveRequestInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnApproveRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnCancel", "description": "Cancels a return and restores the items back to being fulfilled.\nCanceling a return is only available before any work has been done\non the return (such as an inspection or refund).\n", "args": [ { "name": "id", "description": "The ID of the return to cancel.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "notifyCustomer", "description": "Whether the customer receives an email notification regarding the canceled return.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "ReturnCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnClose", "description": "Indicates a return is complete, either when a refund has been made and items restocked,\nor simply when it has been marked as returned in the system.\n", "args": [ { "name": "id", "description": "The ID of the return to close.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnClosePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnCreate", "description": "Creates a return.", "args": [ { "name": "returnInput", "description": "Specifies the input fields for a return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnDeclineRequest", "description": "Declines a return on an order.\nWhen a return is declined, each `ReturnLineItem.fulfillmentLineItem` can be associated to a new return.\nUse the `ReturnCreate` or `ReturnRequest` mutation to initiate a new return.\n", "args": [ { "name": "input", "description": "The input fields for declining a customer's return request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnDeclineRequestInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnDeclineRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnRefund", "description": "Refunds a return when its status is `OPEN` or `CLOSED` and associates it with the related return request.", "args": [ { "name": "returnRefundInput", "description": "The input fields to refund a return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRefundInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnRefundPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnReopen", "description": "Reopens a closed return.", "args": [ { "name": "id", "description": "The ID of the return to reopen.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnReopenPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnRequest", "description": "A customer's return request that hasn't been approved or declined.\nThis mutation sets the value of the `Return.status` field to `REQUESTED`.\nTo create a return that has the `Return.status` field set to `OPEN`, use the `returnCreate` mutation.\n", "args": [ { "name": "input", "description": "The input fields for requesting a return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRequestInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnRequestPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseDeliveryCreateWithShipping", "description": "Creates a new reverse delivery with associated external shipping information.", "args": [ { "name": "reverseFulfillmentOrderId", "description": "The ID of the reverse fulfillment order that's associated to the reverse delivery.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "reverseDeliveryLineItems", "description": "The reverse delivery line items to be created. If an empty array is provided, then this mutation\n will create a reverse delivery line item for each reverse fulfillment order line item, with its quantity equal\n to the reverse fulfillment order line item total quantity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "trackingInput", "description": "The tracking information for the reverse delivery.", "type": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryTrackingInput", "ofType": null }, "defaultValue": "null" }, { "name": "labelInput", "description": "The return label file information for the reverse delivery.", "type": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryLabelInput", "ofType": null }, "defaultValue": "null" }, { "name": "notifyCustomer", "description": "When `true` the customer is notified with delivery instructions if the `ReverseFulfillmentOrder.order.email` is present.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "ReverseDeliveryCreateWithShippingPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseDeliveryDispose", "description": "Disposes reverse delivery line items for a reverse delivery on the same shop.\n", "args": [ { "name": "dispositionInputs", "description": "The input parameters required to dispose reverse delivery line items.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryDisposeInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReverseDeliveryDisposePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "`reverseDeliveryDispose` will be removed in API version 2025-01. Use `reverseFulfillmentOrderDispose` instead." }, { "name": "reverseDeliveryShippingUpdate", "description": "Updates a reverse delivery with associated external shipping information.", "args": [ { "name": "reverseDeliveryId", "description": "The ID of the reverse delivery to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "trackingInput", "description": "The tracking information for the reverse delivery.", "type": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryTrackingInput", "ofType": null }, "defaultValue": "null" }, { "name": "labelInput", "description": "The return label file information for the reverse delivery.", "type": { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryLabelInput", "ofType": null }, "defaultValue": "null" }, { "name": "notifyCustomer", "description": "If `true` and an email address exists on the `ReverseFulfillmentOrder.order`, then the customer is notified with the updated delivery instructions.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "ReverseDeliveryShippingUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseFulfillmentOrderDispose", "description": "Disposes reverse fulfillment order line items.\n", "args": [ { "name": "dispositionInputs", "description": "The input parameters required to dispose reverse fulfillment order line items.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReverseFulfillmentOrderDisposeInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "savedSearchCreate", "description": "Creates a saved search.", "args": [ { "name": "input", "description": "Specifies the input fields for a saved search.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SavedSearchCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SavedSearchCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "savedSearchDelete", "description": "Delete a saved search.", "args": [ { "name": "input", "description": "The input fields to delete a saved search.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SavedSearchDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SavedSearchDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "savedSearchUpdate", "description": "Updates a saved search.", "args": [ { "name": "input", "description": "The input fields to update a saved search.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SavedSearchUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SavedSearchUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scriptTagCreate", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nCreates a new script tag.\n", "args": [ { "name": "input", "description": "The input fields for a script tag.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ScriptTagInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ScriptTagCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scriptTagDelete", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nDeletes a script tag.\n", "args": [ { "name": "id", "description": "The ID of the script tag to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ScriptTagDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scriptTagUpdate", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nUpdates a script tag.\n", "args": [ { "name": "id", "description": "The ID of the script tag to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "Specifies the input fields for a script tag.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ScriptTagInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ScriptTagUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentCreate", "description": "Creates a segment.", "args": [ { "name": "name", "description": "The name of the segment to be created. Segment names must be unique.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "query", "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SegmentCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentDelete", "description": "Deletes a segment.", "args": [ { "name": "id", "description": "Specifies the segment to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SegmentDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentUpdate", "description": "Updates a segment.", "args": [ { "name": "id", "description": "Specifies the segment to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "The new name for the segment.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "query", "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SegmentUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupAddProductVariants", "description": "Adds multiple product variants to a selling plan group.\n", "args": [ { "name": "id", "description": "The ID of the selling plan group.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productVariantIds", "description": "The IDs of the product variants to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupAddProductVariantsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupAddProducts", "description": "Adds multiple products to a selling plan group.\n", "args": [ { "name": "id", "description": "The ID of the selling plan group.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of the products to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupAddProductsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupCreate", "description": "Creates a Selling Plan Group.", "args": [ { "name": "input", "description": "The properties of the new Selling Plan Group.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanGroupInput", "ofType": null } }, "defaultValue": null }, { "name": "resources", "description": "The resources this Selling Plan Group should be applied to.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanGroupResourceInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupDelete", "description": "Delete a Selling Plan Group.", "args": [ { "name": "id", "description": "The id of the selling plan group to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupRemoveProductVariants", "description": "Removes multiple product variants from a selling plan group.\n", "args": [ { "name": "id", "description": "The ID of the selling plan group.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productVariantIds", "description": "The IDs of the product variants to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupRemoveProductVariantsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupRemoveProducts", "description": "Removes multiple products from a selling plan group.\n", "args": [ { "name": "id", "description": "The ID of the selling plan group.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of the products to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupRemoveProductsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupUpdate", "description": "Update a Selling Plan Group.", "args": [ { "name": "id", "description": "The Selling Plan Group to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the Selling Plan Group to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanGroupInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroupUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "serverPixelCreate", "description": "Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixelCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "serverPixelDelete", "description": "Deletes the Server Pixel associated with the current app & shop.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixelDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingPackageDelete", "description": "Deletes a shipping package.", "args": [ { "name": "id", "description": "The ID of the shipping package to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShippingPackageDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingPackageMakeDefault", "description": "Set a shipping package as the default.\nThe default shipping package is the one used to calculate shipping costs on checkout.\n", "args": [ { "name": "id", "description": "The ID of the shipping package to set as the default.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShippingPackageMakeDefaultPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingPackageUpdate", "description": "Updates a shipping package.", "args": [ { "name": "id", "description": "The ID of the shipping package to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "shippingPackage", "description": "Specifies the input fields for a shipping package.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomShippingPackageInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShippingPackageUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopLocaleDisable", "description": "Deletes a locale for a shop. This also deletes all translations of this locale.", "args": [ { "name": "locale", "description": "ISO code of the locale to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopLocaleDisablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopLocaleEnable", "description": "Adds a locale for a shop. The newly added locale is in the unpublished state.", "args": [ { "name": "locale", "description": "ISO code of the locale to enable.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketWebPresenceIds", "description": "The list of markets web presences to add the locale to.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopLocaleEnablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopLocaleUpdate", "description": "Updates a locale for a shop.", "args": [ { "name": "locale", "description": "ISO code of the locale to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "shopLocale", "description": "Specifies the input fields for a shop locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ShopLocaleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopLocaleUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopPolicyUpdate", "description": "Updates a shop policy.", "args": [ { "name": "shopPolicy", "description": "The properties to use when updating the shop policy.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ShopPolicyInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopPolicyUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopResourceFeedbackCreate", "description": "The `ResourceFeedback` object lets your app report the status of shops and their resources. For example, if\nyour app is a marketplace channel, then you can use resource feedback to alert merchants that they need to connect their marketplace account by signing in.\n\nResource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app.\n\nThis resource should be used only in cases where you're describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don't use resource feedback to let merchants know about them.\n\n## Sending feedback on a shop\n\nYou can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: `requires_action` or `success`. You need to send a `requires_action` feedback request for each step that the merchant is required to complete.\n\nIf there are multiple set-up steps that require merchant action, then send feedback with a state of `requires_action` as merchants complete prior steps. And to remove the feedback message from the Shopify admin, send a `success` feedback request.\n\n#### Important\nSending feedback replaces previously sent feedback for the shop. Send a new `shopResourceFeedbackCreate` mutation to push the latest state of a shop or its resources to Shopify.\n", "args": [ { "name": "input", "description": "The fields required to create shop feedback.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ResourceFeedbackCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopResourceFeedbackCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "stagedUploadTargetGenerate", "description": "Generates the URL and signed paramaters needed to upload an asset to Shopify.", "args": [ { "name": "input", "description": "The input fields for generating a staged upload.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "StagedUploadTargetGenerateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StagedUploadTargetGeneratePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `stagedUploadsCreate` instead." }, { "name": "stagedUploadTargetsGenerate", "description": "Uploads multiple images.", "args": [ { "name": "input", "description": "The input fields for generating staged uploads.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "StageImageInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StagedUploadTargetsGeneratePayload", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `stagedUploadsCreate` instead." }, { "name": "stagedUploadsCreate", "description": "Creates staged upload targets for each input. This is the first step in the upload process.\nThe returned staged upload targets' URL and parameter fields can be used to send a request\nto upload the file described in the corresponding input.\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", "args": [ { "name": "input", "description": "The information required to generate staged upload targets.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "StagedUploadInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StagedUploadsCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardMetafieldDefinitionEnable", "description": "Activates the specified standard metafield definition from its template.\n\nRefer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions).\n", "args": [ { "name": "ownerType", "description": "The resource type that the metafield definition is scoped to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "defaultValue": null }, { "name": "id", "description": "The ID of the standard metafield definition template to enable.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "namespace", "description": "The namespace of the standard metafield to enable. Used in combination with `key`.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key of the standard metafield to enable. Used in combination with `namespace`.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pin", "description": "Whether to pin the metafield definition.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": "false" }, { "name": "visibleToStorefrontApi", "description": "Whether metafields for the definition are visible using the Storefront API.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "null" }, { "name": "useAsCollectionCondition", "description": "Whether the metafield definition can be used as a collection condition.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionEnablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardMetaobjectDefinitionEnable", "description": "Enables the specified standard metaobject definition from its template.\n", "args": [ { "name": "type", "description": "The type of the metaobject definition to enable.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StandardMetaobjectDefinitionEnablePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontAccessTokenCreate", "description": "Creates a storefront access token. An app can have a maximum of 100 active storefront access tokens for each shop.", "args": [ { "name": "input", "description": "Provides the input fields for creating a storefront access token.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "StorefrontAccessTokenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StorefrontAccessTokenCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontAccessTokenDelete", "description": "Deletes a storefront access token.", "args": [ { "name": "input", "description": "Provides the input fields required to delete a storefront access token.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "StorefrontAccessTokenDeleteInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StorefrontAccessTokenDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingAttemptCreate", "description": "Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt).\n", "args": [ { "name": "subscriptionContractId", "description": "The ID of the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "subscriptionBillingAttemptInput", "description": "The information to apply as a billing attempt.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingAttemptInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingAttemptCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleContractDraftCommit", "description": "Commits the updates of a Subscription Billing Cycle Contract draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to commit.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractDraftCommitPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleContractDraftConcatenate", "description": "Concatenates a contract to a Subscription Draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "concatenatedBillingCycleContracts", "description": "An array of Subscription Contracts with their selected billing cycles to concatenate to the subscription draft.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractDraftConcatenatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleContractEdit", "description": "Edit the contents of a subscription contract for the specified billing cycle.", "args": [ { "name": "billingCycleInput", "description": "Input object for selecting and using billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractEditPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleEditDelete", "description": "Delete the schedule and contract edits of the selected subscription billing cycle.", "args": [ { "name": "billingCycleInput", "description": "Input object used to select and use billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleEditsDelete", "description": "Delete the current and future schedule and contract edits of a list of subscription billing cycles.", "args": [ { "name": "contractId", "description": "The globally-unique identifier of the subscription contract that the billing cycle belongs to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "targetSelection", "description": "Select billing cycles to be deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SubscriptionBillingCyclesTargetSelection", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditsDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleScheduleEdit", "description": "Modify the schedule of a specific billing cycle.", "args": [ { "name": "billingCycleInput", "description": "Input object for selecting and using billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "Data used to create or modify billing cycle schedule edit.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleScheduleEditInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleScheduleEditPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleSkip", "description": "Skips a Subscription Billing Cycle.", "args": [ { "name": "billingCycleInput", "description": "Input object for selecting and using billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleSkipPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycleUnskip", "description": "Unskips a Subscription Billing Cycle.", "args": [ { "name": "billingCycleInput", "description": "Input object for selecting and using billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleUnskipPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractActivate", "description": "Activates a Subscription Contract.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractActivatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractAtomicCreate", "description": "Creates a Subscription Contract.", "args": [ { "name": "input", "description": "The properties of the new Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionContractAtomicCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractAtomicCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractCancel", "description": "Cancels a Subscription Contract.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractCancelPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractCreate", "description": "Creates a Subscription Contract.", "args": [ { "name": "input", "description": "The properties of the new Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionContractCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractExpire", "description": "Expires a Subscription Contract.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractExpirePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractFail", "description": "Fails a Subscription Contract.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractFailPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractPause", "description": "Pauses a Subscription Contract.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractPausePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractProductChange", "description": "Allows for the easy change of a Product in a Contract or a Product price change.", "args": [ { "name": "subscriptionContractId", "description": "The ID of the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "lineId", "description": "The gid of the Subscription Line to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the Product changes.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionContractProductChangeInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractProductChangePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractSetNextBillingDate", "description": "Sets the next billing date of a Subscription Contract. This field is managed by the apps.\n Alternatively you can utilize our\n [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles),\n which provide auto-computed billing dates and additional functionalities.", "args": [ { "name": "contractId", "description": "The gid of the Subscription Contract to set the next billing date for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "date", "description": "The next billing date.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractSetNextBillingDatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContractUpdate", "description": "Updates a Subscription Contract.", "args": [ { "name": "contractId", "description": "The gid of the Subscription Contract to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContractUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftCommit", "description": "Commits the updates of a Subscription Contract draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to commit.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftCommitPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftDiscountAdd", "description": "Adds a subscription discount to a subscription draft.", "args": [ { "name": "draftId", "description": "The ID of the Subscription Contract draft to add a subscription discount to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the new Subscription Discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftDiscountAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftDiscountCodeApply", "description": "Applies a code discount on the subscription draft.", "args": [ { "name": "draftId", "description": "The gid of the subscription contract draft to apply a subscription code discount on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "redeemCode", "description": "Code discount redeem code.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftDiscountCodeApplyPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftDiscountRemove", "description": "Removes a subscription discount from a subscription draft.", "args": [ { "name": "draftId", "description": "The gid of the subscription contract draft to remove a subscription discount from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discountId", "description": "The gid of the subscription draft discount to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftDiscountRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftDiscountUpdate", "description": "Updates a subscription discount on a subscription draft.", "args": [ { "name": "draftId", "description": "The ID of the Subscription Contract draft to update a subscription discount on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discountId", "description": "The gid of the Subscription Discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties to update on the Subscription Discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftDiscountUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftFreeShippingDiscountAdd", "description": "Adds a subscription free shipping discount to a subscription draft.", "args": [ { "name": "draftId", "description": "The ID of the subscription contract draft to add a subscription free shipping discount to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the new subscription free shipping discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionFreeShippingDiscountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftFreeShippingDiscountAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftFreeShippingDiscountUpdate", "description": "Updates a subscription free shipping discount on a subscription draft.", "args": [ { "name": "draftId", "description": "The ID of the Subscription Contract draft to update a subscription discount on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "discountId", "description": "The gid of the Subscription Discount to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties to update on the Subscription Free Shipping Discount.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionFreeShippingDiscountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftFreeShippingDiscountUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftLineAdd", "description": "Adds a subscription line to a subscription draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to add a subscription line to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the new Subscription Line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionLineInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftLineAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftLineRemove", "description": "Removes a subscription line from a subscription draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to remove a subscription line from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "lineId", "description": "The gid of the Subscription Line to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftLineRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftLineUpdate", "description": "Updates a subscription line on a subscription draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Contract draft to update a subscription line from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "lineId", "description": "The gid of the Subscription Line to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the new Subscription Line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionLineUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftLineUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraftUpdate", "description": "Updates a Subscription Draft.", "args": [ { "name": "draftId", "description": "The gid of the Subscription Draft to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "The properties of the new Subscription Contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionDraftInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraftUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tagsAdd", "description": "Add tags to an order, a draft order, a customer, a product, or an online store article.", "args": [ { "name": "id", "description": "The ID of a resource to add tags to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "tags", "description": "A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TagsAddPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tagsRemove", "description": "Remove tags from an order, a draft order, a customer, a product, or an online store article.", "args": [ { "name": "id", "description": "The ID of the resource to remove tags from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "tags", "description": "A list of tags to remove from the resource in the form of an array of strings. Example value: `[\"tag1\", \"tag2\", \"tag3\"]`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TagsRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxAppConfigure", "description": "Allows tax app configurations for tax partners.\n", "args": [ { "name": "ready", "description": "Configures whether the tax app is correctly configured and ready to be used.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TaxAppConfigurePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactionVoid", "description": "Trigger the voiding of an uncaptured authorization transaction.", "args": [ { "name": "parentTransactionId", "description": "An uncaptured authorization transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TransactionVoidPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translationsRegister", "description": "Creates or updates translations.", "args": [ { "name": "resourceId", "description": "ID of the resource that is being translated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "translations", "description": "Specifies the input fields for a translation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "TranslationInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TranslationsRegisterPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translationsRemove", "description": "Deletes translations.", "args": [ { "name": "resourceId", "description": "ID of the translatable resource for which translations are being deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "translationKeys", "description": "The list of translation keys.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null }, { "name": "locales", "description": "The list of translation locales. Only locales returned in `shopLocales` are valid.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "defaultValue": null }, { "name": "marketIds", "description": "The list of market IDs.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TranslationsRemovePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectBulkDeleteAll", "description": "Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk.\n", "args": [], "type": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteAllPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectBulkDeleteByIds", "description": "Asynchronously delete [URLRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) \nobjects in bulk by IDs.\nLearn more about [URLRedirect](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect) \nobjects.\n", "args": [ { "name": "ids", "description": "A list of [`URLRedirect`](\n https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect\n ) object IDs to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteByIdsPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectBulkDeleteBySavedSearch", "description": "Asynchronously delete redirects in bulk.", "args": [ { "name": "savedSearchId", "description": "The ID of the URL redirect saved search for filtering.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySavedSearchPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectBulkDeleteBySearch", "description": "Asynchronously delete redirects in bulk.", "args": [ { "name": "search", "description": "Search query for filtering redirects on (both Redirect from and Redirect to fields).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySearchPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectCreate", "description": "Creates a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.\n", "args": [ { "name": "urlRedirect", "description": "The fields to use when creating the redirect.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "UrlRedirectInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectDelete", "description": "Deletes a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.\n", "args": [ { "name": "id", "description": "The ID of the redirect to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectImportCreate", "description": "Creates a [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object.\n\nAfter creating the `UrlRedirectImport` object, the `UrlRedirectImport` request can be performed using the [`urlRedirectImportSubmit`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportSubmit) mutation.\n", "args": [ { "name": "url", "description": "The staged upload URL of the CSV file.\nYou can download [a sample URL redirect CSV file](https://help.shopify.com/csv/sample-redirect-template.csv).\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectImportCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectImportSubmit", "description": "Submits a `UrlRedirectImport` request to be processed.\n\nThe `UrlRedirectImport` request is first created with the [`urlRedirectImportCreate`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate) mutation.\n", "args": [ { "name": "id", "description": "The ID of the [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectImportSubmitPayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectUpdate", "description": "Updates a URL redirect.\n", "args": [ { "name": "id", "description": "The ID of the URL redirect to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "urlRedirect", "description": "The input fields required to update the URL redirect.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "UrlRedirectInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "validationCreate", "description": "Creates a validation.", "args": [ { "name": "validation", "description": "The input fields for a new validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ValidationCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ValidationCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "validationDelete", "description": "Deletes a validation.", "args": [ { "name": "id", "description": "The ID representing the installed validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ValidationDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "validationUpdate", "description": "Update a validation.", "args": [ { "name": "validation", "description": "The input fields to update a validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ValidationUpdateInput", "ofType": null } }, "defaultValue": null }, { "name": "id", "description": "The ID representing the validation to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ValidationUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixelCreate", "description": "Creates a new web pixel settings.", "args": [ { "name": "webPixel", "description": "The web pixel settings in JSON format.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WebPixelInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebPixelCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixelDelete", "description": "Deletes the web pixel shop settings.", "args": [ { "name": "id", "description": "The ID of the web pixel to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebPixelDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixelUpdate", "description": "Updates the web pixel settings.", "args": [ { "name": "id", "description": "The ID of the web pixel to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webPixel", "description": "The web pixel settings in JSON format.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WebPixelInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebPixelUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscriptionCreate", "description": "Creates a new webhook subscription.\n", "args": [ { "name": "topic", "description": "The type of event that triggers the webhook.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "ofType": null } }, "defaultValue": null }, { "name": "subTopic", "description": "An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to [sub-topics](https://shopify.dev/docs/apps/webhooks/sub-topics) for more.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for a webhook subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WebhookSubscriptionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebhookSubscriptionCreatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscriptionDelete", "description": "Deletes a webhook subscription.\n", "args": [ { "name": "id", "description": "The ID of the webhook subscription to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebhookSubscriptionDeletePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscriptionUpdate", "description": "Updates a webhook subscription.\n", "args": [ { "name": "id", "description": "The ID of the webhook subscription to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "webhookSubscription", "description": "Specifies the input fields for a webhook subscription.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WebhookSubscriptionInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebhookSubscriptionUpdatePayload", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MutationsStagedUploadTargetGenerateUploadParameter", "description": "A signed upload parameter for uploading an asset to Shopify.\n\nDeprecated in favor of\n[StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter),\nwhich is used in\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget)\nand returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", "fields": [ { "name": "name", "description": "The upload parameter name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The upload parameter value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "Navigable", "description": "A default cursor that you can use in queries to paginate your results. Each edge in a connection can\nreturn a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as\nthe starting point to retrieve the nodes before or after it in a connection.\n\nTo learn more about using cursor-based pagination, refer to\n[Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql).\n", "fields": [ { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AbandonedCheckout", "ofType": null }, { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreArticle", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } ] }, { "kind": "OBJECT", "name": "NavigationItem", "description": "A navigation item, holding basic link attributes.", "fields": [ { "name": "id", "description": "The unique identifier of the navigation item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the navigation item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the page that the navigation item links to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "Node", "description": "An object with an ID field to support global identification, in accordance with the\n[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).\nThis interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)\nand [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AbandonedCheckout", "ofType": null }, { "kind": "OBJECT", "name": "AbandonedCheckoutLineItem", "ofType": null }, { "kind": "OBJECT", "name": "Abandonment", "ofType": null }, { "kind": "OBJECT", "name": "AddAllProductsOperation", "ofType": null }, { "kind": "OBJECT", "name": "AdditionalFee", "ofType": null }, { "kind": "OBJECT", "name": "App", "ofType": null }, { "kind": "OBJECT", "name": "AppCatalog", "ofType": null }, { "kind": "OBJECT", "name": "AppCredit", "ofType": null }, { "kind": "OBJECT", "name": "AppInstallation", "ofType": null }, { "kind": "OBJECT", "name": "AppPurchaseOneTime", "ofType": null }, { "kind": "OBJECT", "name": "AppRevenueAttributionRecord", "ofType": null }, { "kind": "OBJECT", "name": "AppSubscription", "ofType": null }, { "kind": "OBJECT", "name": "AppUsageRecord", "ofType": null }, { "kind": "OBJECT", "name": "BasicEvent", "ofType": null }, { "kind": "OBJECT", "name": "BulkOperation", "ofType": null }, { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, { "kind": "OBJECT", "name": "CartTransform", "ofType": null }, { "kind": "OBJECT", "name": "CashTrackingAdjustment", "ofType": null }, { "kind": "OBJECT", "name": "CashTrackingSession", "ofType": null }, { "kind": "OBJECT", "name": "CatalogCsvOperation", "ofType": null }, { "kind": "OBJECT", "name": "Channel", "ofType": null }, { "kind": "OBJECT", "name": "ChannelDefinition", "ofType": null }, { "kind": "OBJECT", "name": "ChannelInformation", "ofType": null }, { "kind": "OBJECT", "name": "CheckoutProfile", "ofType": null }, { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "CommentEvent", "ofType": null }, { "kind": "OBJECT", "name": "Company", "ofType": null }, { "kind": "OBJECT", "name": "CompanyAddress", "ofType": null }, { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null }, { "kind": "OBJECT", "name": "CompanyContactRoleAssignment", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, { "kind": "OBJECT", "name": "CompanyLocationCatalog", "ofType": null }, { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, { "kind": "OBJECT", "name": "CustomerSegmentMembersQuery", "ofType": null }, { "kind": "OBJECT", "name": "CustomerVisit", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCondition", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCountry", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryLocationGroup", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryMethod", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryMethodDefinition", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryParticipant", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryProfileItem", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryProvince", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryRateDefinition", "ofType": null }, { "kind": "OBJECT", "name": "DeliveryZone", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticBxgy", "ofType": null }, { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreation", "ofType": null }, { "kind": "OBJECT", "name": "Domain", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrderLineItem", "ofType": null }, { "kind": "OBJECT", "name": "DraftOrderTag", "ofType": null }, { "kind": "OBJECT", "name": "Duty", "ofType": null }, { "kind": "OBJECT", "name": "ExchangeLineItem", "ofType": null }, { "kind": "OBJECT", "name": "ExchangeV2", "ofType": null }, { "kind": "OBJECT", "name": "ExternalVideo", "ofType": null }, { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentConstraintRule", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentEvent", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderDestination", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderLineItem", "ofType": null }, { "kind": "OBJECT", "name": "FulfillmentOrderMerchantRequest", "ofType": null }, { "kind": "OBJECT", "name": "GenericFile", "ofType": null }, { "kind": "OBJECT", "name": "GiftCard", "ofType": null }, { "kind": "OBJECT", "name": "InventoryAdjustmentGroup", "ofType": null }, { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, { "kind": "OBJECT", "name": "InventoryItemMeasurement", "ofType": null }, { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null }, { "kind": "OBJECT", "name": "InventoryQuantity", "ofType": null }, { "kind": "OBJECT", "name": "LineItem", "ofType": null }, { "kind": "OBJECT", "name": "LineItemMutable", "ofType": null }, { "kind": "OBJECT", "name": "Location", "ofType": null }, { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, { "kind": "OBJECT", "name": "Market", "ofType": null }, { "kind": "OBJECT", "name": "MarketCatalog", "ofType": null }, { "kind": "OBJECT", "name": "MarketRegionCountry", "ofType": null }, { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null }, { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null }, { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, { "kind": "OBJECT", "name": "Metafield", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null }, { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, { "kind": "OBJECT", "name": "Model3d", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreArticle", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStoreBlog", "ofType": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "ofType": null }, { "kind": "OBJECT", "name": "Order", "ofType": null }, { "kind": "OBJECT", "name": "OrderDisputeSummary", "ofType": null }, { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null }, { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, { "kind": "OBJECT", "name": "PaymentMandate", "ofType": null }, { "kind": "OBJECT", "name": "PaymentSchedule", "ofType": null }, { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null }, { "kind": "OBJECT", "name": "PaymentTermsTemplate", "ofType": null }, { "kind": "OBJECT", "name": "PriceList", "ofType": null }, { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null }, { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null }, { "kind": "OBJECT", "name": "ProductFeed", "ofType": null }, { "kind": "OBJECT", "name": "ProductOption", "ofType": null }, { "kind": "OBJECT", "name": "ProductOptionValue", "ofType": null }, { "kind": "OBJECT", "name": "ProductSetOperation", "ofType": null }, { "kind": "OBJECT", "name": "ProductTaxonomyNode", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, { "kind": "OBJECT", "name": "ProductVariantComponent", "ofType": null }, { "kind": "OBJECT", "name": "Publication", "ofType": null }, { "kind": "OBJECT", "name": "PublicationResourceOperation", "ofType": null }, { "kind": "OBJECT", "name": "QuantityPriceBreak", "ofType": null }, { "kind": "OBJECT", "name": "Refund", "ofType": null }, { "kind": "OBJECT", "name": "RefundShippingLine", "ofType": null }, { "kind": "OBJECT", "name": "Return", "ofType": null }, { "kind": "OBJECT", "name": "ReturnLineItem", "ofType": null }, { "kind": "OBJECT", "name": "ReturnableFulfillment", "ofType": null }, { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null }, { "kind": "OBJECT", "name": "ReverseDeliveryLineItem", "ofType": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "ofType": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposition", "ofType": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "ofType": null }, { "kind": "OBJECT", "name": "SaleAdditionalFee", "ofType": null }, { "kind": "OBJECT", "name": "SavedSearch", "ofType": null }, { "kind": "OBJECT", "name": "ScriptTag", "ofType": null }, { "kind": "OBJECT", "name": "Segment", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlan", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, { "kind": "OBJECT", "name": "ServerPixel", "ofType": null }, { "kind": "OBJECT", "name": "ShippingLabel", "ofType": null }, { "kind": "OBJECT", "name": "Shop", "ofType": null }, { "kind": "OBJECT", "name": "ShopAddress", "ofType": null }, { "kind": "OBJECT", "name": "ShopPolicy", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsAccount", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransaction", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccount", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEvidence", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFulfillment", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayout", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsVerification", "ofType": null }, { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplate", "ofType": null }, { "kind": "OBJECT", "name": "StorefrontAccessToken", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyAttribute", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyCategory", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyChoiceListAttribute", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyMeasurementAttribute", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyValue", "ofType": null }, { "kind": "OBJECT", "name": "TenderTransaction", "ofType": null }, { "kind": "OBJECT", "name": "TransactionFee", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null }, { "kind": "OBJECT", "name": "UrlRedirectImport", "ofType": null }, { "kind": "OBJECT", "name": "Validation", "ofType": null }, { "kind": "OBJECT", "name": "Video", "ofType": null }, { "kind": "OBJECT", "name": "WebPixel", "ofType": null }, { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "ObjectDimensionsInput", "description": "The input fields for dimensions of an object.", "fields": null, "inputFields": [ { "name": "length", "description": "The length in `unit`s.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "width", "description": "The width in `unit`s.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "height", "description": "The height in `unit`s.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "unit", "description": "Unit of measurement for `length`, `width`, and `height`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LengthUnit", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OnlineStoreArticle", "description": "An article in the blogging system. You can query articles from\n[the REST API](https://shopify.dev/api/admin-rest/latest/resources/article)\nif you need to access more information about an article. Currently, `OnlineStoreArticle` is\nonly useful to pass an article `id` to the `tagsAdd` mutation. For more information, refer to\nthe [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation.\n", "fields": [ { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OnlineStoreBlog", "description": "Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant\nto be used as a type of magazine or newsletter for the shop, with content that changes over time.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OnlineStorePage", "description": "A custom page on the Online Store.", "fields": [ { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "OnlineStorePreviewable", "description": "Online Store preview URL of the object.", "fields": [ { "name": "onlineStorePreviewUrl", "description": "The online store preview URL.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Product", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "OptionCreateInput", "description": "The input fields for creating a product option.", "fields": null, "inputFields": [ { "name": "name", "description": "Name of the option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "position", "description": "Position of the option.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "values", "description": "Values associated with the option.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionValueCreateInput", "ofType": null } } }, "defaultValue": null }, { "name": "linkedMetafield", "description": "Specifies the metafield the option is linked to.", "type": { "kind": "INPUT_OBJECT", "name": "LinkedMetafieldCreateInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionReorderInput", "description": "The input fields for reordering a product option and/or its values.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option to reorder by ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Specifies the product option to reorder by name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "values", "description": "Values associated with the option.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionValueReorderInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionSetInput", "description": "The input fields for creating or updating a product option.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option to update.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Name of the option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "position", "description": "Position of the option.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "values", "description": "Value associated with an option.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionValueSetInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionUpdateInput", "description": "The input fields for updating a product option.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "Name of the option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "position", "description": "Position of the option.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "linkedMetafield", "description": "Specifies the metafield the option is linked to.", "type": { "kind": "INPUT_OBJECT", "name": "LinkedMetafieldUpdateInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionValueCreateInput", "description": "The input fields required to create a product option value.", "fields": null, "inputFields": [ { "name": "name", "description": "Value associated with an option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "linkedMetafieldValue", "description": "Metafield value associated with an option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionValueReorderInput", "description": "The input fields for reordering a product option value.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option value by ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Specifies the product option value by name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionValueSetInput", "description": "The input fields for creating or updating a product option value.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option value.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Value associated with an option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OptionValueUpdateInput", "description": "The input fields for updating a product option value.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option value.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "Value associated with an option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "linkedMetafieldValue", "description": "Metafield value associated with an option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Order", "description": "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.\nLearn more about\n[editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).\n\nOnly 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,\nthen you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted\naccess, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`.\n[Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.\n\n**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.\n", "fields": [ { "name": "additionalFees", "description": "A list of addtional fees applied to the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AdditionalFee", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "agreements", "description": "A list of sales agreements associated with the order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| happened_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesAgreementConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "alerts", "description": "A list of messages that appear on the order page in the Shopify admin.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourceAlert", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "The application that created the order.", "args": [], "type": { "kind": "OBJECT", "name": "OrderApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddress", "description": "The billing address of the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddressMatchesShippingAddress", "description": "Whether the billing address matches the shipping address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canMarkAsPaid", "description": "Whether the order can be manually marked as paid.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canNotifyCustomer", "description": "Whether a customer email exists for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancelReason", "description": "The reason provided when the order was canceled.\nReturns `null` if the order wasn't canceled.\n", "args": [], "type": { "kind": "ENUM", "name": "OrderCancelReason", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancellation", "description": "Cancellation details for the order.", "args": [], "type": { "kind": "OBJECT", "name": "OrderCancellation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancelledAt", "description": "The date and time when the order was canceled.\nReturns `null` if the order wasn't canceled.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "capturable", "description": "Whether payment for the order can be captured.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartDiscountAmount", "description": "The total order-level discount amount, before returns, in shop currency.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `cartDiscountAmountSet` instead." }, { "name": "cartDiscountAmountSet", "description": "The total order-level discount amount, before returns, in shop and presentment currencies.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "channel", "description": "The channel that created the order.", "args": [], "type": { "kind": "OBJECT", "name": "Channel", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publication` instead." }, { "name": "channelInformation", "description": "Details about the channel that created the order.", "args": [], "type": { "kind": "OBJECT", "name": "ChannelInformation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "clientIp", "description": "The IP address of the API client that created the order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "closed", "description": "Whether the order is closed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "closedAt", "description": "The date and time when the order was closed.\nReturns `null` if the order isn't closed.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "confirmationNumber", "description": "A randomly generated alpha-numeric identifier for the order that may be shown to the customer\ninstead of the sequential order name. For example, \"XPAV284CT\", \"R50KELTJP\" or \"35PKUN0UJ\".\nThis value isn't guaranteed to be unique.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "confirmed", "description": "Whether inventory has been reserved for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "Date and time when the order was created in Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The shop currency when the order was placed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentCartDiscountAmountSet", "description": "The current order-level discount amount after all order updates, in shop and presentment currencies.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentSubtotalLineItemsQuantity", "description": "The sum of the quantities for all line items that contribute to the order's current subtotal price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentSubtotalPriceSet", "description": "The sum of the prices for all line items after discounts and returns, in shop and presentment currencies.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTaxLines", "description": "A list of all tax lines applied to line items on the order, after returns.\nTax line prices represent the total price for all tax lines with the same `rate` and `title`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalAdditionalFeesSet", "description": "The total amount of additional fees after returns, in shop and presentment currencies.\nReturns `null` if there are no additional fees for the order.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalDiscountsSet", "description": "The total amount discounted on the order after returns, in shop and presentment currencies.\nThis includes both order and line level discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalDutiesSet", "description": "The total amount of duties after returns, in shop and presentment currencies.\nReturns `null` if duties aren't applicable.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalPriceSet", "description": "The total price of the order, after returns, in shop and presentment currencies.\nThis includes taxes and discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalTaxSet", "description": "The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentTotalWeight", "description": "The total weight of the order after returns, in grams.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of the custom attributes added to the order.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer that placed the order.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerAcceptsMarketing", "description": "Whether the customer agreed to receive marketing materials.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerJourney", "description": "The customer's visits and interactions with the online store before placing the order.\n", "args": [], "type": { "kind": "OBJECT", "name": "CustomerJourney", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary` instead." }, { "name": "customerJourneySummary", "description": "The customer's visits and interactions with the online store before placing the order.\n", "args": [], "type": { "kind": "OBJECT", "name": "CustomerJourneySummary", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerLocale", "description": "A two-letter or three-letter language code, optionally followed by a region modifier.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountApplications", "description": "A list of discounts that are applied to the order, not including order edits and refunds.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountApplicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCode", "description": "The discount code used for the order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodes", "description": "The discount codes used for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayAddress", "description": "The primary address of the customer.\nReturns `null` if neither the shipping address nor the billing address was provided.\n", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayFinancialStatus", "description": "The financial status of the order that can be shown to the merchant.\nThis field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes.\n", "args": [], "type": { "kind": "ENUM", "name": "OrderDisplayFinancialStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayFulfillmentStatus", "description": "The fulfillment status for the order that can be shown to the merchant.\nThis field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderDisplayFulfillmentStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "disputes", "description": "A list of the disputes associated with the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderDisputeSummary", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "edited", "description": "Whether the order has had any edits applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The email address associated with the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "estimatedTaxes", "description": "Whether taxes on the order are estimated.\nThis field returns `false` when taxes on the order are finalized and aren't subject to any changes.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "events", "description": "A list of events associated with the order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "exchangeV2s", "description": "A list of ExchangeV2s for the order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| completed_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeV2Connection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillable", "description": "Whether there are line items that can be fulfilled.\nThis field returns `false` when the order has no fulfillable line items.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrders", "description": "A list of fulfillment orders for a specific order.\n\n[FulfillmentOrder API access scopes](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder#api-access-scopes)\ngovern which fulfillments orders are returned.\nAn API client will only receive a subset of the fulfillment orders which belong to an order\nif they don't have the necessary access scopes to view all of the fulfillment orders.\nIn the case that an API client does not have the access scopes necessary to view\nany of the fulfillment orders that belong to an order, an empty array will be returned.\n", "args": [ { "name": "displayable", "description": "Whether fulfillment orders that are hidden from the merchant are included.\nFor example, fulfillment orders that were closed after being combined or moved are hidden.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| assigned_location_id |\n| status |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillments", "description": "List of shipments for the order.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fullyPaid", "description": "Whether the order has been paid in full.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Whether the merchant added a timeline comment to the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "landingPageDisplayText", "description": "The URL of the first page of the online store that the customer visited before they submitted the order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary.lastVisit.landingPageHtml` instead" }, { "name": "landingPageUrl", "description": "The first page of the online store that the customer visited before they submitted the order.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary.lastVisit.landingPage` instead" }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "A list of the order's line items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItemsMutable", "description": "A list of the order's line items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemMutableConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `lineItems` instead." }, { "name": "localizationExtensions", "description": "List of localization extensions for the resource.", "args": [ { "name": "countryCodes", "description": "The country codes of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "purposes", "description": "The purpose of the extensions.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizationExtensionPurpose", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocalizationExtensionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The fulfillment location that was assigned when the order was created.\nOrders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.location` field will only point to one of these locations.\nUse the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder)\nobject for up-to-date fulfillment location information.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `physicalLocation` instead." }, { "name": "merchantEditable", "description": "Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantEditableErrors", "description": "A list of reasons why the order can't be edited. For example, \"Canceled orders can't be edited\".", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantOfRecordApp", "description": "The application acting as the Merchant of Record for the order.", "args": [], "type": { "kind": "OBJECT", "name": "OrderApp", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page.\nFor example, \"#1001\", \"EN1001\", or \"1001-A\".\nThis value isn't unique across multiple stores.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "netPayment", "description": "The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `netPaymentSet` instead." }, { "name": "netPaymentSet", "description": "The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nonFulfillableLineItems", "description": "A list of line items that can't be fulfilled.\nFor example, tips and fully refunded line items can't be fulfilled.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The contents of the note associated with the order.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalAdditionalFeesSet", "description": "The total amount of additional fees after returns, in shop and presentment currencies.\nReturns `null` if there are no additional fees for the order.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalDutiesSet", "description": "The total amount of duties before returns, in shop and presentment currencies.\nReturns `null` if duties aren't applicable.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalTotalPriceSet", "description": "The total price of the order at the time of order creation, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCollectionDetails", "description": "The payment collection details for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderPaymentCollectionDetails", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentGatewayNames", "description": "A list of the names of all payment gateways used for the order.\nFor example, \"Shopify Payments\" and \"Cash on Delivery (COD)\".\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTerms", "description": "The payment terms associated with the order.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number associated with the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "physicalLocation", "description": "The fulfillment location that was assigned when the order was created.\nOrders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.physicalLocation` field will only point to one of these locations.\nUse the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder)\nobject for up to date fulfillment location information.\n", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `fulfillmentOrders` to get the fulfillment location for the order" }, { "name": "poNumber", "description": "The PO number associated with the order.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentCurrencyCode", "description": "The payment `CurrencyCode` of the customer for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "processedAt", "description": "The date and time when the order was processed.\nThis date and time might not match the date and time when the order was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "The publication that the order was created from.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "purchasingEntity", "description": "The purchasing entity for the order.", "args": [], "type": { "kind": "UNION", "name": "PurchasingEntity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "referralCode", "description": "The marketing referral code from the link that the customer clicked to visit the store.\nSupports the following URL attributes: \"ref\", \"source\", or \"r\".\nFor example, if the URL is `{shop}.myshopify.com/products/slide?ref=j2tj1tn2`, then this value is `j2tj1tn2`.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary.lastVisit.referralCode` instead" }, { "name": "referrerDisplayText", "description": "A web domain or short description of the source that sent the customer to your online store. For example, \"shopify.com\" or \"email\".\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary.lastVisit.referralInfoHtml` instead" }, { "name": "referrerUrl", "description": "The URL of the webpage where the customer clicked a link that sent them to your online store.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `customerJourneySummary.lastVisit.referrerUrl` instead" }, { "name": "refundDiscrepancySet", "description": "The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundable", "description": "Whether the order can be refunded.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refunds", "description": "A list of refunds that have been applied to the order.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Refund", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "registeredSourceUrl", "description": "The URL of the source that the order originated from, if found in the domain registry.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether the order has shipping lines or at least one line item on the order that requires shipping.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockable", "description": "Whether any line item on the order can be restocked.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnStatus", "description": "The order's aggregated return status for display purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderReturnStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns", "description": "A list of returns for the order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| status |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "risk", "description": "The risk characteristics for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderRiskSummary", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "riskLevel", "description": "The fraud risk level of the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderRiskLevel", "ofType": null } }, "isDeprecated": true, "deprecationReason": "This field is deprecated in version 2024-04. Please use OrderRiskAssessment.riskLevel" }, { "name": "risks", "description": "A list of risks associated with the order.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderRisk", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "This field is deprecated in version 2024-04. Please use OrderRiskAssessment" }, { "name": "shippingAddress", "description": "The mailing address of the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLine", "description": "A summary of all shipping costs on the order.", "args": [], "type": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLines", "description": "A list of the order's shipping lines.", "args": [ { "name": "includeRemovals", "description": "Whether results should contain removed shipping lines.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyProtect", "description": "The Shopify Protect details for the order. If Shopify Protect is disabled for the shop, then this will be null.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyProtectOrderSummary", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceIdentifier", "description": "A unique POS or third party order identifier.\nFor example, \"1234-12-1000\" or \"111-98567-54\". The `receipt_number` field is derived from this value for POS orders.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalLineItemsQuantity", "description": "The sum of the quantities for all line items that contribute to the order's subtotal price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotalPrice", "description": "The sum of the prices for all line items after discounts and before returns, in shop currency.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `subtotalPriceSet` instead." }, { "name": "subtotalPriceSet", "description": "The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "suggestedRefund", "description": "A suggested refund for the order.", "args": [ { "name": "shippingAmount", "description": "The amount to refund for shipping. Overrides the `refundShipping` argument.\nUse the `shippingAmountV2` argument for multi-currency orders.\n", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "refundShipping", "description": "Whether to refund the full shipping amount.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "refundLineItems", "description": "The line items from the order to include in the refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundLineItemInput", "ofType": null } } }, "defaultValue": null }, { "name": "refundDuties", "description": "The duties from the order to include in the refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundDutyInput", "ofType": null } } }, "defaultValue": null }, { "name": "suggestFullRefund", "description": "Whether the suggested refund should be created from all refundable line items on the order.\nIf `true`, the `refundLineItems` argument will be ignored.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "SuggestedRefund", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tags", "description": "A comma separated list of tags associated with the order. Updating `tags` overwrites\nany existing tags that were previously added to the order. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxExempt", "description": "Whether taxes are exempt on the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "A list of all tax lines applied to line items on the order, before returns.\nTax line prices represent the total price for all tax lines with the same `rate` and `title`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxesIncluded", "description": "Whether taxes are included in the subtotal price of the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the order is a test.\nTest orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.\nA test order can't be converted into a real order and vice versa.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCapturable", "description": "The authorized amount that's uncaptured or undercaptured, in shop currency.\nThis amount isn't adjusted for returns.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalCapturableSet` instead." }, { "name": "totalCapturableSet", "description": "The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies.\nThis amount isn't adjusted for returns.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscounts", "description": "The total amount discounted on the order before returns, in shop currency.\nThis includes both order and line level discounts.\n", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `totalDiscountsSet` instead." }, { "name": "totalDiscountsSet", "description": "The total amount discounted on the order before returns, in shop and presentment currencies.\nThis includes both order and line level discounts.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalOutstandingSet", "description": "The total amount not yet transacted for the order, in shop and presentment currencies.\nA positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalPrice", "description": "The total price of the order, before returns, in shop currency.\nThis includes taxes and discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalPriceSet` instead." }, { "name": "totalPriceSet", "description": "The total price of the order, before returns, in shop and presentment currencies.\nThis includes taxes and discounts.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalReceived", "description": "The total amount received from the customer before returns, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalReceivedSet` instead." }, { "name": "totalReceivedSet", "description": "The total amount received from the customer before returns, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalRefunded", "description": "The total amount that was refunded, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalRefundedSet` instead." }, { "name": "totalRefundedSet", "description": "The total amount that was refunded, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalRefundedShippingSet", "description": "The total amount of shipping that was refunded, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalShippingPrice", "description": "The total shipping amount before discounts and returns, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalShippingPriceSet` instead." }, { "name": "totalShippingPriceSet", "description": "The total shipping amount before discounts and returns, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTax", "description": "The total tax amount before returns, in shop currency.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `totalTaxSet` instead." }, { "name": "totalTaxSet", "description": "The total tax amount before returns, in shop and presentment currencies.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTipReceived", "description": "The sum of all tip amounts for the order, in shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalTipReceivedSet` instead." }, { "name": "totalTipReceivedSet", "description": "The sum of all tip amounts for the order, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalWeight", "description": "The total weight of the order before returns, in grams.", "args": [], "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactions", "description": "A list of transactions associated with the order.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "capturable", "description": "Filter transactions by whether they are capturable.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "manuallyResolvable", "description": "Filter transactions by whether they can be resolved manually.\nFor example, fully captured or voided transactions aren't manually resolvable.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unpaid", "description": "Whether no payments have been made for the order.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the order was modified last.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "HasLocalizationExtensions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderActionType", "description": "The possible order action types for a\n[sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ORDER", "description": "An order with a purchase or charge.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_EDIT", "description": "An edit to the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUND", "description": "A refund on the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURN", "description": "A return on the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "An unknown agreement action. Represents new actions that may be added in future versions.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderAgreement", "description": "An agreement associated with an order placement.", "fields": [ { "name": "app", "description": "The application that created the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The date and time at which the agreement occured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the agremeent was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The sales associated with the agreement.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member associated with the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderApp", "description": "The [application](https://shopify.dev/apps) that created the order.\n", "fields": [ { "name": "icon", "description": "The application icon.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The application ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCancelPayload", "description": "Return type for `orderCancel` mutation.", "fields": [ { "name": "job", "description": "The job that asynchronously cancels the order.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderCancelUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderCancelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `orderCancelUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderCancelReason", "description": "Represents the reason for the order's cancellation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CUSTOMER", "description": "The customer wanted to cancel the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "DECLINED", "description": "Payment was declined.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAUD", "description": "The order was fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY", "description": "There was insufficient inventory.", "isDeprecated": false, "deprecationReason": null }, { "name": "STAFF", "description": "Staff made an error.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The order was canceled for an unlisted reason.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCancelUserError", "description": "Errors related to order cancellation.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderCancelUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderCancelUserErrorCode", "description": "Possible error codes that can be returned by `OrderCancelUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NO_REFUND_PERMISSION", "description": "An order refund was requested but the user does not have the refund_orders permission.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The record with the ID used as the input value couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCancellation", "description": "Details about the order cancellation.", "fields": [ { "name": "staffNote", "description": "Staff provided note for the order cancellation.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderCaptureInput", "description": "The input fields for the authorized transaction to capture and the total amount to capture from it.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the order to capture.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "parentTransactionId", "description": "The ID of the authorized transaction to capture.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "amount", "description": "The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "defaultValue": null }, { "name": "currency", "description": "The currency (in ISO format) that's used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.", "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCapturePayload", "description": "Return type for `orderCapture` mutation.", "fields": [ { "name": "transaction", "description": "The created capture transaction.", "args": [], "type": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderCloseInput", "description": "The input fields for specifying an open order to close.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the order to close.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderClosePayload", "description": "Return type for `orderClose` mutation.", "fields": [ { "name": "order", "description": "The closed order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderConnection", "description": "An auto-generated type for paginating through multiple Orders.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in OrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCreateMandatePaymentPayload", "description": "Return type for `orderCreateMandatePayment` mutation.", "fields": [ { "name": "job", "description": "The async job used for charging the payment.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentReferenceId", "description": "The Unique ID for the created payment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderCreateMandatePaymentUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderCreateMandatePaymentUserError", "description": "An error that occurs during the execution of `OrderCreateMandatePayment`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderCreateMandatePaymentUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderCreateMandatePaymentUserErrorCode", "description": "Possible error codes that can be returned by `OrderCreateMandatePaymentUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ORDER_MANDATE_PAYMENT_ERROR_CODE", "description": "Errors for mandate payment on order.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "OrderDisplayFinancialStatus", "description": "Represents the order's current financial status.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "Displayed as **Pending**.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHORIZED", "description": "Displayed as **Authorized**.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARTIALLY_PAID", "description": "Displayed as **Partially paid**.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARTIALLY_REFUNDED", "description": "Displayed as **Partially refunded**.", "isDeprecated": false, "deprecationReason": null }, { "name": "VOIDED", "description": "Displayed as **Voided**.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAID", "description": "Displayed as **Paid**.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUNDED", "description": "Displayed as **Refunded**.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "Displayed as **Expired**.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "OrderDisplayFulfillmentStatus", "description": "Represents the order's aggregated fulfillment status for display purposes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNFULFILLED", "description": "Displayed as **Unfulfilled**. None of the items in the order have been fulfilled.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARTIALLY_FULFILLED", "description": "Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLED", "description": "Displayed as **Fulfilled**. All the items in the order have been fulfilled.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESTOCKED", "description": "Displayed as **Restocked**. All the items in the order have been restocked. Replaced by the \"UNFULFILLED\" status.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING_FULFILLMENT", "description": "Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by the \"IN_PROGRESS\" status.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPEN", "description": "Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by \"UNFULFILLED\" status.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_PROGRESS", "description": "Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "ON_HOLD", "description": "Displayed as **On hold**. All of the unfulfilled items in this order are on hold.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderDisputeSummary", "description": "A summary of the important details for a dispute on an order.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "initiatedAs", "description": "The type that the dispute was initiated as.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DisputeType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current status of the dispute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DisputeStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEdge", "description": "An auto-generated type which holds one Order and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of OrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAddCustomItemPayload", "description": "Return type for `orderEditAddCustomItem` mutation.", "fields": [ { "name": "calculatedLineItem", "description": "The custom line item that will be added to the order based on the current edits.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAddLineItemDiscountPayload", "description": "Return type for `orderEditAddLineItemDiscount` mutation.", "fields": [ { "name": "addedDiscountStagedChange", "description": "The discount applied to a line item during this order edit.", "args": [], "type": { "kind": "OBJECT", "name": "OrderStagedChangeAddLineItemDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedLineItem", "description": "The line item with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderEditAddShippingLineInput", "description": "The input fields used to add a shipping line.", "fields": null, "inputFields": [ { "name": "price", "description": "The price of the shipping line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "title", "description": "The title of the shipping line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAddShippingLinePayload", "description": "Return type for `orderEditAddShippingLine` mutation.", "fields": [ { "name": "calculatedOrder", "description": "The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nwith the edits applied but not saved.\n", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedShippingLine", "description": "The [calculated shipping line](https://shopify.dev/api/admin-graphql/latest/objects/calculatedshippingline)\nthat's added during this order edit.\n", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedShippingLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEditAddShippingLineUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAddShippingLineUserError", "description": "An error that occurs during the execution of `OrderEditAddShippingLine`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderEditAddShippingLineUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderEditAddShippingLineUserErrorCode", "description": "Possible error codes that can be returned by `OrderEditAddShippingLineUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAddVariantPayload", "description": "Return type for `orderEditAddVariant` mutation.", "fields": [ { "name": "calculatedLineItem", "description": "The [calculated line item](https://shopify.dev/api/admin-graphql/latest/objects/calculatedlineitem)\nthat's added during this order edit.\n", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedOrder", "description": "The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nwith the edits applied but not saved.\n", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditAgreement", "description": "An agreement associated with an edit to the order.", "fields": [ { "name": "app", "description": "The application that created the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The date and time at which the agreement occured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the agremeent was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The sales associated with the agreement.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member associated with the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderEditAppliedDiscountInput", "description": "The input fields used to add a discount during an order edit.", "fields": null, "inputFields": [ { "name": "description", "description": "The description of the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "fixedValue", "description": "The value of the discount as a fixed amount.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "percentValue", "description": "The value of the discount as a percentage.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditBeginPayload", "description": "Return type for `orderEditBegin` mutation.", "fields": [ { "name": "calculatedOrder", "description": "The order that will be edited.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditCommitPayload", "description": "Return type for `orderEditCommit` mutation.", "fields": [ { "name": "order", "description": "The order with changes applied.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditRemoveDiscountPayload", "description": "Return type for `orderEditRemoveDiscount` mutation.", "fields": [ { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEditRemoveDiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditRemoveDiscountUserError", "description": "An error that occurs during the execution of `OrderEditRemoveDiscount`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderEditRemoveDiscountUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderEditRemoveDiscountUserErrorCode", "description": "Possible error codes that can be returned by `OrderEditRemoveDiscountUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditRemoveLineItemDiscountPayload", "description": "Return type for `orderEditRemoveLineItemDiscount` mutation.", "fields": [ { "name": "calculatedLineItem", "description": "The calculated line item after removal of the discount.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditRemoveShippingLinePayload", "description": "Return type for `orderEditRemoveShippingLine` mutation.", "fields": [ { "name": "calculatedOrder", "description": "The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nwith the edits applied but not saved.\n", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEditRemoveShippingLineUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditRemoveShippingLineUserError", "description": "An error that occurs during the execution of `OrderEditRemoveShippingLine`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderEditRemoveShippingLineUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderEditRemoveShippingLineUserErrorCode", "description": "Possible error codes that can be returned by `OrderEditRemoveShippingLineUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditSetQuantityPayload", "description": "Return type for `orderEditSetQuantity` mutation.", "fields": [ { "name": "calculatedLineItem", "description": "The calculated line item with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedLineItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "calculatedOrder", "description": "The calculated order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditUpdateDiscountPayload", "description": "Return type for `orderEditUpdateDiscount` mutation.", "fields": [ { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEditUpdateDiscountUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditUpdateDiscountUserError", "description": "An error that occurs during the execution of `OrderEditUpdateDiscount`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderEditUpdateDiscountUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderEditUpdateDiscountUserErrorCode", "description": "Possible error codes that can be returned by `OrderEditUpdateDiscountUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderEditUpdateShippingLineInput", "description": "The input fields used to update a shipping line.", "fields": null, "inputFields": [ { "name": "price", "description": "The price of the shipping line.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the shipping line.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditUpdateShippingLinePayload", "description": "Return type for `orderEditUpdateShippingLine` mutation.", "fields": [ { "name": "calculatedOrder", "description": "An order with the edits applied but not saved.", "args": [], "type": { "kind": "OBJECT", "name": "CalculatedOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderEditUpdateShippingLineUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderEditUpdateShippingLineUserError", "description": "An error that occurs during the execution of `OrderEditUpdateShippingLine`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderEditUpdateShippingLineUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderEditUpdateShippingLineUserErrorCode", "description": "Possible error codes that can be returned by `OrderEditUpdateShippingLineUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderInput", "description": "The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the order to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "A new customer email address for the order. Overwrites the existing email address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "The new contents for the note associated with the order. Overwrites the existing note.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "A new list of tags for the order. Overwrites the existing tags.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "shippingAddress", "description": "The new shipping address for the order. Overwrites the existing shipping address.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "customAttributes", "description": "A new list of custom attributes for the order. Overwrites the existing custom attributes.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null }, { "name": "metafields", "description": "A list of new metafields to add to the existing metafields for the order.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "localizationExtensions", "description": "A list of new [localization extensions](https://shopify.dev/api/admin-graphql/latest/objects/localizationextension) to add to the existing list of localization extensions for the order.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "LocalizationExtensionInput", "ofType": null } } }, "defaultValue": null }, { "name": "poNumber", "description": "The new purchase order number for the order.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderInvoiceSendPayload", "description": "Return type for `orderInvoiceSend` mutation.", "fields": [ { "name": "order", "description": "The order associated with the invoice email.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderInvoiceSendUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderInvoiceSendUserError", "description": "An error that occurs during the execution of `OrderInvoiceSend`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderInvoiceSendUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderInvoiceSendUserErrorCode", "description": "Possible error codes that can be returned by `OrderInvoiceSendUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ORDER_INVOICE_SEND_UNSUCCESSFUL", "description": "An error occurred while sending the invoice.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderMarkAsPaidInput", "description": "The input fields for specifying the order to mark as paid.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the order to mark as paid.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderMarkAsPaidPayload", "description": "Return type for `orderMarkAsPaid` mutation.", "fields": [ { "name": "order", "description": "The order marked as paid.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderOpenInput", "description": "The input fields for specifying a closed order to open.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the order to open.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderOpenPayload", "description": "Return type for `orderOpen` mutation.", "fields": [ { "name": "order", "description": "The opened order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderPaymentCollectionDetails", "description": "The payment collection details for an order that requires additional payment following an edit to the order.", "fields": [ { "name": "additionalPaymentCollectionUrl", "description": "The URL to use for collecting an additional payment on the order.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vaultedPaymentMethods", "description": "The list of vaulted payment methods for the order with their permissions.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentMandate", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderPaymentStatus", "description": "The status of a customer's payment for an order.", "fields": [ { "name": "errorMessage", "description": "A message describing an error during the asynchronous processing of a payment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentReferenceId", "description": "The ID of the payment, initially returned by an `orderCreateMandatePayment` or `orderCreatePayment` mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the payment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderPaymentStatusResult", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactions", "description": "The transaction associated with the payment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatedErrorMessage", "description": "A translated message describing an error during the asynchronous processing of a payment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderPaymentStatusResult", "description": "The type of a payment status.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUCCESS", "description": "The payment succeeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHORIZED", "description": "The payment is authorized.", "isDeprecated": false, "deprecationReason": null }, { "name": "VOIDED", "description": "The payment is voided.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUNDED", "description": "The payment is refunded.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPTURED", "description": "The payment is captured.", "isDeprecated": false, "deprecationReason": null }, { "name": "PURCHASED", "description": "The payment is in purchased status.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERROR", "description": "There was an error initiating the payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING", "description": "The payment is still being processed.", "isDeprecated": false, "deprecationReason": null }, { "name": "REDIRECT_REQUIRED", "description": "Redirect required.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETRYABLE", "description": "Payment can be retried.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "Status is unknown.", "isDeprecated": false, "deprecationReason": null }, { "name": "INITIATED", "description": "The payment is awaiting processing.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The payment is pending with the provider, and may take a while.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "OrderReturnStatus", "description": "The order's aggregated return status that's used for display purposes.\nAn order might have multiple returns, so this field communicates the prioritized return status.\nThe `OrderReturnStatus` enum is a supported filter parameter in the [`orders` query](https://shopify.dev/api/admin-graphql/latest/queries/orders#:~:text=reference_location_id-,return_status,-risk_level).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "IN_PROGRESS", "description": "Some items in the order are being returned.", "isDeprecated": false, "deprecationReason": null }, { "name": "INSPECTION_COMPLETE", "description": "All return shipments from a return in this order were inspected.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_RETURN", "description": "No items in the order were returned.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNED", "description": "Some items in the order were returned.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURN_FAILED", "description": "Some returns in the order were not completed successfully.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURN_REQUESTED", "description": "A return was requested for some items in the order.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderRisk", "description": "Represents a fraud check on an order.\nAs of version 2024-04 this resource is deprecated. Risk Assessments can be queried via the\n[OrderRisk Assessments API](https://shopify.dev/api/admin-graphql/2024-04/objects/OrderRiskAssessment).\n", "fields": [ { "name": "display", "description": "Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "This field is deprecated in version 2024-04" }, { "name": "level", "description": "The likelihood that an order is fraudulent, based on this order risk.\n\nThe level can be set by Shopify risk analysis or by an app.\n", "args": [], "type": { "kind": "ENUM", "name": "OrderRiskLevel", "ofType": null }, "isDeprecated": true, "deprecationReason": "This field is deprecated in version 2024-04. Please use OrderRiskAssessment.riskLevel" }, { "name": "message", "description": "The risk message that's shown to the merchant in the Shopify admin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "This field is deprecated in version 2024-04" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderRiskAssessment", "description": "The risk assessments for an order.", "fields": [ { "name": "facts", "description": "Optional facts used to describe the risk assessment. The values in here are specific to the provider.\nSee the [examples for the mutation orderRiskAssessmentCreate](https://shopify.dev/api/admin-graphql/unstable/mutations/orderRiskAssessmentCreate#section-examples).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RiskFact", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "provider", "description": "The app that provided the assessment, `null` if the assessment was provided by Shopify.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "riskLevel", "description": "The likelihood that the order is fraudulent, based on this risk assessment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RiskAssessmentResult", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderRiskAssessmentCreateInput", "description": "The input fields for an order risk assessment.", "fields": null, "inputFields": [ { "name": "orderId", "description": "The ID of the order receiving the fraud assessment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "riskLevel", "description": "The risk level of the fraud assessment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RiskAssessmentResult", "ofType": null } }, "defaultValue": null }, { "name": "facts", "description": "The list of facts used to determine the fraud assessment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderRiskAssessmentFactInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderRiskAssessmentCreatePayload", "description": "Return type for `orderRiskAssessmentCreate` mutation.", "fields": [ { "name": "orderRiskAssessment", "description": "The order risk assessment created.", "args": [], "type": { "kind": "OBJECT", "name": "OrderRiskAssessment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderRiskAssessmentCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderRiskAssessmentCreateUserError", "description": "An error that occurs during the execution of `OrderRiskAssessmentCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "OrderRiskAssessmentCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderRiskAssessmentCreateUserErrorCode", "description": "Possible error codes that can be returned by `OrderRiskAssessmentCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOO_MANY_FACTS", "description": "Too many facts were provided for the risk assessment.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_ALREADY_FULFILLED", "description": "The order is marked as fulfilled and can no longer accept new risk assessments.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The record with the ID used as the input value couldn't be found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderRiskAssessmentFactInput", "description": "The input fields to create a fact on an order risk assessment.", "fields": null, "inputFields": [ { "name": "sentiment", "description": "Indicates whether the fact is a negative, neutral or positive contributor with regards to risk.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RiskFactSentiment", "ofType": null } }, "defaultValue": null }, { "name": "description", "description": "A description of the fact. Large values are truncated to 256 characters.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderRiskLevel", "description": "The likelihood that an order is fraudulent.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LOW", "description": "There is a low level of risk that this order is fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIUM", "description": "There is a medium level of risk that this order is fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "HIGH", "description": "There is a high level of risk that this order is fraudulent.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "OrderRiskRecommendationResult", "description": "List of possible values for an OrderRiskRecommendation recommendation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANCEL", "description": "Recommends cancelling the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVESTIGATE", "description": "Recommends investigating the order by contacting buyers.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACCEPT", "description": "Recommends fulfilling the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "There is no recommended action for the order.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderRiskSummary", "description": "Summary of risk characteristics for an order.", "fields": [ { "name": "assessments", "description": "The list of risk assessments for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderRiskAssessment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recommendation", "description": "The recommendation for the order based on the results of the risk assessments. This suggests the action the merchant should take with regards to its risk of fraud.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderRiskRecommendationResult", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderSortKeys", "description": "The set of valid sort keys for the Order query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_NAME", "description": "Sort by the `customer_name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "DESTINATION", "description": "Sort orders by their shipping address country and city.", "isDeprecated": false, "deprecationReason": null }, { "name": "FINANCIAL_STATUS", "description": "Sort by the `financial_status` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_STATUS", "description": "Sort by the `fulfillment_status` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_NUMBER", "description": "Sort by the `order_number` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSED_AT", "description": "Sort by the `processed_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_ITEMS_QUANTITY", "description": "Sort orders by the total quantity of all line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOTAL_PRICE", "description": "Sort by the `total_price` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PO_NUMBER", "description": "Sort orders by their purchase order number.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "OrderStagedChange", "description": "A change that has been applied to an order.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "OrderStagedChangeAddCustomItem", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddLineItemDiscount", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddShippingLine", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddVariant", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeDecrementItem", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeIncrementItem", "ofType": null }, { "kind": "OBJECT", "name": "OrderStagedChangeRemoveShippingLine", "ofType": null } ] }, { "kind": "OBJECT", "name": "OrderStagedChangeAddCustomItem", "description": "A change to the order representing the addition of a\ncustom line item. For example, you might want to add gift wrapping service\nas a custom line item.\n", "fields": [ { "name": "originalUnitPrice", "description": "The price of an individual item without any discounts applied. This value can't be negative.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the custom item to add to the order. This value must be greater than zero.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the custom item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddLineItemDiscount", "description": "The discount applied to an item that was added during the current order edit.\n", "fields": [ { "name": "description", "description": "The description of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The pricing value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddShippingLine", "description": "A new [shipping line](https://shopify.dev/api/admin-graphql/latest/objects/shippingline)\nadded as part of an order edit.\n", "fields": [ { "name": "phone", "description": "The phone number at the shipping address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The shipping line's title that's shown to the buyer.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price that applies to the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the shipping line.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeAddVariant", "description": "A change to the order representing the addition of an existing product variant.\n", "fields": [ { "name": "quantity", "description": "The quantity of the product variant that was added.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant that was added.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeConnection", "description": "An auto-generated type for paginating through multiple OrderStagedChanges.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderStagedChangeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in OrderStagedChangeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "OrderStagedChange", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeDecrementItem", "description": "An removal of items from an existing line item on the order.\n", "fields": [ { "name": "delta", "description": "The number of items removed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The original line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restock", "description": "The intention to restock the removed items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeEdge", "description": "An auto-generated type which holds one OrderStagedChange and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of OrderStagedChangeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "OrderStagedChange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeIncrementItem", "description": "An addition of items to an existing line item on the order.\n", "fields": [ { "name": "delta", "description": "The number of items added.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The original line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderStagedChangeRemoveShippingLine", "description": "A shipping line removed during an order edit.\n", "fields": [ { "name": "shippingLine", "description": "The removed shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderTransaction", "description": "A payment transaction in the context of an order.\n", "fields": [ { "name": "accountNumber", "description": "The masked account number associated with the payment method.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "amount", "description": "The amount of money.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountSet` instead." }, { "name": "amountSet", "description": "The amount and currency of the transaction in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "amountV2", "description": "The amount and currency of the transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountSet` instead." }, { "name": "authorizationCode", "description": "Authorization code associated with the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "authorizationExpiresAt", "description": "The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "Date and time when the transaction was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorCode", "description": "A standardized error code, independent of the payment provider.", "args": [], "type": { "kind": "ENUM", "name": "OrderTransactionErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fees", "description": "The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TransactionFee", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedGateway", "description": "The human-readable payment gateway name used to process the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gateway", "description": "The payment gateway used to process the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "kind", "description": "The kind of transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderTransactionKind", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "manuallyCapturable", "description": "Whether the transaction can be manually captured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumRefundable", "description": "Specifies the available amount to refund on the gateway.\nThis value is only available for transactions of type `SuggestedRefund`.\n", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `maximumRefundableV2` instead." }, { "name": "maximumRefundableV2", "description": "Specifies the available amount with currency to refund on the gateway.\nThis value is only available for transactions of type `SuggestedRefund`.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiCapturable", "description": "Whether the transaction can be captured multiple times.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The associated order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "parentTransaction", "description": "The associated parent transaction, for example the authorization of a capture.", "args": [], "type": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentDetails", "description": "The payment details for the transaction.", "args": [], "type": { "kind": "UNION", "name": "PaymentDetails", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentIcon", "description": "The payment icon to display for the transaction.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentId", "description": "The payment ID associated with the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentMethod", "description": "The payment method used for the transaction. This value is `null` if the payment method is unknown.", "args": [], "type": { "kind": "ENUM", "name": "PaymentMethods", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `paymentIcon` instead." }, { "name": "processedAt", "description": "Date and time when the transaction was processed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "receiptJson", "description": "The transaction receipt that the payment gateway attaches to the transaction.\nThe value of this field depends on which payment gateway processed the transaction.\n", "args": [], "type": { "kind": "SCALAR", "name": "JSON", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "settlementCurrency", "description": "The settlement currency.", "args": [], "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "settlementCurrencyRate", "description": "The rate used when converting the transaction amount to settlement currency.", "args": [], "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyPaymentsSet", "description": "Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan.\n", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsTransactionSet", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderTransactionStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the transaction is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalUnsettled", "description": "Specifies the available amount to capture on the gateway.\nOnly available when an amount is capturable or manually mark as paid.\n", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `totalUnsettledSet` instead." }, { "name": "totalUnsettledSet", "description": "Specifies the available amount with currency to capture on the gateway in shop and presentment currencies.\nOnly available when an amount is capturable or manually mark as paid.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalUnsettledV2", "description": "Specifies the available amount with currency to capture on the gateway.\nOnly available when an amount is capturable or manually mark as paid.\n", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `totalUnsettledSet` instead." }, { "name": "user", "description": "Staff member who was logged into the Shopify POS device when the transaction was processed.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderTransactionConnection", "description": "An auto-generated type for paginating through multiple OrderTransactions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransactionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in OrderTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderTransactionEdge", "description": "An auto-generated type which holds one OrderTransaction and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of OrderTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderTransactionErrorCode", "description": "A standardized error code, independent of the payment provider.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INCORRECT_NUMBER", "description": "The card number is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_NUMBER", "description": "The format of the card number is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_EXPIRY_DATE", "description": "The format of the expiry date is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CVC", "description": "The format of the CVC is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED_CARD", "description": "The card is expired.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_CVC", "description": "The CVC does not match the card number.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_ZIP", "description": "The ZIP or postal code does not match the card number.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_ADDRESS", "description": "The address does not match the card number.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_PIN", "description": "The entered PIN is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "CARD_DECLINED", "description": "The card was declined.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING_ERROR", "description": "There was an error while processing the payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "CALL_ISSUER", "description": "Call the card issuer.", "isDeprecated": false, "deprecationReason": null }, { "name": "PICK_UP_CARD", "description": "The card has been reported as lost or stolen, and the card issuer has requested that the merchant keep the card and call the number on the back.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFIG_ERROR", "description": "There is an error in the gateway or merchant configuration.", "isDeprecated": false, "deprecationReason": null }, { "name": "TEST_MODE_LIVE_CARD", "description": "A real card was used but the gateway was in test mode.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_FEATURE", "description": "The gateway or merchant configuration doesn't support a feature, such as network tokenization.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "There was an unknown error with processing the payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_COUNTRY", "description": "The payment method is not available in the customer's country.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_AMOUNT", "description": "The amount is either too high or too low for the provider.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_METHOD_UNAVAILABLE", "description": "The payment method is momentarily unavailable.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_INVALID_PAYMENT_METHOD", "description": "The payment method was invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_MAX_AMOUNT_CHARGED", "description": "The maximum amount has been captured.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_MAX_AMOUNT_REFUNDED", "description": "The maximum amount has been refunded.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTURED", "description": "The maximum of 10 authorizations has been captured for an order.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_MAX_REFUNDS_PROCESSED", "description": "The maximum of 10 refunds has been processed for an order.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_ORDER_REFERENCE_CANCELED", "description": "The order was canceled, which canceled all open authorizations.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMAZON_PAYMENTS_STALE", "description": "The order was not confirmed within three hours.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "OrderTransactionInput", "description": "The input fields for the information needed to create an order transaction.", "fields": null, "inputFields": [ { "name": "amount", "description": "The amount of money for this transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "defaultValue": null }, { "name": "gateway", "description": "The payment gateway to use for this transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "kind", "description": "The kind of transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderTransactionKind", "ofType": null } }, "defaultValue": null }, { "name": "orderId", "description": "The ID of the order associated with the transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "parentId", "description": "The ID of the optional parent transaction, for example the authorization of a capture.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "OrderTransactionKind", "description": "The different kinds of order transactions.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SALE", "description": "An authorization and capture performed together in a single step.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPTURE", "description": "A transfer of the money that was reserved by an authorization.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHORIZATION", "description": "An amount reserved against the cardholder's funding source.\nMoney does not change hands until the authorization is captured.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "VOID", "description": "A cancelation of an authorization transaction.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUND", "description": "A partial or full return of captured funds to the cardholder.\nA refund can happen only after a capture is processed.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "CHANGE", "description": "The money returned to the customer when they've paid too much during a cash transaction.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "EMV_AUTHORIZATION", "description": "An authorization for a payment taken with an EMV credit card reader.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUGGESTED_REFUND", "description": "A suggested refund transaction that can be used to create a refund.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "OrderTransactionStatus", "description": "The different states that an `OrderTransaction` can have.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUCCESS", "description": "The transaction succeeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILURE", "description": "The transaction failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The transaction is pending.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERROR", "description": "There was an error while processing the transaction.", "isDeprecated": false, "deprecationReason": null }, { "name": "AWAITING_RESPONSE", "description": "Awaiting a response.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "The transaction status is unknown.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderUpdatePayload", "description": "Return type for `orderUpdate` mutation.", "fields": [ { "name": "order", "description": "The updated order.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PageInfo", "description": "Returns information about pagination in a connection, in accordance with the\n[Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).\nFor more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql).\n", "fields": [ { "name": "endCursor", "description": "The cursor corresponding to the last node in edges.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasNextPage", "description": "Whether there are more pages to fetch following the current page.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasPreviousPage", "description": "Whether there are any pages prior to the current page.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startCursor", "description": "The cursor corresponding to the first node in edges.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ParseError", "description": "A ShopifyQL parsing error.", "fields": [ { "name": "code", "description": "An error code for the error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ParseErrorCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The description of the parsing error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "range", "description": "The start and end range for the error.", "args": [], "type": { "kind": "OBJECT", "name": "ParseErrorRange", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ParseErrorCode", "description": "ShopifyQL parsing errors.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SYNTAX_NOT_RECOGNIZED", "description": "Syntax not recognized.", "isDeprecated": false, "deprecationReason": null }, { "name": "SEMANTICALLY_INVALID", "description": "Semantically invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TABLE_NOT_FOUND", "description": "Table not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLUMN_NOT_FOUND", "description": "Column not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "VALUE_NOT_PARSABLE", "description": "Value isn't parsable.", "isDeprecated": false, "deprecationReason": null }, { "name": "DATE_NOT_PARSABLE", "description": "Date isn't parsable.", "isDeprecated": false, "deprecationReason": null }, { "name": "DATE_TIME_NOT_PARSABLE", "description": "Datetime value isn't parsable.", "isDeprecated": false, "deprecationReason": null }, { "name": "DATE_INTERVAL_NOT_FOUND", "description": "Date interval not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAMED_DATE_NOT_FOUND", "description": "Named date not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "SORT_FIELD_NOT_FOUND", "description": "Sort field not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIMIT_INVALID", "description": "Limit is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISUALIZE_CHART_TYPE_NOT_FOUND", "description": "The type of visualization is invalid. Acceptable types: bar, line.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_MODIFIER_NOT_FOUND", "description": "Function does not have any valid modifiers.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_ARGUMENTS_NOT_FOUND", "description": "Function is missing required argument(s).", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_EXCESS_ARGUMENTS", "description": "Function has too many arguments.", "isDeprecated": false, "deprecationReason": null }, { "name": "FROM_NOT_FOUND", "description": "Keyword `FROM` not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENTMENT_NOT_FOUND", "description": "Query is missing `SHOW` or `VISUALIZE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCESS_PRESENTMENTS", "description": "Use the correct syntax for either `SHOW` or `VISUALIZE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_INCOMPATIBLE_TYPES", "description": "Function has incompatible types.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISUALIZE_EXCESS_PROJECTIONS", "description": "Visualize has too many projections.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "Unknown error.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPERATOR_INCOMPATIBLE_TYPES", "description": "Invalid arguments for operator.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISUALIZE_INCOMPATIBLE_TYPES", "description": "Function `VISUALIZE` contains a data type which cannot be plotted.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISUALIZE_GROUP_BY_NOT_FOUND", "description": "Function `VISUALIZE` requires `GROUP BY`.", "isDeprecated": false, "deprecationReason": null }, { "name": "VISUALIZE_GROUP_BY_MIXED_BACKFILL", "description": "Function `VISUALIZE` can only use `GROUP BY` or `GROUP BY` with the `ALL` modifier, not both.", "isDeprecated": false, "deprecationReason": null }, { "name": "MIXED_AGGREGATE_AND_NON_AGGREGATE", "description": "Mixing an aggregate expression and a non-aggregate expression is not allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NESTED_AGGREGATE", "description": "An aggregate function received a nested aggregate argument, which is not allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "TIME_FUNCTION_NOT_FOUND", "description": "Time function is incompatible in a `GROUP BY` clause with the `ALL` modifier.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST_MIXED_ARGUMENT_TYPES", "description": "Mixing of `IN` list arguments of different data types is not allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCESS_PERIODS", "description": "Mixing of `SINCE` and/or `UNTIL` with `DURING` is not allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_INVALID_TOKEN", "description": "Invalid entry.", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_NO_VIABLE_ALTERNATIVE", "description": "Identifier after `SHOW` is not valid in its current position.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPARE_TO_INVALID_PERIOD", "description": "Invalid `COMPARE TO` period specified. Make sure it's not the same as the `DURING` clause.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPARE_TO_INCOMPATIBLE_PERIOD", "description": "The time period for `COMPARE TO` must be the same length as `DURING`.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNBACKFILLED_TIME_GROUP_BY_COMPARISON", "description": "When using `COMPARE TO` with a time-based `GROUP BY`, `ALL` must be used.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPARISON_WITH_NON_AGGREGATE_FIELDS", "description": "Comparison queries must only contain aggregated fields.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRED_GROUP_BY_NOT_FOUND", "description": "Column must include `GROUP BY` arg1.", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_INPUT_MISMATCH", "description": "Identifier or function out of place.", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_UNWANTED_TOKEN", "description": "Identifier or function out of place.", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_MISSING_TOKEN", "description": "Query is incomplete.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "Function not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DATE_RANGE", "description": "The `SINCE` date must be before or the same as the `UNTIL` date.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCESS_BACKFILL_DIMENSIONS", "description": "The `GROUP BY` function is limited to one parameter with the `ALL` modifier.", "isDeprecated": false, "deprecationReason": null }, { "name": "BACKFILL_DATE_RANGE_NOT_FOUND", "description": "When using `GROUP BY` with the `ALL` modifier, `SINCE` or `DURING` must be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPARE_TO_MISSING_PERIOD", "description": "Cannot use a `COMPARE TO` clause without `DURING` or `SINCE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCESS_DIMENSIONS", "description": "The `GROUP BY` function has too many parameters.\nWhen using `VISUALIZE` with `COMPARE TO` use only one `GROUP BY` parameter.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SYNTAX_FAILED_PREDICATE", "description": "A semantic predicate failed during validation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ParseErrorRange", "description": "A range of ShopifyQL parsing errors.", "fields": [ { "name": "end", "description": "The ending position of the error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorPosition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "start", "description": "The starting position of the error.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorPosition", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomization", "description": "A payment customization.", "fields": [ { "name": "enabled", "description": "The enabled status of the payment customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorHistory", "description": "The error history on the most recent version of the payment customization.", "args": [], "type": { "kind": "OBJECT", "name": "FunctionsErrorHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "functionId", "description": "The ID of the Shopify Function implementing the payment customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "shopifyFunction", "description": "The Shopify Function implementing the payment customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the payment customization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationActivationPayload", "description": "Return type for `paymentCustomizationActivation` mutation.", "fields": [ { "name": "ids", "description": "The IDs of the updated payment customizations.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationConnection", "description": "An auto-generated type for paginating through multiple PaymentCustomizations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PaymentCustomizationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationCreatePayload", "description": "Return type for `paymentCustomizationCreate` mutation.", "fields": [ { "name": "paymentCustomization", "description": "Returns the created payment customization.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationDeletePayload", "description": "Return type for `paymentCustomizationDelete` mutation.", "fields": [ { "name": "deletedId", "description": "Returns the deleted payment customization ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationEdge", "description": "An auto-generated type which holds one PaymentCustomization and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PaymentCustomizationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationError", "description": "An error that occurs during the execution of a payment customization mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PaymentCustomizationErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentCustomizationErrorCode", "description": "Possible error codes that can be returned by `PaymentCustomizationError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", "description": "Shop plan not eligible to use Functions from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_DOES_NOT_IMPLEMENT", "description": "Function does not implement the required interface.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "Function not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_PENDING_DELETION", "description": "Function is pending deletion.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_CUSTOMIZATION_NOT_FOUND", "description": "Payment customization not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE", "description": "Shop must be on a Shopify Plus plan to activate payment customizations from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_ACTIVE_PAYMENT_CUSTOMIZATIONS", "description": "Maximum payment customizations are already enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRED_INPUT_FIELD", "description": "Required input field must be present.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_METAFIELDS", "description": "Could not create or update metafields.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_ID_CANNOT_BE_CHANGED", "description": "Function ID cannot be changed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentCustomizationInput", "description": "The input fields to create and update a payment customization.", "fields": null, "inputFields": [ { "name": "functionId", "description": "The ID of the function providing the payment customization.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the payment customization.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "enabled", "description": "The enabled status of the payment customization.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional metafields to associate to the payment customization.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentCustomizationUpdatePayload", "description": "Return type for `paymentCustomizationUpdate` mutation.", "fields": [ { "name": "paymentCustomization", "description": "Returns the updated payment customization.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "PaymentDetails", "description": "Payment details related to a transaction.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CardPaymentDetails", "ofType": null }, { "kind": "OBJECT", "name": "ShopPayInstallmentsPaymentDetails", "ofType": null } ] }, { "kind": "UNION", "name": "PaymentInstrument", "description": "All possible instrument outputs for Payment Mandates.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "VaultCreditCard", "ofType": null }, { "kind": "OBJECT", "name": "VaultPaypalBillingAgreement", "ofType": null } ] }, { "kind": "OBJECT", "name": "PaymentMandate", "description": "A payment instrument and the permission\nthe owner of the instrument gives to the merchant to debit it.\n", "fields": [ { "name": "id", "description": "The unique ID of a payment mandate.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentInstrument", "description": "The outputs details of the payment instrument.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PaymentInstrument", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentMethods", "description": "Some of the payment methods used in Shopify.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "VISA", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "MASTERCARD", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOVER", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "AMERICAN_EXPRESS", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DINERS_CLUB", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "JCB", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "UNIONPAY", "description": "The payment method for UnionPay payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "ELO", "description": "The payment method for Elo payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "DANKORT", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "MAESTRO", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "FORBRUGSFORENINGEN", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "PAYPAL", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "BOGUS", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "BITCOIN", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "LITECOIN", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DOGECOIN", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "INTERAC", "description": "The payment method for Interac payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "EFTPOS", "description": "The payment method for eftpos_au payment.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentReminderSendPayload", "description": "Return type for `paymentReminderSend` mutation.", "fields": [ { "name": "success", "description": "Whether the payment reminder email was successfully sent.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentReminderSendUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentReminderSendUserError", "description": "An error that occurs during the execution of `PaymentReminderSend`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PaymentReminderSendUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentReminderSendUserErrorCode", "description": "Possible error codes that can be returned by `PaymentReminderSendUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_REMINDER_SEND_UNSUCCESSFUL", "description": "An error occurred while sending the payment reminder.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentSchedule", "description": "Represents the payment schedule for a single payment defined in the payment terms.", "fields": [ { "name": "amount", "description": "Amount owed for this payment schedule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "completedAt", "description": "Date and time when the payment schedule is paid or fulfilled.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dueAt", "description": "Date and time when the payment schedule is due.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "issuedAt", "description": "Date and time when the invoice is sent.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTerms", "description": "The payment terms the payment schedule belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentScheduleConnection", "description": "An auto-generated type for paginating through multiple PaymentSchedules.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentScheduleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PaymentScheduleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentSchedule", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentScheduleEdge", "description": "An auto-generated type which holds one PaymentSchedule and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PaymentScheduleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentSchedule", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentScheduleInput", "description": "The input fields used to create a payment schedule for payment terms.", "fields": null, "inputFields": [ { "name": "issuedAt", "description": "Specifies the date and time that the payment schedule was issued. This field must be provided for net type payment terms.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "dueAt", "description": "Specifies the date and time when the payment schedule is due. This field must be provided for fixed type payment terms.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentSettings", "description": "Settings related to payments.", "fields": [ { "name": "supportedDigitalWallets", "description": "List of the digital wallets which the shop supports.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DigitalWallet", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTerms", "description": "Represents the payment terms for an order or draft order.", "fields": [ { "name": "draftOrder", "description": "The draft order associated with the payment terms.", "args": [], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dueInDays", "description": "Duration of payment terms in days based on the payment terms template used to create the payment terms.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the payment terms.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "overdue", "description": "Whether the payment terms have overdue payment schedules.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentSchedules", "description": "List of schedules for the payment terms.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentScheduleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsName", "description": "The name of the payment terms template used to create the payment terms.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsType", "description": "The payment terms template type used to create the payment terms.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PaymentTermsType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatedName", "description": "The payment terms name, translated into the shop admin's preferred language.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentTermsCreateInput", "description": "The input fields used to create a payment terms.", "fields": null, "inputFields": [ { "name": "paymentTermsTemplateId", "description": "Specifies the payment terms template ID used to generate payment terms.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentSchedules", "description": "Specifies the payment schedules for the payment terms.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentScheduleInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsCreatePayload", "description": "Return type for `paymentTermsCreate` mutation.", "fields": [ { "name": "paymentTerms", "description": "The created payment terms.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentTermsCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsCreateUserError", "description": "An error that occurs during the execution of `PaymentTermsCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PaymentTermsCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentTermsCreateUserErrorCode", "description": "Possible error codes that can be returned by `PaymentTermsCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_TERMS_CREATION_UNSUCCESSFUL", "description": "An error occurred while creating payment terms.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentTermsDeleteInput", "description": "The input fields used to delete the payment terms.", "fields": null, "inputFields": [ { "name": "paymentTermsId", "description": "The ID of the payment terms being deleted.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsDeletePayload", "description": "Return type for `paymentTermsDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The deleted payment terms ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentTermsDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsDeleteUserError", "description": "An error that occurs during the execution of `PaymentTermsDelete`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PaymentTermsDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentTermsDeleteUserErrorCode", "description": "Possible error codes that can be returned by `PaymentTermsDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_TERMS_DELETE_UNSUCCESSFUL", "description": "An error occurred while deleting payment terms.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentTermsInput", "description": "The input fields to create payment terms. Payment terms set the date that payment is due.", "fields": null, "inputFields": [ { "name": "paymentTermsTemplateId", "description": "Specifies the ID of the payment terms template.\n Payment terms templates provide preset configurations to create common payment terms.\n Refer to the\n [PaymentTermsTemplate](https://shopify.dev/api/admin-graphql/latest/objects/paymenttermstemplate)\n object for more details.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "paymentSchedules", "description": "Specifies the payment schedules for the payment terms.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentScheduleInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsTemplate", "description": "Represents the payment terms template object.", "fields": [ { "name": "description", "description": "The description of the payment terms template.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "dueInDays", "description": "The number of days between the issued date and due date if this is the net type of payment terms.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the payment terms template.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsType", "description": "The type of the payment terms template.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PaymentTermsType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatedName", "description": "The translated payment terms template name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentTermsType", "description": "The type of a payment terms or a payment terms template.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RECEIPT", "description": "The payment terms or payment terms template is due on receipt.", "isDeprecated": false, "deprecationReason": null }, { "name": "NET", "description": "The payment terms or payment terms template is a net type. It's due a number of days after issue.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIXED", "description": "The payment terms or payment terms template is a fixed type. It's due on a specified date.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT", "description": "The payment terms or payment terms template is due on fulfillment.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "The type of the payment terms or payment terms template is unknown.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentTermsUpdateInput", "description": "The input fields used to update the payment terms.", "fields": null, "inputFields": [ { "name": "paymentTermsId", "description": "The ID of the payment terms being updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "paymentTermsAttributes", "description": "The attributes used to update the payment terms.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentTermsInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsUpdatePayload", "description": "Return type for `paymentTermsUpdate` mutation.", "fields": [ { "name": "paymentTerms", "description": "The updated payment terms.", "args": [], "type": { "kind": "OBJECT", "name": "PaymentTerms", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentTermsUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentTermsUpdateUserError", "description": "An error that occurs during the execution of `PaymentTermsUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PaymentTermsUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentTermsUpdateUserErrorCode", "description": "Possible error codes that can be returned by `PaymentTermsUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_TERMS_UPDATE_UNSUCCESSFUL", "description": "An error occurred while updating payment terms.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PaypalExpressSubscriptionsGatewayStatus", "description": "Represents a valid PayPal Express subscriptions gateway status.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ENABLED", "description": "The status is enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISABLED", "description": "The status is disabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The status is pending.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PolarisVizDataPoint", "description": "A PolarisViz data point structure for ShopifyQL query.", "fields": [ { "name": "key", "description": "The data key. Typically a category, dimension, or other qualitative data.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The data value is numeric and quantitative.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PolarisVizDataSeries", "description": "The data series used for PolarisViz visualization.", "fields": [ { "name": "data", "description": "An array of data points.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PolarisVizDataPoint", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isComparison", "description": "Whether the series represents comparison data.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the series.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PolarisVizResponse", "description": "A PolarisViz response to a ShopifyQL query.", "fields": [ { "name": "data", "description": "The PolarisViz visualization of data.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PolarisVizDataSeries", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "parseErrors", "description": "A list of parse errors, if parsing fails.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ParseError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tableData", "description": "The result in a tabular format with schema and row data.\n It's always present even if query has a `VISUALIZE` keyword.", "args": [], "type": { "kind": "OBJECT", "name": "TableData", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vizType", "description": "The type of visualization. For example, a line chart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "VisualizationType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShopifyqlResponse", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PreparedFulfillmentOrderLineItemsInput", "description": "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.\n", "fields": null, "inputFields": [ { "name": "fulfillmentOrderId", "description": "The ID of the fulfillment order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceCalculationType", "description": "How to caluclate the parent product variant's price while bulk updating variant relationships.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "COMPONENTS_SUM", "description": "The price of the parent will be the sum of the components price times their quantity.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIXED", "description": "The price of the parent will be set to the price provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "The price of the parent will not be adjusted.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceInput", "description": "The input fields for updating the price of a parent product variant.", "fields": null, "inputFields": [ { "name": "calculation", "description": "The specific type of calculation done to determine the price of the parent variant.\nThe price is calculated during Bundle creation. Updating a component variant won't recalculate the price.\n", "type": { "kind": "ENUM", "name": "PriceCalculationType", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of the parent product variant. This will be be used if calcualtion is set to 'FIXED'.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceList", "description": "Represents a price list, including information about related prices and eligibility rules.\nYou can use price lists to specify either fixed prices or adjusted relative prices that\noverride initial product variant prices. Price lists are applied to customers\nusing context rules, which determine price list eligibility.\n\n For more information on price lists, refer to\n [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).\n", "fields": [ { "name": "catalog", "description": "The catalog that the price list is associated with.", "args": [], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currency", "description": "The currency for fixed prices associated with this price list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fixedPricesCount", "description": "The number of fixed prices on the price list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The unique name of the price list, used as a human-readable identifier.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "parent", "description": "Relative adjustments to other prices.", "args": [], "type": { "kind": "OBJECT", "name": "PriceListParent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prices", "description": "A list of prices associated with the price list.", "args": [ { "name": "originType", "description": "The origin of this price, either fixed (defined on the price list)\n or relative (calculated using an adjustment via a price list parent configuration).", "type": { "kind": "ENUM", "name": "PriceListPriceOriginType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| product_id |\n| variant_id |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPriceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityRules", "description": "A list of quantity rules associated with the price list, ordered by product variants.", "args": [ { "name": "originType", "description": "Whether the quantity rule is fixed (defined on the price list) or relative\n(the default quantity rule for the shop).\n", "type": { "kind": "ENUM", "name": "QuantityRuleOriginType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRuleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListAdjustment", "description": "The type and value of a price list adjustment.\n\nFor more information on price lists, refer to\n[Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).\n", "fields": [ { "name": "type", "description": "The type of price adjustment, such as percentage increase or decrease.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceListAdjustmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of price adjustment, where positive numbers reduce the prices and negative numbers\nincrease them.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentInput", "description": "The input fields to set a price list adjustment.", "fields": null, "inputFields": [ { "name": "value", "description": "The value of the price adjustment as specified by the `type`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "type", "description": "The type of price adjustment, such as percentage increase or decrease.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceListAdjustmentType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListAdjustmentSettings", "description": "Represents the settings of price list adjustments.", "fields": [ { "name": "compareAtMode", "description": "The type of price list adjustment setting for compare at price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceListCompareAtMode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentSettingsInput", "description": "The input fields to set a price list's adjustment settings.", "fields": null, "inputFields": [ { "name": "compareAtMode", "description": "Determines how adjustments are applied to compare at prices.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceListCompareAtMode", "ofType": null } }, "defaultValue": "ADJUSTED" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListAdjustmentType", "description": "Represents a percentage price adjustment type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PERCENTAGE_DECREASE", "description": "Percentage decrease type. Prices will have a lower value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PERCENTAGE_INCREASE", "description": "Percentage increase type. Prices will have a higher value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListCompareAtMode", "description": "Represents how the compare at price will be determined for a price list.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ADJUSTED", "description": "The compare at price is adjusted based on percentage specified in price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "NULLIFY", "description": "The compare at prices are set to `null` unless explicitly defined by a fixed price value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListConnection", "description": "An auto-generated type for paginating through multiple PriceLists.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PriceListEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceList", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListCreateInput", "description": "The input fields to create a price list.", "fields": null, "inputFields": [ { "name": "name", "description": "The unique name of the price list, used as a human-readable identifier.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "currency", "description": "Three letter currency code for fixed prices associated with this price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "defaultValue": null }, { "name": "parent", "description": "Relative adjustments to other prices.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListParentCreateInput", "ofType": null } }, "defaultValue": null }, { "name": "catalogId", "description": "The ID of the catalog to associate with this price list.If the catalog was already associated with another price list then it will be unlinked.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListCreatePayload", "description": "Return type for `priceListCreate` mutation.", "fields": [ { "name": "priceList", "description": "The newly created price list.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListDeletePayload", "description": "Return type for `priceListDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted price list.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListEdge", "description": "An auto-generated type which holds one PriceList and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PriceListEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceList", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesAddPayload", "description": "Return type for `priceListFixedPricesAdd` mutation.", "fields": [ { "name": "prices", "description": "The list of fixed prices that were added to or updated in the price list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPrice", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPriceUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesByProductBulkUpdateUserError", "description": "Error codes for failed price list fixed prices by product bulk update operations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PriceListFixedPricesByProductBulkUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListFixedPricesByProductBulkUpdateUserErrorCode", "description": "Possible error codes that can be returned by `PriceListFixedPricesByProductBulkUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NO_UPDATE_OPERATIONS_SPECIFIED", "description": "No update operations specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICES_TO_ADD_CURRENCY_MISMATCH", "description": "The currency specified does not match the price list's currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_DOES_NOT_EXIST", "description": "Price list does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_ID_IN_INPUT", "description": "Duplicate ID in input.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID_MUST_BE_MUTUALLY_EXCLUSIVE", "description": "IDs must be mutually exclusive across add or delete operations.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIMIT_EXCEEDED", "description": "Exceeded the 10000 prices to add limit.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesByProductUpdatePayload", "description": "Return type for `priceListFixedPricesByProductUpdate` mutation.", "fields": [ { "name": "priceList", "description": "The price list for which the fixed prices were modified.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricesToAddProducts", "description": "The product for which the fixed prices were added.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricesToDeleteProducts", "description": "The product for which the fixed prices were deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListFixedPricesByProductBulkUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesDeletePayload", "description": "Return type for `priceListFixedPricesDelete` mutation.", "fields": [ { "name": "deletedFixedPriceVariantIds", "description": "A list of product variant IDs whose fixed prices were removed from the price list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPriceUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListFixedPricesUpdatePayload", "description": "Return type for `priceListFixedPricesUpdate` mutation.", "fields": [ { "name": "deletedFixedPriceVariantIds", "description": "A list of deleted variant IDs for prices.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list for which the fixed prices were modified.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricesAdded", "description": "The prices that were added to the price list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPrice", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPriceUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListParent", "description": "Represents relative adjustments from one price list to other prices.\n You can use a `PriceListParent` to specify an adjusted relative price using a percentage-based\n adjustment. Adjusted prices work in conjunction with exchange rules and rounding.\n\n [Adjustment types](https://shopify.dev/api/admin-graphql/latest/enums/pricelistadjustmenttype)\n support both percentage increases and decreases.\n", "fields": [ { "name": "adjustment", "description": "A price list adjustment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListAdjustment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "settings", "description": "A price list's settings for adjustment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListAdjustmentSettings", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListParentCreateInput", "description": "The input fields to create a price list adjustment.", "fields": null, "inputFields": [ { "name": "adjustment", "description": "The relative adjustments to other prices.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentInput", "ofType": null } }, "defaultValue": null }, { "name": "settings", "description": "The price list adjustment settings.", "type": { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentSettingsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListParentUpdateInput", "description": "The input fields used to update a price list's adjustment.", "fields": null, "inputFields": [ { "name": "adjustment", "description": "The relative adjustments to other prices..", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentInput", "ofType": null } }, "defaultValue": null }, { "name": "settings", "description": "The price list adjustment settings.", "type": { "kind": "INPUT_OBJECT", "name": "PriceListAdjustmentSettingsInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListPrice", "description": "Represents information about pricing for a product variant\n 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. For examples, refer to [PriceListFixedPricesAdd](https://shopify.dev/api/admin-graphql/latest/mutations/priceListFixedPricesAdd) and [PriceList](https://shopify.dev/api/admin-graphql/latest/queries/priceList#section-examples).", "fields": [ { "name": "compareAtPrice", "description": "The compare-at price of the product variant on this price list.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originType", "description": "The origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceListPriceOriginType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the product variant on this price list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityPriceBreaks", "description": "A list of quantity breaks for the product variant.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "QuantityPriceBreakSortKeys", "ofType": null }, "defaultValue": "MINIMUM_QUANTITY" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPriceBreakConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant associated with this price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListPriceConnection", "description": "An auto-generated type for paginating through multiple PriceListPrices.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPriceEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PriceListPriceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPrice", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListPriceEdge", "description": "An auto-generated type which holds one PriceListPrice and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PriceListPriceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListPriceInput", "description": "The input fields for providing the fields and values to use when creating or updating a fixed price list price.\n", "fields": null, "inputFields": [ { "name": "variantId", "description": "The product variant ID associated with the price list price.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "price", "description": "The price of the product variant on this price list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "compareAtPrice", "description": "The compare-at price of the product variant on this price list.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListPriceOriginType", "description": "Represents the origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration). For examples, refer to [PriceList](https://shopify.dev/api/admin-graphql/latest/queries/priceList#section-examples).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FIXED", "description": "The price is defined on the price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELATIVE", "description": "The price is relative to the adjustment type and value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListPriceUserError", "description": "An error for a failed price list price operation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PriceListPriceUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListPriceUserErrorCode", "description": "Possible error codes that can be returned by `PriceListPriceUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_FOUND", "description": "The price list doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_CURRENCY_MISMATCH", "description": "The specified currency doesn't match the price list's currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_NOT_FOUND", "description": "A fixed price for the specified product variant doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_NOT_FIXED", "description": "Only fixed prices can be deleted.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListProductPriceInput", "description": "The input fields representing the price for all variants of a product.", "fields": null, "inputFields": [ { "name": "productId", "description": "Specifies the ID of the product to update its variants for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "price", "description": "The price of the product to use for all variants with its currency.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListSortKeys", "description": "The set of valid sort keys for the PriceList query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceListUpdateInput", "description": "The input fields used to update a price list.", "fields": null, "inputFields": [ { "name": "name", "description": "The unique name of the price list, used as a human-readable identifier.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "currency", "description": "The three-letter currency code for fixed prices associated with this price list.", "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "defaultValue": null }, { "name": "parent", "description": "Relative adjustments to other prices.", "type": { "kind": "INPUT_OBJECT", "name": "PriceListParentUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "catalogId", "description": "The ID of the catalog to associate with this price list.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListUpdatePayload", "description": "Return type for `priceListUpdate` mutation.", "fields": [ { "name": "priceList", "description": "The updated price list.", "args": [], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceListUserError", "description": "Error codes for failed contextual pricing operations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PriceListUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceListUserErrorCode", "description": "Possible error codes that can be returned by `PriceListUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_FOUND", "description": "The specified price list doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_LOCKED", "description": "The price list is currently being modified. Please try again later.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_RULE_LIMIT_REACHED", "description": "Cannot save the price list with context rule because the limit of context rules per shop was reached.", "isDeprecated": true, "deprecationReason": "The limit is removed." }, { "name": "CONTEXT_RULE_COUNTRIES_LIMIT", "description": "A price list context rule cannot have more than one country.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENCY_COUNTRY_MISMATCH", "description": "A price list’s currency must be of the pricing rule’s country.", "isDeprecated": false, "deprecationReason": null }, { "name": "COUNTRY_CURRENCY_MISMATCH", "description": "A country in a context rule must use a valid currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENCY_MARKET_MISMATCH", "description": "A price list’s currency must be the market currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_CURRENCY_MISMATCH", "description": "The context rule's market does not use the price list currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ADJUSTMENT_VALUE", "description": "The adjustment value must be a positive value and not be greater than 100% for `type` `PERCENTAGE_DECREASE` and not be greater than 1000% for `type` `PERCENTAGE_INCREASE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ADJUSTMENT_MIN_VALUE", "description": "The adjustment value must not be greater than 100% for `type` `PERCENTAGE_DECREASE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ADJUSTMENT_MAX_VALUE", "description": "The adjustment value must not be greater than 1000% for `type` `PERCENTAGE_INCREASE`.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_RULE_COUNTRY_TAKEN", "description": "A price list for this country is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", "description": "Quantity rules can be associated only with company location catalogs.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_PRICE_BREAKS", "description": "Quantity price breaks can be associated only with company location catalogs.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_RULE_LIMIT_ONE_OPTION", "description": "Only one context rule option may be specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_RULE_MARKET_NOT_FOUND", "description": "The specified market wasn't found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTEXT_RULE_MARKET_TAKEN", "description": "A price list for this market is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENCY_NOT_SUPPORTED", "description": "The price list currency is not supported by the shop's payment gateway.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET", "description": "Cannot create price list for a primary market.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_ASSIGNMENT_NOT_ALLOWED", "description": "Cannot assign a catalog to a price list that also has context rules.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_DOES_NOT_EXIST", "description": "The specified catalog does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CANNOT_CHANGE_CONTEXT_TYPE", "description": "The context type of a catalog cannot be changed.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH", "description": "The price list currency must match the market catalog currency.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_TAKEN", "description": "Catalog has a price list already assigned.", "isDeprecated": false, "deprecationReason": null }, { "name": "COUNTRY_PRICE_LIST_ASSIGNMENT", "description": "A country catalog cannot be assigned to a price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_CATALOG_PRICE_LIST_ASSIGNMENT", "description": "An app catalog cannot be assigned to a price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "Something went wrong when trying to save the price list. Please try again.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRule", "description": "Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.\n\nWe 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.\n", "fields": [ { "name": "allocationLimit", "description": "The maximum number of times that the price rule can be allocated onto an order.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allocationMethod", "description": "The method by which the price rule's value is allocated to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "The application that created the price rule.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCombinesWith", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the price rule was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSelection", "description": "The customers that can use this price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleCustomerSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountClass", "description": "The class of the discount for combining purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountClass", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodes", "description": "List of the price rule's discount codes.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleDiscountCodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodesCount", "description": "How many discount codes associated with the price rule.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "endsAt", "description": "The date and time when the price rule ends. For open-ended price rules, use `null`.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entitlementToPrerequisiteQuantityRatio", "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleEntitlementToPrerequisiteQuantityRatio", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `prerequisiteToEntitlementQuantityRatio` instead." }, { "name": "events", "description": "The paginated list of events associated with the price rule.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "EventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| comments |\n| created_at |\n| subject_type |\n| verb |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "features", "description": "A list of the price rule's features.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleFeature", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasTimelineComment", "description": "Indicates whether there are any timeline comments on the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "itemEntitlements", "description": "The items to which the price rule applies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleItemEntitlements", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "itemPrerequisites", "description": "The items required for the price rule to be applicable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleLineItemPrerequisites", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "oncePerCustomer", "description": "Whether the price rule can be applied only once per customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteQuantityRange", "description": "The number of the entitled items must fall within this range for the price rule to be applicable.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleQuantityRange", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteShippingPriceRange", "description": "The shipping cost must fall within this range for the price rule to be applicable.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleMoneyRange", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteSubtotalRange", "description": "The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleMoneyRange", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteToEntitlementQuantityRatio", "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRulePrerequisiteToEntitlementQuantityRatio", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shareableUrls", "description": "URLs that can be used to share the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleShareableUrl", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingEntitlements", "description": "The shipping lines to which the price rule applies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleShippingLineEntitlements", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "startsAt", "description": "The date and time when the price rule starts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A detailed summary of the price rule.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "target", "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleTarget", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalSales", "description": "The total sales from orders where the price rule was used.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "traits", "description": "A list of the price rule's features.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleTrait", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `features` instead." }, { "name": "usageCount", "description": "The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageLimit", "description": "The maximum number of times that the price rule can be used in total.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "validityPeriod", "description": "A time period during which a price rule is applicable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleValidityPeriod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PriceRuleValue", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `valueV2` instead." }, { "name": "valueV2", "description": "The value of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CommentEventSubject", "ofType": null }, { "kind": "INTERFACE", "name": "HasEvents", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleActivatePayload", "description": "Return type for `priceRuleActivate` mutation.", "fields": [ { "name": "priceRule", "description": "The activated price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleAllocationMethod", "description": "The method by which the price rule's value is allocated to its entitled items.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EACH", "description": "The value will be applied to each of the entitled items.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACROSS", "description": "The value will be applied once across the entitled items.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleConnection", "description": "An auto-generated type for paginating through multiple PriceRules.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PriceRuleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRule", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleCreatePayload", "description": "Return type for `priceRuleCreate` mutation.", "fields": [ { "name": "priceRule", "description": "The newly created price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleDiscountCode", "description": "The newly created discount code.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleCustomerSelection", "description": "A selection of customers for whom the price rule applies.", "fields": [ { "name": "customers", "description": "List of customers to whom the price rule applies.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CustomerSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| accepts_marketing |\n| country |\n| customer_date |\n| email |\n| last_abandoned_order_date |\n| order_date |\n| orders_count |\n| phone |\n| state |\n| tag |\n| tag_not |\n| total_spent |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "forAllCustomers", "description": "Whether the price rule applies to all customers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segments", "description": "A list of customer segments that contain the customers who can use the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Segment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleCustomerSelectionInput", "description": "The input fields to update a price rule customer selection.", "fields": null, "inputFields": [ { "name": "forAllCustomers", "description": "Whether the price rule applies to all customers.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "segmentIds", "description": "List of customer segments that contain the customers to whom the price rule applies. No single customer IDs may be present.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "customerIdsToAdd", "description": "List of customers to add to the current list of customers to whom the price rule applies. `savedSearchIds` must be empty.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "customerIdsToRemove", "description": "A list of customers to remove from the current list of customers to whom the price rule applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDeactivatePayload", "description": "Return type for `priceRuleDeactivate` mutation.", "fields": [ { "name": "priceRule", "description": "The deactivated price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDeletePayload", "description": "Return type for `priceRuleDelete` mutation.", "fields": [ { "name": "deletedPriceRuleId", "description": "The ID price of the deleted price rule.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop of the deleted price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "description": "A discount code of a price rule.", "fields": [ { "name": "app", "description": "The application that created the discount code.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "The code to apply the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageCount", "description": "The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCodeConnection", "description": "An auto-generated type for paginating through multiple PriceRuleDiscountCodes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleDiscountCodeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PriceRuleDiscountCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCodeCreatePayload", "description": "Return type for `priceRuleDiscountCodeCreate` mutation.", "fields": [ { "name": "priceRule", "description": "The updated price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleDiscountCode", "description": "The newly created discount code.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCodeEdge", "description": "An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PriceRuleDiscountCodeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleDiscountCodeInput", "description": "The input fields to manipulate a discount code.", "fields": null, "inputFields": [ { "name": "code", "description": "The code to use the discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleDiscountCodeUpdatePayload", "description": "Return type for `priceRuleDiscountCodeUpdate` mutation.", "fields": [ { "name": "priceRule", "description": "The updated price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleDiscountCode", "description": "The updated discount code.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleEdge", "description": "An auto-generated type which holds one PriceRule and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PriceRuleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRule", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleEntitlementToPrerequisiteQuantityRatio", "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "fields": [ { "name": "entitlementQuantity", "description": "The quantity of entitled items in the ratio.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteQuantity", "description": "The quantity of prerequisite items in the ratio.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleEntitlementToPrerequisiteQuantityRatioInput", "description": "Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "fields": null, "inputFields": [ { "name": "entitlementQuantity", "description": "The quantity of entitled items in the ratio.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteQuantity", "description": "The quantity of prerequisite items in the ratio.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleErrorCode", "description": "Possible error codes that could be returned by a price rule mutation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "EQUAL_TO", "description": "The input value should be equal to the value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The input value should be greater than or equal to the minimum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The input value should be less than the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_ARGUMENTS", "description": "Too many arguments provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_ARGUMENT", "description": "Missing a required argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCEEDED_MAX", "description": "Can't exceed the maximum number.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_RULE_ALLOCATION_LIMIT_ON_NON_BOGO", "description": "The allocation limit can only be set on Buy x, get y (BXGY) discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_RULE_ALLOCATION_LIMIT_IS_ZERO", "description": "The allocation limit must be a non-zero positive number.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_RULE_EXCEEDED_MAX_DISCOUNT_CODE", "description": "The number of discount codes in the shop has reached its limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_EXCEEDED_MAX_PRICE_RULES", "description": "The number of discounts in the shop has reached its limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "END_DATE_BEFORE_START_DATE", "description": "The discount end date must be after the start date.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_RULE_PERCENTAGE_VALUE_OUTSIDE_RANGE", "description": "The percentage value must be between 0 and -100.", "isDeprecated": false, "deprecationReason": null }, { "name": "PREREQUISITE_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT", "description": "Only one of the minimum subtotal or minimum quantity condition can be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALLOCATION_METHOD_MUST_BE_ACROSS_FOR_GIVEN_TARGET_SELECTION", "description": "The allocation method must be `ACROSS` for the provided target selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "APPLIES_ON_NOTHING", "description": "The discount must apply on either one-time purchase or subscription items, or both.", "isDeprecated": false, "deprecationReason": null }, { "name": "MULTIPLE_RECURRING_CYCLE_LIMIT_FOR_NON_SUBSCRIPTION_ITEMS", "description": "The recurring cycle limit must be 1 when a discount doesn't apply on subscription items.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOGO_INVALID_TARGET_SELECTION", "description": "Invalid BOGO target selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOGO_INVALID_TARGET_TYPE", "description": "Invalid BOGO target type.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOGO_INVALID_VALUE_TYPE", "description": "Invalid BOGO value type.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNT_CODE_DUPLICATE", "description": "A duplicate discount code exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOTH_CUSTOMER_AND_SAVED_SEARCH_PREREQUISITES_SELECTED", "description": "Can't use both prerequisite customers and saved search.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SAVED_SEARCH_DUPLICATE", "description": "A duplicate customer saved search exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SAVED_SEARCH_EXCEEDED_MAX", "description": "The customer saved search exceeded the maximum number.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SAVED_SEARCH_INVALID", "description": "Invalid customer saved search.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PREREQUISITES_EXCEEDED_MAX", "description": "The customer prerequisites exceeded the maximum number.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PREREQUISITES_INVALID_SELECTION", "description": "Invalid customer prerequisites selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PREREQUISITE_DUPLICATE", "description": "A duplicate customer prerequisite ID exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PREREQUISITES_MISSING", "description": "Customer prerequisites are missing.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOTH_CUSTOMER_AND_SEGMENT_PREREQUISITES_SELECTED", "description": "Can't have both prerequisite customers and prerequisite segments.", "isDeprecated": false, "deprecationReason": null }, { "name": "BOTH_SAVED_SEARCH_AND_SEGMENT_PREREQUISITES_SELECTED", "description": "Can't have both saved searches and segments prerequisites.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SEGMENT_EXCEEDED_MAX", "description": "The customer segment prerequisites exceeded the maximum number.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SEGMENT_INVALID", "description": "The customer segment prerequisite ID is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_SEGMENT_PREREQUISITE_DUPLICATE", "description": "A duplicate customer segment prerequisite ID exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_PREREQUISITE_COLLECTION_WITH_PRODUCT_OR_VARIANTS", "description": "Can't use collections as a prequisite in combination with product variants or products.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_DUPLICATE_COLLECTION", "description": "Can't add the same collection twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_DUPLICATE_PRODUCT", "description": "Can't add the same product twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_DUPLICATE_VARIANT", "description": "Can't add the same variant twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_EXCEEDED_MAX", "description": "Can't exceed the maximum number of item prerequisites.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_INVALID_COLLECTION", "description": "Invalid collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_INVALID_TYPE", "description": "Invalid type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_INVALID_PRODUCT", "description": "Invalid product.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_INVALID_VARIANT", "description": "Invalid variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_MUST_BE_EMPTY", "description": "Item prerequisites must be empty if the prerequisite quantity ratio isn't defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_PREREQUISITES_MISSING", "description": "Item prerequisites must have at least one item prerequisite if the prerequisite quantity ratio is defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_ENTITLE_COLLECTIONS_WITH_PRODUCTS_OR_VARIANTS", "description": "Can't entitle collections in combination with product variants or products.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_DUPLICATE_COLLECTION", "description": "Can't add the same collection twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_DUPLICATE_PRODUCT", "description": "Can't add the same product twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_DUPLICATE_VARIANT", "description": "Can't add the same collection twice.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_COLLECTION", "description": "Can't exceed the maximum number of collection entitlements.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_PRODUCT", "description": "Can't exceed the maximum number of product entitlements.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_VARIANT", "description": "Can't exceed the maximum number of variant entitlements.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENT_INVALID_TYPE", "description": "Invalid entitlement type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_INVALID_COLLECTION", "description": "Invalid collection.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_INVALID_PRODUCT", "description": "Invalid product.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_INVALID_VARIANT", "description": "Invalid variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION", "description": "Invalid combination of target type and selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "ITEM_ENTITLEMENTS_MISSING", "description": "Entitlements are missing.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_ALREADY_ENTITLED_THROUGH_PRODUCT", "description": "The variant is already entitled through a product.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_DUPLICATE_COUNTRY", "description": "A duplicate country code exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_EXCEEDED_MAX", "description": "Can't exceed the maximum number of entitlements.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_INVALID_COUNTRY", "description": "The country is unknown.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION", "description": "Invalid target type or selection.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_MISSING", "description": "Missing entitlements.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ENTITLEMENTS_UNSUPPORTED_DESTINATION_TYPE", "description": "Unsupported destination type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TARGET_TYPE_PREREQUISITE_SHIPPING_PRICE_RANGE", "description": "The target type is invalid when defining a prerequisite shipping price range.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS", "description": "The `combinesWith` settings are invalid for the discount class.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE", "description": "The discountClass is invalid for the price rule.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleFeature", "description": "The list of features that can be supported by a price rule.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BUY_ONE_GET_ONE", "description": "The price rule supports Buy X, Get Y (BXGY) discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT", "description": "The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "BULK", "description": "The price rule supports bulk discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "SPECIFIC_CUSTOMERS", "description": "The price rule targets specific customers.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_DISCOUNTS", "description": "The price rule supports discounts that require a quantity.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleFixedAmountValue", "description": "The value of a fixed amount price rule.", "fields": [ { "name": "amount", "description": "The monetary value of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleInput", "description": "The input fields to manipulate a price rule.", "fields": null, "inputFields": [ { "name": "combinesWith", "description": "Determines which discount classes the discount can combine with.", "type": { "kind": "INPUT_OBJECT", "name": "DiscountCombinesWithInput", "ofType": null }, "defaultValue": null }, { "name": "validityPeriod", "description": "PriceRuleValidityPeriod for the price rule.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleValidityPeriodInput", "ofType": null }, "defaultValue": null }, { "name": "oncePerCustomer", "description": "Whether the price rule can be applied only once per customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "customerSelection", "description": "The customers that can use this price rule.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleCustomerSelectionInput", "ofType": null }, "defaultValue": null }, { "name": "usageLimit", "description": "The maximum number of times that the price rule can be used in total.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "Title of the price rule.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "allocationLimit", "description": "The maximum number of times that the price rule can be allocated onto an order.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "allocationMethod", "description": "The method by which the price rule's value is allocated to its entitled items.", "type": { "kind": "ENUM", "name": "PriceRuleAllocationMethod", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "The value of the price rule.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleValueInput", "ofType": null }, "defaultValue": null }, { "name": "target", "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", "type": { "kind": "ENUM", "name": "PriceRuleTarget", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteSubtotalRange", "description": "The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleMoneyRangeInput", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteQuantityRange", "description": "The number of the entitled items must fall within this range for the price rule to be applicable.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleQuantityRangeInput", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteShippingPriceRange", "description": "The shipping cost must fall within this range for the price rule to be applicable.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleMoneyRangeInput", "ofType": null }, "defaultValue": null }, { "name": "itemEntitlements", "description": "The items to which the price rule applies.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleItemEntitlementsInput", "ofType": null }, "defaultValue": null }, { "name": "itemPrerequisites", "description": "The items required for the price rule to be applicable.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleItemPrerequisitesInput", "ofType": null }, "defaultValue": null }, { "name": "shippingEntitlements", "description": "The shipping lines to which the price rule applies.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRuleShippingEntitlementsInput", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteToEntitlementQuantityRatio", "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "type": { "kind": "INPUT_OBJECT", "name": "PriceRulePrerequisiteToEntitlementQuantityRatioInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleItemEntitlements", "description": "The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned.", "fields": [ { "name": "collections", "description": "The collections to which the price rule applies.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The product variants to which the price rule applies.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The products to which the price rule applies.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetAllLineItems", "description": "Whether the price rule applies to all line items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleItemEntitlementsInput", "description": "The input fields to update a price rule line item entitlement.", "fields": null, "inputFields": [ { "name": "targetAllLineItems", "description": "Whether the price rule applies to all items.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "productIds", "description": "The products to which the price rule applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productVariantIds", "description": "The product variants to which the price rule applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "collectionIds", "description": "The collections to which the price rule applies.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleItemPrerequisitesInput", "description": "The input fields to update a price rule's item prerequisites.", "fields": null, "inputFields": [ { "name": "productIds", "description": "The products needed for the price rule to be applied.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productVariantIds", "description": "The product variants needed for the price rule to be applied.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "collectionIds", "description": "The collections needed for the price rule to be applied.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleLineItemPrerequisites", "description": "Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination.", "fields": [ { "name": "collections", "description": "The collections required for the price rule to be applicable.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The product variants required for the price rule to be applicable.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The products required for the price rule to be applicable.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleMoneyRange", "description": "A money range within which the price rule is applicable.", "fields": [ { "name": "greaterThan", "description": "The lower bound of the money range.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "greaterThanOrEqualTo", "description": "The lower bound or equal of the money range.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lessThan", "description": "The upper bound of the money range.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lessThanOrEqualTo", "description": "The upper bound or equal of the money range.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleMoneyRangeInput", "description": "The input fields to update the money range within which the price rule is applicable.\n", "fields": null, "inputFields": [ { "name": "lessThan", "description": "The upper bound of the money range.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "lessThanOrEqualTo", "description": "The upper or equal bound of the money range.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "greaterThan", "description": "The lower bound of the money range.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "greaterThanOrEqualTo", "description": "The lower or equal bound of the money range.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRulePercentValue", "description": "The value of a percent price rule.", "fields": [ { "name": "percentage", "description": "The percent value of the price rule.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRulePrerequisiteToEntitlementQuantityRatio", "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "fields": [ { "name": "entitlementQuantity", "description": "The quantity of entitled items in the ratio.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "prerequisiteQuantity", "description": "The quantity of prerequisite items in the ratio.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRulePrerequisiteToEntitlementQuantityRatioInput", "description": "Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", "fields": null, "inputFields": [ { "name": "entitlementQuantity", "description": "The quantity of entitled items in the ratio.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "prerequisiteQuantity", "description": "The quantity of prerequisite items in the ratio.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleQuantityRange", "description": "A quantity range within which the price rule is applicable.", "fields": [ { "name": "greaterThan", "description": "The lower bound of the quantity range.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "greaterThanOrEqualTo", "description": "The lower bound or equal of the quantity range.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lessThan", "description": "The upper bound of the quantity range.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lessThanOrEqualTo", "description": "The upper bound or equal of the quantity range.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleQuantityRangeInput", "description": "The input fields to update the quantity range within which the price rule is applicable.\n", "fields": null, "inputFields": [ { "name": "lessThan", "description": "The upper bound of the quantity range.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "lessThanOrEqualTo", "description": "The upper or equal bound of the quantity range.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "greaterThan", "description": "The lower bound of the quantity range.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "greaterThanOrEqualTo", "description": "The lower or equal bound of the quantity range.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleShareableUrl", "description": "Shareable URL for the discount code associated with the price rule.", "fields": [ { "name": "targetItemImage", "description": "The image URL of the item (product or collection) to which the discount applies.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "The type of page that's associated with the URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceRuleShareableUrlTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the page that's associated with the URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL for the discount code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleShareableUrlTargetType", "description": "The type of page where a shareable price rule URL lands.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HOME", "description": "The URL lands on a home page.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT", "description": "The URL lands on a product page.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION", "description": "The URL lands on a collection page.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleShippingEntitlementsInput", "description": "The input fields to update a price rule shipping entitlement.", "fields": null, "inputFields": [ { "name": "targetAllShippingLines", "description": "Whether the price rule applies to all shipping lines.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "countryCodes", "description": "The codes for the countries to which the price rule applies to.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } }, "defaultValue": null }, { "name": "includeRestOfWorld", "description": "Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleShippingLineEntitlements", "description": "The shipping lines to which the price rule applies to.", "fields": [ { "name": "countryCodes", "description": "The codes for the countries to which the price rule applies to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "includeRestOfWorld", "description": "Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetAllShippingLines", "description": "Whether the price rule applies to all shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleSortKeys", "description": "The set of valid sort keys for the PriceRule query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STARTS_AT", "description": "Sort by the `starts_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENDS_AT", "description": "Sort by the `ends_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleStatus", "description": "The status of the price rule.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The price rule is active.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The price rule is expired.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED", "description": "The price rule is scheduled.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleTarget", "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LINE_ITEM", "description": "The price rule applies to line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_LINE", "description": "The price rule applies to shipping lines.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceRuleTrait", "description": "The list of features that can be supported by a price rule.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BUY_ONE_GET_ONE", "description": "The price rule supports Buy X, Get Y (BXGY) discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT", "description": "The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "BULK", "description": "The price rule supports bulk discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "SPECIFIC_CUSTOMERS", "description": "The price rule targets specific customers.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_DISCOUNTS", "description": "The price rule supports discounts that require a quantity.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleUpdatePayload", "description": "Return type for `priceRuleUpdate` mutation.", "fields": [ { "name": "priceRule", "description": "The updated price rule.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleDiscountCode", "description": "The updated discount code.", "args": [], "type": { "kind": "OBJECT", "name": "PriceRuleDiscountCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `priceRuleUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleUserError", "description": "Represents an error that happens during execution of a price rule mutation.", "fields": [ { "name": "code", "description": "Error code to uniquely identify the error.", "args": [], "type": { "kind": "ENUM", "name": "PriceRuleErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRuleValidityPeriod", "description": "A time period during which a price rule is applicable.", "fields": [ { "name": "end", "description": "The time after which the price rule becomes invalid.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "start", "description": "The time after which the price rule is valid.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PriceRuleValidityPeriodInput", "description": "The input fields to update the validity period of a price rule.", "fields": null, "inputFields": [ { "name": "start", "description": "The time after which the price rule is valid.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "end", "description": "The time after which the price rule becomes invalid.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "PriceRuleValue", "description": "The type of the price rule value. The price rule value might be a percentage value, or a fixed amount.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "PriceRuleFixedAmountValue", "ofType": null }, { "kind": "OBJECT", "name": "PriceRulePercentValue", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "PriceRuleValueInput", "description": "The input fields to update a price rule.", "fields": null, "inputFields": [ { "name": "percentageValue", "description": "The percentage value of the price rule.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "fixedAmountValue", "description": "The fixed amount value of the price rule.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PricingPercentageValue", "description": "One type of value given to a customer when a discount is applied to an order.\nThe application of a discount with this value gives the customer the specified percentage off a specified item.\n", "fields": [ { "name": "percentage", "description": "The percentage value of the object. This is a number between -100 (free) and 0 (no discount).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "PricingValue", "description": "The type of value given to a customer when a discount is applied to an order. For example, the application of the discount might give the customer a percentage off a specified item. Alternatively, the application of the discount might give the customer a monetary value in a given currency off an order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, { "kind": "OBJECT", "name": "PricingPercentageValue", "ofType": null } ] }, { "kind": "OBJECT", "name": "PrivateMetafield", "description": "Private metafields represent custom metadata that is attached to a resource.\nPrivate metafields are accessible only by the application that created them and only from the GraphQL Admin API.\n\nAn application can create a maximum of 10 private metafields per shop resource.\n", "fields": [ { "name": "createdAt", "description": "The date and time when the private metafield was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the private metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The key name of the private metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The namespace of the private metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the private metafield was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of a private metafield.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "valueType", "description": "Represents the private metafield value type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PrivateMetafieldValueType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "description": "An auto-generated type for paginating through multiple PrivateMetafields.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PrivateMetafieldEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldDeleteInput", "description": "The input fields for the private metafield to delete.\n", "fields": null, "inputFields": [ { "name": "owner", "description": "The ID of the resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "namespace", "description": "The namespace of the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key of the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PrivateMetafieldDeletePayload", "description": "Return type for `privateMetafieldDelete` mutation.", "fields": [ { "name": "deletedPrivateMetafieldId", "description": "The ID of private metafield that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PrivateMetafieldEdge", "description": "An auto-generated type which holds one PrivateMetafield and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PrivateMetafieldEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldInput", "description": "The input fields for a private metafield.\n", "fields": null, "inputFields": [ { "name": "owner", "description": "The resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "namespace", "description": "The namespace of the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key of the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "valueInput", "description": "The `value` and `valueType` of the private metafield, wrapped in a `ValueInput` object.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldValueInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PrivateMetafieldUpsertPayload", "description": "Return type for `privateMetafieldUpsert` mutation.", "fields": [ { "name": "privateMetafield", "description": "The private metafield that was created or updated.", "args": [], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PrivateMetafieldValueInput", "description": "The input fields for the value and value type of the private metafield.\n", "fields": null, "inputFields": [ { "name": "value", "description": "The value of a private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "valueType", "description": "Represents the private metafield value type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PrivateMetafieldValueType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PrivateMetafieldValueType", "description": "Supported private metafield value types.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "STRING", "description": "A string metafield.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTEGER", "description": "An integer metafield.", "isDeprecated": false, "deprecationReason": null }, { "name": "JSON_STRING", "description": "A JSON string metafield.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Product", "description": "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).", "fields": [ { "name": "availablePublicationsCount", "description": "The number of publications a resource is published to without feedback errors.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "bodyHtml", "description": "The description of the product, complete with HTML formatting.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `descriptionHtml` instead." }, { "name": "category", "description": "The taxonomy category specified by the merchant.", "args": [], "type": { "kind": "OBJECT", "name": "TaxonomyCategory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collections", "description": "A list of the collections that include the product.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CollectionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| collection_type |\n| product_publication_status |\n| publishable_status |\n| published_status |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "compareAtPriceRange", "description": "The compare-at price range of the product in the default shop currency.", "args": [], "type": { "kind": "OBJECT", "name": "ProductCompareAtPriceRange", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "contextualPricing", "description": "The pricing that applies for a customer in a given context.", "args": [ { "name": "context", "description": "The context used to generate contextual pricing for the variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ContextualPricingContext", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductContextualPricing", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customProductType", "description": "The custom product type specified by the merchant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Deprecated in API version 2022-10. Use `productType` instead." }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "A stripped description of the product, single line with HTML tags removed.", "args": [ { "name": "truncateAt", "description": "Truncates string after the given length.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "descriptionHtml", "description": "The description of the product, complete with HTML formatting.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "HTML", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "descriptionPlainSummary", "description": "Stripped description of the product, single line with HTML tags removed.\nTruncated to 60 characters.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `description` instead." }, { "name": "featuredImage", "description": "The featured image for the product.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "featuredMedia", "description": "The featured media for the product.", "args": [], "type": { "kind": "INTERFACE", "name": "Media", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "feedback", "description": "Information about the product that's provided through resource feedback.", "args": [], "type": { "kind": "OBJECT", "name": "ResourceFeedback", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardTemplateSuffix", "description": "The theme template used when viewing the gift card in a store.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "handle", "description": "A unique human-friendly string of the product's title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasOnlyDefaultVariant", "description": "Whether the product has only a single variant with the default option and value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasOutOfStockVariants", "description": "Whether the product has out of stock variants.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasVariantsThatRequiresComponents", "description": "Determines if at least one of the product variant requires components. The default value is `false`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "images", "description": "The images associated with the product.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductImageSortKeys", "ofType": null }, "defaultValue": "POSITION" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ImageConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inCollection", "description": "Whether the product is in a given collection.", "args": [ { "name": "id", "description": "The ID of the collection to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isGiftCard", "description": "Whether the product is a gift card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media", "description": "The media associated with the product. This can include images, 3D models, or videos.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductMediaSortKeys", "ofType": null }, "defaultValue": "POSITION" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| media_type | | - `IMAGE`
- `VIDEO`
- `MODEL_3D`
- `EXTERNAL_VIDEO` | | |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaCount", "description": "Total count of media belonging to a product.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "onlineStorePreviewUrl", "description": "The online store preview URL.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "onlineStoreUrl", "description": "The online store URL for the product.\nA value of `null` indicates that the product isn't published to the Online Store sales channel.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.", "args": [ { "name": "first", "description": "Truncate the array result to this size.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRange", "description": "The price range of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPriceRange", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Deprecated in API version 2020-10. Use `priceRangeV2` instead." }, { "name": "priceRangeV2", "description": "The price range of the product with prices formatted as decimals.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPriceRangeV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "productCategory", "description": "The product category specified by the merchant.", "args": [], "type": { "kind": "OBJECT", "name": "ProductCategory", "ofType": null }, "isDeprecated": true, "deprecationReason": "Deprecated in API version 2024-04. Use `category` instead." }, { "name": "productPublications", "description": "A list of the channels where the product is published.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublicationConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublications` instead." }, { "name": "productType", "description": "The product type specified by the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublicationsCount` instead." }, { "name": "publications", "description": "A list of the channels where the product is published.", "args": [ { "name": "onlyPublished", "description": "Return only the publications that are published. If false, then return all publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublicationConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublications` instead." }, { "name": "publishedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishedInContext", "description": "Whether or not the product is published for a customer in the given context.", "args": [ { "name": "context", "description": "The context used to determine publication status.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ContextualPublicationContext", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishedOnChannel", "description": "Check to see whether the resource is published to a given channel.", "args": [ { "name": "channelId", "description": "The ID of the channel to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnPublication` instead." }, { "name": "publishedOnCurrentChannel", "description": "Check to see whether the resource is published to the calling app's channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnCurrentPublication` instead." }, { "name": "publishedOnCurrentPublication", "description": "Check to see whether the resource is published to the calling app's publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishedOnPublication", "description": "Check to see whether the resource is published to a given publication.", "args": [ { "name": "publicationId", "description": "The ID of the publication to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresSellingPlan", "description": "Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationOnCurrentPublication", "description": "The resource that's either published or staged to be published to the calling app's publication. Requires the `read_product_listings` scope.", "args": [], "type": { "kind": "OBJECT", "name": "ResourcePublicationV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublications", "description": "The list of resources that are published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsV2", "description": "The list of resources that are either published or staged to be published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "catalogType", "description": "Filter publications by catalog type.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2Connection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupCount", "description": "Count of selling plan groups associated with the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `sellingPlanGroupsCount` instead." }, { "name": "sellingPlanGroups", "description": "A list of all selling plan groups defined in the current shop associated with the product either directly or through any of its variants.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupsCount", "description": "Count of selling plan groups associated with the product.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "seo", "description": "SEO information of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SEO", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardizedProductType", "description": "The standardized product type in the Shopify product taxonomy.", "args": [], "type": { "kind": "OBJECT", "name": "StandardizedProductType", "ofType": null }, "isDeprecated": true, "deprecationReason": "Deprecated in API version 2022-10. Use `productCategory` instead." }, { "name": "status", "description": "The product status. This controls visibility across all channels.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontId", "description": "The Storefront GraphQL API ID of the `Product`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "StorefrontID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `id` instead." }, { "name": "tags", "description": "A comma separated list of tags associated with the product. Updating `tags` overwrites\nany existing tags that were previously added to the product. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "templateSuffix", "description": "The theme template used when viewing the product in a store.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalInventory", "description": "The quantity of inventory in stock.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalVariants", "description": "The number of variants that are associated with the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `variantsCount` instead." }, { "name": "tracksInventory", "description": "Whether inventory tracking has been enabled for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unpublishedChannels", "description": "The list of channels that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unpublishedPublications` instead." }, { "name": "unpublishedPublications", "description": "The list of publications that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the product was last modified.\nA product's `updatedAt` value can change for different reasons. For example, if an order\nis placed for a product that has inventory tracking set up, then the inventory adjustment\nis counted as an update.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variants", "description": "A list of variants associated with the product.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductVariantSortKeys", "ofType": null }, "defaultValue": "POSITION" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantsCount", "description": "The number of variants that are associated with the product.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vendor", "description": "The name of the product's vendor.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "OnlineStorePreviewable", "ofType": null }, { "kind": "INTERFACE", "name": "Publishable", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductAppendImagesInput", "description": "The input fields for specifying product images to append.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "images", "description": "A list of images to be appended to the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ImageInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductAppendImagesPayload", "description": "Return type for `productAppendImages` mutation.", "fields": [ { "name": "newImages", "description": "List of new images appended to the product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductCategory", "description": "The details of a specific product category within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt).", "fields": [ { "name": "productTaxonomyNode", "description": "The product taxonomy node associated with the product category.", "args": [], "type": { "kind": "OBJECT", "name": "ProductTaxonomyNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductCategoryInput", "description": "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.", "fields": null, "inputFields": [ { "name": "productTaxonomyNodeId", "description": "The ID of the node in the Shopify taxonomy that represents the product category.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductChangeStatusPayload", "description": "Return type for `productChangeStatus` mutation.", "fields": [ { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductChangeStatusUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductChangeStatusUserError", "description": "An error that occurs during the execution of `ProductChangeStatus`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductChangeStatusUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductChangeStatusUserErrorCode", "description": "Possible error codes that can be returned by `ProductChangeStatusUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_NOT_FOUND", "description": "Product could not be found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductClaimOwnershipInput", "description": "The input fields to claim ownership for Product features such as Bundles.", "fields": null, "inputFields": [ { "name": "bundles", "description": "Claiming ownership of bundles lets the app render a custom UI for the bundles' card on the\nproducts details page in the Shopify admin.\n\nBundle ownership can only be claimed when creating the product. If you create `ProductVariantComponents`\nin any of its product variants, then the bundle ownership is automatically assigned to the app making the call.\n\n[Learn more](https://shopify.dev/docs/apps/selling-strategies/bundles/product-config).\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductCollectionSortKeys", "description": "The set of valid sort keys for the ProductCollection query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE", "description": "Sort by the `price` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "BEST_SELLING", "description": "Sort by the `best-selling` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED", "description": "Sort by the `created` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "MANUAL", "description": "Sort by the `manual` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_DEFAULT", "description": "Sort by the `collection-default` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductCompareAtPriceRange", "description": "The compare-at price range of the product.", "fields": [ { "name": "maxVariantCompareAtPrice", "description": "The highest variant's compare-at price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minVariantCompareAtPrice", "description": "The lowest variant's compare-at price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductConnection", "description": "An auto-generated type for paginating through multiple Products.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductContextualPricing", "description": "The price of a product in a specific country.\nPrices vary between countries.\nRefer to [Product](https://shopify.dev/docs/api/admin-graphql/latest/queries/product?example=Get+the+price+range+for+a+product+for+buyers+from+Canada)\nfor more information on how to use this object.\n", "fields": [ { "name": "fixedQuantityRulesCount", "description": "The number of fixed quantity rules for the product's variants on the price list.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxVariantPricing", "description": "The pricing of the variant with the highest price in the given context.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariantContextualPricing", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minVariantPricing", "description": "The pricing of the variant with the lowest price in the given context.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariantContextualPricing", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRange", "description": "The price range of the product with prices formatted as decimals.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPriceRangeV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductCreateMediaPayload", "description": "Return type for `productCreateMedia` mutation.", "fields": [ { "name": "media", "description": "The newly created media.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Media", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product associated with the media.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `mediaUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductCreatePayload", "description": "Return type for `productCreate` mutation.", "fields": [ { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop associated with the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDeleteAsyncPayload", "description": "Return type for `productDeleteAsync` mutation.", "fields": [ { "name": "deleteProductId", "description": "The ID of the product that was requested to be deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "job", "description": "The background job that will delete the product and its associated variants and media.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDeleteImagesPayload", "description": "Return type for `productDeleteImages` mutation.", "fields": [ { "name": "deletedImageIds", "description": "The array of image IDs to delete.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductDeleteInput", "description": "The input fields for specifying the product to delete.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDeleteMediaPayload", "description": "Return type for `productDeleteMedia` mutation.", "fields": [ { "name": "deletedMediaIds", "description": "List of media IDs which were deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deletedProductImageIds", "description": "List of product image IDs which were deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product associated with the deleted media.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `mediaUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDeletePayload", "description": "Return type for `productDelete` mutation.", "fields": [ { "name": "deletedProductId", "description": "The ID of the deleted product.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop associated with the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDeleteUserError", "description": "An error that occurred while setting the activation status of an inventory item.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductDeleteUserErrorCode", "description": "Possible error codes that can be returned by `ProductDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "Something went wrong, please try again.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductDuplicateAsyncInput", "description": "The input fields for the product async duplicate mutation.", "fields": null, "inputFields": [ { "name": "productId", "description": "The ID of the product to be duplicated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "newTitle", "description": "The new title of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "newStatus", "description": "The new status of the product. If no value is provided the status will be inherited from the original product.", "type": { "kind": "ENUM", "name": "ProductStatus", "ofType": null }, "defaultValue": null }, { "name": "includeImages", "description": "Specifies whether or not to duplicate images.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDuplicateAsyncV2Payload", "description": "Return type for `productDuplicateAsyncV2` mutation.", "fields": [ { "name": "duplicatedProductId", "description": "The duplicated product ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDuplicateJobId", "description": "The asynchronous job for duplicating the product.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductDuplicateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDuplicateJob", "description": "Represents a product duplication job.", "fields": [ { "name": "done", "description": "This indicates if the job is still queued or has been run.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID that's returned when running an asynchronous mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDuplicatePayload", "description": "Return type for `productDuplicate` mutation.", "fields": [ { "name": "imageJob", "description": "The asynchronous job that duplicates the product images.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "newProduct", "description": "The duplicated product.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDuplicateUserError", "description": "An error that occurred while duplicating the product.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductDuplicateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductDuplicateUserErrorCode", "description": "Possible error codes that can be returned by `ProductDuplicateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "The product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMPTY_VARIANT", "description": "Cannot duplicate a product which has no variants.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMPTY_TITLE", "description": "The title cannot be empty.", "isDeprecated": false, "deprecationReason": null }, { "name": "BUNDLES_ERROR", "description": "Cannot duplicate a bundle product.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "Something went wrong, please try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_SAVE", "description": "Something went wrong when saving the product, please try again.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductEdge", "description": "An auto-generated type which holds one Product and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeed", "description": "A product feed.", "fields": [ { "name": "country", "description": "The country of the product feed.", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "language", "description": "The language of the product feed.", "args": [], "type": { "kind": "ENUM", "name": "LanguageCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the product feed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductFeedStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedConnection", "description": "An auto-generated type for paginating through multiple ProductFeeds.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeedEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductFeedEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeed", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedCreatePayload", "description": "Return type for `productFeedCreate` mutation.", "fields": [ { "name": "productFeed", "description": "The newly created product feed.", "args": [], "type": { "kind": "OBJECT", "name": "ProductFeed", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeedCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedCreateUserError", "description": "An error that occurs during the execution of `ProductFeedCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductFeedCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductFeedCreateUserErrorCode", "description": "Possible error codes that can be returned by `ProductFeedCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedDeletePayload", "description": "Return type for `productFeedDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the product feed that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeedDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedDeleteUserError", "description": "An error that occurs during the execution of `ProductFeedDelete`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductFeedDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductFeedDeleteUserErrorCode", "description": "Possible error codes that can be returned by `ProductFeedDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFeedEdge", "description": "An auto-generated type which holds one ProductFeed and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductFeedEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeed", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductFeedInput", "description": "The input fields required to create a product feed.", "fields": null, "inputFields": [ { "name": "language", "description": "The language of the product feed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LanguageCode", "ofType": null } }, "defaultValue": null }, { "name": "country", "description": "The country of the product feed.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductFeedStatus", "description": "The valid values for the status of product feed.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The product feed is active.", "isDeprecated": false, "deprecationReason": null }, { "name": "INACTIVE", "description": "The product feed is inactive.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFullSyncPayload", "description": "Return type for `productFullSync` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFullSyncUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductFullSyncUserError", "description": "An error that occurs during the execution of `ProductFullSync`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductFullSyncUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductFullSyncUserErrorCode", "description": "Possible error codes that can be returned by `ProductFullSyncUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProductImageSortKeys", "description": "The set of valid sort keys for the ProductImage query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "POSITION", "description": "Sort by the `position` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductImageUpdatePayload", "description": "Return type for `productImageUpdate` mutation.", "fields": [ { "name": "image", "description": "The image that has been updated.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductInput", "description": "The input fields required to create a product.", "fields": null, "inputFields": [ { "name": "descriptionHtml", "description": "The description of the product, complete with HTML formatting.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "handle", "description": "A unique, human-friendly string for the product.\nAutomatically generated from the product's title unless otherwise specified.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "redirectNewHandle", "description": "Whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "seo", "description": "The SEO information associated with the product.", "type": { "kind": "INPUT_OBJECT", "name": "SEOInput", "ofType": null }, "defaultValue": null }, { "name": "productType", "description": "The product type specified by the merchant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "standardizedProductType", "description": "The standardized product type in the Shopify product taxonomy.", "type": { "kind": "INPUT_OBJECT", "name": "StandardizedProductTypeInput", "ofType": null }, "defaultValue": null }, { "name": "productCategory", "description": "The product category in the Shopify product taxonomy.", "type": { "kind": "INPUT_OBJECT", "name": "ProductCategoryInput", "ofType": null }, "defaultValue": null }, { "name": "customProductType", "description": "The custom product type specified by the merchant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "A comma separated list of tags that have been added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "templateSuffix", "description": "The theme template used when viewing the product in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "giftCard", "description": "Whether the product is a gift card.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "giftCardTemplateSuffix", "description": "The theme template used when viewing the gift card in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "vendor", "description": "The name of the product's vendor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "collectionsToJoin", "description": "The IDs of the collections that this product will be added to.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "collectionsToLeave", "description": "The IDs of collections that will no longer include the existing product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "id", "description": "Specifies the product to update in productUpdate or creates a new product if absent in productCreate.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "The metafields to associate with this product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "productOptions", "description": "List of custom product options and option values (maximum of 3 per product).\nSupported as input with the `productCreate` mutation only.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionCreateInput", "ofType": null } } }, "defaultValue": null }, { "name": "status", "description": "The status of the product.", "type": { "kind": "ENUM", "name": "ProductStatus", "ofType": null }, "defaultValue": null }, { "name": "requiresSellingPlan", "description": "Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "claimOwnership", "description": "Claim ownership of a product.", "type": { "kind": "INPUT_OBJECT", "name": "ProductClaimOwnershipInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductJoinSellingPlanGroupsPayload", "description": "Return type for `productJoinSellingPlanGroups` mutation.", "fields": [ { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductLeaveSellingPlanGroupsPayload", "description": "Return type for `productLeaveSellingPlanGroups` mutation.", "fields": [ { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductMediaSortKeys", "description": "The set of valid sort keys for the ProductMedia query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "POSITION", "description": "Sort by the `position` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "ProductOperation", "description": "An entity that represents details of an asynchronous operation on a product.", "fields": [ { "name": "product", "description": "The product that's created or updated during this operation.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ProductSetOperation", "ofType": null } ] }, { "kind": "ENUM", "name": "ProductOperationStatus", "description": "Represents the state of this product operation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED", "description": "Operation has been created.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE", "description": "Operation is currently running.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPLETE", "description": "Operation is complete.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOption", "description": "The product property names. For example, \"Size\", \"Color\", and \"Material\".\nVariants are selected based on permutations of these options.\nThe limit for each product property name is 255 characters.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linkedMetafield", "description": "The metafield identifier linked to this option.", "args": [], "type": { "kind": "OBJECT", "name": "LinkedMetafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product option’s name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "optionValues", "description": "Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The product option's position.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": "The corresponding value to the product option name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionDeleteStrategy", "description": "The set of strategies available for use on the `productOptionDelete` mutation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "The default strategy, the specified `Option` may only have one corresponding `value`.", "isDeprecated": false, "deprecationReason": null }, { "name": "POSITION", "description": "An `Option` with multiple `values` can be deleted. Remaining variants will be deleted, highest `position` first, in the event of duplicates being detected.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_DESTRUCTIVE", "description": "An `Option` with multiple `values` can be deleted, but the operation only succeeds if no product variants get deleted.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionUpdatePayload", "description": "Return type for `productOptionUpdate` mutation.", "fields": [ { "name": "product", "description": "The product with which the option being updated is associated.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionUpdateUserError", "description": "Error codes for failed `ProductOptionUpdate` mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductOptionUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionUpdateUserErrorCode", "description": "Possible error codes that can be returned by `ProductOptionUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_SUSPENDED", "description": "Product is suspended.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_DOES_NOT_EXIST", "description": "Option does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_ALREADY_EXISTS", "description": "Option already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_POSITION", "description": "The option position provided is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_NAME", "description": "The option name provided is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_OVER_LIMIT", "description": "Option values count is over the allowed limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_DOES_NOT_EXIST", "description": "Option value does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_ALREADY_EXISTS", "description": "Option value already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_HAS_VARIANTS", "description": "Option value with variants linked cannot be deleted.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_ALL_OPTION_VALUES_IN_OPTION", "description": "Deleting all option values of an option is not allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_LEAVE_OPTIONS_WITHOUT_VARIANTS", "description": "An option cannot be left only with option values that are not linked to any variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_KEY_ON_CREATE", "description": "On create, this key cannot be used.", "isDeprecated": false, "deprecationReason": null }, { "name": "KEY_MISSING_IN_INPUT", "description": "A key is missing in the input.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_VALUE", "description": "Duplicated option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_NAME_TOO_LONG", "description": "Option name is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_NAME_TOO_LONG", "description": "Option value name is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_CONFLICTING_OPERATION", "description": "Performing conflicting actions on an option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_CREATE_VARIANTS_ABOVE_LIMIT", "description": "The number of variants will be above the limit after this operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_COMBINE_LINKED_AND_NONLINKED_OPTION_VALUES", "description": "An option cannot have both metafield linked and nonlinked option values.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_METAFIELD_VALUE_FOR_LINKED_OPTION", "description": "Invalid metafield value for linked option.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_LINKED_OPTION", "description": "Cannot link multiple options to the same metafield.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_LINKED_METAFIELD_ALREADY_TAKEN", "description": "An option linked to the provided metafield already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINKED_OPTION_UPDATE_MISSING_VALUES", "description": "Updating the linked_metafield of an option requires a linked_metafield_value for each option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINKED_OPTIONS_NOT_SUPPORTED_FOR_SHOP", "description": "Linked options are currently not supported for this shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MAKE_CHANGES_IF_VARIANT_IS_MISSING_REQUIRED_SKU", "description": "At least one of the product variants has invalid SKUs.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionUpdateVariantStrategy", "description": "The set of variant strategies available for use in the `productOptionUpdate` mutation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LEAVE_AS_IS", "description": "Variants are not created nor deleted in response to option values to add or delete.\nIn cases where deleting a variant would be necessary to complete the operation, an error will be returned.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "MANAGE", "description": "Variants are created and deleted according to the option values to add and to delete.\n\nIf an option value is added, a new variant will be added for each existing option combination\navailable on the product. For example, if the existing options are `Size` and `Color`, with\nvalues `S`/`XL` and `Red`/`Blue`, adding a new option value `Green` for the option `Color` will create\nvariants with the option value combinations `S`/`Green` and `XL`/`Green`.\n\nIf an option value is deleted, all variants referencing that option value will be deleted.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionValue", "description": "The product option value names. For example, \"Red\", \"Blue\", and \"Green\" for a \"Color\" option.\n", "fields": [ { "name": "hasVariants", "description": "Whether the product option value has any linked variants.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linkedMetafieldValue", "description": "The value of the linked metafield.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product option value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch", "description": "The swatch associated with the product option value.", "args": [], "type": { "kind": "OBJECT", "name": "ProductOptionValueSwatch", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionValueSwatch", "description": "A swatch associated with a product option value.", "fields": [ { "name": "color", "description": "The color representation of the swatch.", "args": [], "type": { "kind": "SCALAR", "name": "Color", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "An image representation of the swatch.", "args": [], "type": { "kind": "OBJECT", "name": "MediaImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsCreatePayload", "description": "Return type for `productOptionsCreate` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionsCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsCreateUserError", "description": "Error codes for failed `ProductOptionsCreate` mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductOptionsCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionsCreateUserErrorCode", "description": "Possible error codes that can be returned by `ProductOptionsCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OPTION_ALREADY_EXISTS", "description": "Option already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTIONS_OVER_LIMIT", "description": "Options count is over the allowed limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_OVER_LIMIT", "description": "Option values count is over the allowed limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_SUSPENDED", "description": "Product is suspended.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEW_OPTION_WITHOUT_VALUE_FOR_EXISTING_VARIANTS", "description": "Cannot create new options without values for all existing variants.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_NAME", "description": "Duplicated option name.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_VALUE", "description": "Duplicated option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_NAME_MISSING", "description": "Each option must have a name specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_MISSING", "description": "Each option must have at least one option value specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "POSITION_OUT_OF_BOUNDS", "description": "Position must be between 1 and the maximum number of options per product.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_POSITION_MISSING", "description": "If specified, position field must be present in all option inputs.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINKED_METAFIELD_DEFINITION_NOT_FOUND", "description": "No valid metafield definition found for linked option.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_METAFIELD_VALUE_FOR_LINKED_OPTION", "description": "Invalid metafield value for linked option.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_METAFIELD_VALUES_FOR_LINKED_OPTION", "description": "Missing metafield values for linked option.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_COMBINE_LINKED_METAFIELD_AND_OPTION_VALUES", "description": "Cannot combine linked metafield and option values.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_LINKED_OPTION", "description": "Cannot link multiple options to the same metafield.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_LINKED_METAFIELD_ALREADY_TAKEN", "description": "An option linked to the provided metafield already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINKED_OPTIONS_NOT_SUPPORTED_FOR_SHOP", "description": "Linked options are currently not supported for this shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MAKE_CHANGES_IF_VARIANT_IS_MISSING_REQUIRED_SKU", "description": "At least one of the product variants has invalid SKUs.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsDeletePayload", "description": "Return type for `productOptionsDelete` mutation.", "fields": [ { "name": "deletedOptionsIds", "description": "IDs of the options deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionsDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsDeleteUserError", "description": "Error codes for failed `ProductOptionsDelete` mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductOptionsDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionsDeleteUserErrorCode", "description": "Possible error codes that can be returned by `ProductOptionsDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_SUSPENDED", "description": "Product is suspended.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_DOES_NOT_EXIST", "description": "Option does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTIONS_DO_NOT_BELONG_TO_THE_SAME_PRODUCT", "description": "Options do not belong to the same product.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_OPTION_WITH_MULTIPLE_VALUES", "description": "Can't delete option with multiple values.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_USE_NON_DESTRUCTIVE_STRATEGY", "description": "Cannot delete options without deleting variants.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MAKE_CHANGES_IF_VARIANT_IS_MISSING_REQUIRED_SKU", "description": "At least one of the product variants has invalid SKUs.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsReorderPayload", "description": "Return type for `productOptionsReorder` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionsReorderUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductOptionsReorderUserError", "description": "Error codes for failed `ProductOptionsReorder` mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductOptionsReorderUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductOptionsReorderUserErrorCode", "description": "Possible error codes that can be returned by `ProductOptionsReorderUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OPTION_NAME_DOES_NOT_EXIST", "description": "Option name does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_DOES_NOT_EXIST", "description": "Option value does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_ID_DOES_NOT_EXIST", "description": "Option id does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_ID_DOES_NOT_EXIST", "description": "Option value id does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_NAME", "description": "Duplicated option name.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_VALUE", "description": "Duplicated option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_OPTION_NAME", "description": "Missing option name.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_OPTION_VALUE", "description": "Missing option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_KEY_ON_REORDER", "description": "On reorder, this key cannot be used.", "isDeprecated": false, "deprecationReason": null }, { "name": "MIXING_ID_AND_NAME_KEYS_IS_NOT_ALLOWED", "description": "Cannot specify different options or option values using mixed id and name reference key.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MAKE_CHANGES_IF_VARIANT_IS_MISSING_REQUIRED_SKU", "description": "At least one of the product variants has invalid SKUs.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPriceRange", "description": "The price range of the product.", "fields": [ { "name": "maxVariantPrice", "description": "The highest variant's price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minVariantPrice", "description": "The lowest variant's price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPriceRangeV2", "description": "The price range of the product.", "fields": [ { "name": "maxVariantPrice", "description": "The highest variant's price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minVariantPrice", "description": "The lowest variant's price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPublication", "description": "Represents the channels where a product is published.", "fields": [ { "name": "channel", "description": "The channel where the product was or is published.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Channel", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPublished", "description": "Whether the publication is published or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product that was or is going to be published on the channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishDate", "description": "The date that the product was or is going to be published on the channel.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPublicationConnection", "description": "An auto-generated type for paginating through multiple ProductPublications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductPublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPublicationEdge", "description": "An auto-generated type which holds one ProductPublication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductPublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductPublicationInput", "description": "The input fields for specifying a publication to which a product will be published.", "fields": null, "inputFields": [ { "name": "publicationId", "description": "ID of the publication.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "publishDate", "description": "The date and time that the product was (or will be) published.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductPublishInput", "description": "The input fields for specifying a product to publish and the channels to publish it to.", "fields": null, "inputFields": [ { "name": "id", "description": "The product to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productPublications", "description": "The publication that the product is published to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductPublicationInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPublishPayload", "description": "Return type for `productPublish` mutation.", "fields": [ { "name": "product", "description": "The product that has been published.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productPublications", "description": "The channels where the product is published.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPublication", "ofType": null } } }, "isDeprecated": true, "deprecationReason": "Use Product.publications instead." }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReorderImagesPayload", "description": "Return type for `productReorderImages` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job which reorders the images.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReorderMediaPayload", "description": "Return type for `productReorderMedia` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job which reorders the media.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `mediaUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductResourceFeedback", "description": "Reports the status of product for a Sales Channel or Storefront API.\nThis might include why a product is not available in a Sales Channel\nand how a merchant might fix this.\n", "fields": [ { "name": "feedbackGeneratedAt", "description": "The time when the feedback was generated. Used to help determine whether\nincoming feedback is outdated compared to existing feedback.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "messages", "description": "The feedback messages presented to the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productId", "description": "The ID of the product associated with the feedback.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productUpdatedAt", "description": "The timestamp of the product associated with the feedback.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "state", "description": "Conveys the state of the feedback and whether it requires merchant action or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceFeedbackState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductResourceFeedbackInput", "description": "The input fields used to create a product feedback.", "fields": null, "inputFields": [ { "name": "productId", "description": "The ID of the product that the feedback was created on.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "state", "description": "Whether the merchant needs to take action on the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceFeedbackState", "ofType": null } }, "defaultValue": null }, { "name": "feedbackGeneratedAt", "description": "The date and time when the payload is constructed.\nUsed to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "productUpdatedAt", "description": "The timestamp of the product associated with the feedback.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "messages", "description": "A concise set of copy strings to be displayed to merchants. Used to guide merchants in resolving problems that your app encounters when trying to make use of their products.\nYou can specify up to four messages. Each message is limited to 100 characters.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductSale", "description": "A sale associated with a product.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The line item for the associated sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductSetInput", "description": "The input fields required to create or update a product via ProductSet mutation.", "fields": null, "inputFields": [ { "name": "descriptionHtml", "description": "The description of the product, complete with HTML formatting.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "handle", "description": "A unique, human-friendly string for the product.\nAutomatically generated from the product's title unless otherwise specified.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "redirectNewHandle", "description": "Whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "seo", "description": "The SEO information associated with the product.", "type": { "kind": "INPUT_OBJECT", "name": "SEOInput", "ofType": null }, "defaultValue": null }, { "name": "productType", "description": "The product type specified by the merchant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "standardizedProductType", "description": "The standardized product type in the Shopify product taxonomy.", "type": { "kind": "INPUT_OBJECT", "name": "StandardizedProductTypeInput", "ofType": null }, "defaultValue": null }, { "name": "productCategory", "description": "The product category in the Shopify product taxonomy.", "type": { "kind": "INPUT_OBJECT", "name": "ProductCategoryInput", "ofType": null }, "defaultValue": null }, { "name": "customProductType", "description": "The custom product type specified by the merchant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "tags", "description": "A comma separated list of tags that have been added to the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "templateSuffix", "description": "The theme template used when viewing the product in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "giftCard", "description": "Whether the product is a gift card.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "giftCardTemplateSuffix", "description": "The theme template used when viewing the gift card in a store.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "The title of the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "vendor", "description": "The name of the product's vendor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "Specifies the product to update. If absent, a new product is created.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "collections", "description": "The IDs of collections that this product will be a member of.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "metafields", "description": "The metafields to associate with this product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "variants", "description": "A list of variants associated with the product.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantSetInput", "ofType": null } } } }, "defaultValue": null }, { "name": "mediaIds", "description": "The IDs of the media to associate with the product.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "status", "description": "The status of the product.", "type": { "kind": "ENUM", "name": "ProductStatus", "ofType": null }, "defaultValue": null }, { "name": "requiresSellingPlan", "description": "Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "productOptions", "description": "List of custom product options and option values (maximum of 3 per product).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OptionSetInput", "ofType": null } } } }, "defaultValue": null }, { "name": "claimOwnership", "description": "Claim ownership of a product.", "type": { "kind": "INPUT_OBJECT", "name": "ProductClaimOwnershipInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductSetOperation", "description": "An entity that represents details of an asynchronous\n[ProductSet](https://shopify.dev/api/admin-graphql/current/mutations/productSet) mutation.\n\nBy querying this entity with the\n[productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query\nusing the ID that was returned\n[when the product was created or updated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously),\nthis can be used to check the status of an operation.\n\nThe `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`.\n\nThe `product` field provides the details of the created or updated product.\n\nThe `userErrors` field provides mutation errors that occurred during the operation.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product that's created or updated during this operation.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "Returns mutation errors occurred during background mutation processing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductSetUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "ProductOperation", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductSetPayload", "description": "Return type for `productSet` mutation.", "fields": [ { "name": "product", "description": "The product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productSetOperation", "description": "The product set operation, returned when run in asynchronous mode.", "args": [], "type": { "kind": "OBJECT", "name": "ProductSetOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductSetUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductSetUserError", "description": "Defines errors for ProductSet mutation.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductSetUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductSetUserErrorCode", "description": "Possible error codes that can be returned by `ProductSetUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "GENERIC_ERROR", "description": "Something went wrong, please try again.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_METAFIELD", "description": "Metafield is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VARIANT", "description": "Product variant is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", "description": "Product variant does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_DOES_NOT_EXIST", "description": "Option does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUE_DOES_NOT_EXIST", "description": "Option value does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTIONS_OVER_LIMIT", "description": "Options over limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_OVER_LIMIT", "description": "Option values over limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_MISSING", "description": "Each option must have at least one option value specified.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_NAME", "description": "Duplicated option name.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_OPTION_VALUE", "description": "Duplicated option value.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANTS_OVER_LIMIT", "description": "Number of product variants exceeds shop limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_OPTIONS_INPUT_MISSING", "description": "Must specify product options when updating variants.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANTS_INPUT_MISSING", "description": "Must specify variants when updating options.", "isDeprecated": false, "deprecationReason": null }, { "name": "GIFT_CARDS_NOT_ACTIVATED", "description": "Gift card products can only be created after they have been activated.", "isDeprecated": false, "deprecationReason": null }, { "name": "GIFT_CARD_ATTRIBUTE_CANNOT_BE_CHANGED", "description": "The product gift_card attribute cannot be changed after creation.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_PRODUCT", "description": "Product is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_INPUT", "description": "Input is not valid.", "isDeprecated": false, "deprecationReason": null }, { "name": "JOB_ERROR", "description": "Error processing request in the background job.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_VIOLATION", "description": "The metafield violates a capability restriction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProductSortKeys", "description": "The set of valid sort keys for the Product query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_TYPE", "description": "Sort by the `product_type` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "VENDOR", "description": "Sort by the `vendor` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_TOTAL", "description": "Sort by the `inventory_total` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLISHED_AT", "description": "Sort by the `published_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\nPagination isn't supported when using this sort key.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProductStatus", "description": "The possible product statuses.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The product is ready to sell and can be published to sales channels and apps. Products with an active status aren't automatically published to sales channels, such as the online store, or apps. By default, existing products are set to active.", "isDeprecated": false, "deprecationReason": null }, { "name": "ARCHIVED", "description": "The product is no longer being sold and isn't available to customers on sales channels and apps.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT", "description": "The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductTaxonomyNode", "description": "Represents a [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) node.", "fields": [ { "name": "fullName", "description": "The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the product taxonomy node.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isLeaf", "description": "Whether the node is a leaf node.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRoot", "description": "Whether the node is a root node.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product taxonomy node. For example, Dog Beds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductUnpublishInput", "description": "The input fields for specifying a product to unpublish from a channel and the sales channels to unpublish it from.\n", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the product to create or update publications for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "productPublications", "description": "The channels to unpublish the product from.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductPublicationInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductUnpublishPayload", "description": "Return type for `productUnpublish` mutation.", "fields": [ { "name": "product", "description": "The product that has been unpublished.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductUpdateMediaPayload", "description": "Return type for `productUpdateMedia` mutation.", "fields": [ { "name": "media", "description": "The updated media object.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Media", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaUserErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product on which media was updated.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `mediaUserErrors` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductUpdatePayload", "description": "Return type for `productUpdate` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariant", "description": "Represents a product variant.", "fields": [ { "name": "availableForSale", "description": "Whether the product variant is available for sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "barcode", "description": "The value of the barcode associated with the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "compareAtPrice", "description": "The compare-at price of the variant in the default shop currency.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "contextualPricing", "description": "The pricing that applies for a customer in a given context.", "args": [ { "name": "context", "description": "The context used to generate contextual pricing for the variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ContextualPricingContext", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantContextualPricing", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the variant was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCursor", "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfile", "description": "The delivery profile for the variant.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "Display name of the variant, based on product's title + variant's title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "The fulfillment service that stocks a product variant.\n\nThis is a third-party fulfillment service if the following conditions are met:\n- The product variant is stocked by a single fulfillment service.\n- The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n- The fulfillment service hasn't [opted into SKU sharing](/api/admin-graphql/latest/objects/FulfillmentService#field-fulfillmentservice-permitsskusharing).\n\nIf the conditions aren't met, then the fulfillment service has the `manual` handle.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": true, "deprecationReason": "\nThe [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked.\n\nIf you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.\n\nLearn more about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states).\n" }, { "name": "fulfillmentServiceEditable", "description": "Whether changes to the fulfillment service for the product variant are allowed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "EditableProperty", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. \nAs a result, the fulfillment_service is no longer directly editable on a ProductVariant and this field is no longer applicable.\n" }, { "name": "harmonizedSystemCode", "description": "The Harmonized System Code (or HS Tariff Code) for the variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `InventoryItem.harmonizedSystemCode` instead." }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "The featured image for the variant.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItem", "description": "The inventory item, which is used to query for inventory information.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryManagement", "description": "The fulfillment service that tracks the number of items in stock for the product variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductVariantInventoryManagement", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use tracked attribute on `inventoryItem` instead." }, { "name": "inventoryPolicy", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ProductVariantInventoryPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryQuantity", "description": "The total sellable quantity of the variant.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media", "description": "The media associated with the product variant.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentPrices", "description": "List of prices and compare-at prices in the presentment currencies for this shop.", "args": [ { "name": "presentmentCurrencies", "description": "The presentment currencies prices should return in.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantPricePairConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `contextualPricing` instead." }, { "name": "price", "description": "The price of the product variant in the default shop currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "product", "description": "The product that this variant belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Product", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantComponents", "description": "A list of the product variant components.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantComponentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresComponents", "description": "Whether a product variant requires components. The default value is `false`.\nIf `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted\nfrom channels that don't support bundles.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `InventoryItem.requiresShipping` instead." }, { "name": "selectedOptions", "description": "List of product options applied to the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedOption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellableOnlineQuantity", "description": "The total sellable quantity of the variant for online channels.\nThis doesn't represent the total available inventory or capture\n[limitations based on customer location](https://help.shopify.com/manual/markets/inventory_and_fulfillment).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupCount", "description": "Count of selling plan groups associated with the product variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `sellingPlanGroupsCount` instead." }, { "name": "sellingPlanGroups", "description": "A list of all selling plan groups defined in the current shop associated with the product variant.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroupsCount", "description": "Count of selling plan groups associated with the product variant.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A case-sensitive identifier for the product variant in the shop.\nRequired in order to connect to a fulfillment service.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontId", "description": "The Storefront GraphQL API ID of the `ProductVariant`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "StorefrontID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `id` instead." }, { "name": "taxCode", "description": "The tax code for the product variant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether a tax is charged when the product variant is sold.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the product variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time (ISO 8601 format) when the product variant was last modified.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight", "description": "The weight of the product variant in the unit system specified with weight_unit.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use InventoryItem.measurement.weight instead" }, { "name": "weightUnit", "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WeightUnit", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use InventoryItem.measurement.weight instead" } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Navigable", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantAppendMediaInput", "description": "The input fields required to append media to a single variant.", "fields": null, "inputFields": [ { "name": "variantId", "description": "Specifies the variant to which media will be appended.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "mediaIds", "description": "Specifies the media to append to the variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantAppendMediaPayload", "description": "Return type for `productVariantAppendMedia` mutation.", "fields": [ { "name": "product", "description": "The product associated with the variants and media.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The product variants that were updated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantComponent", "description": "A product variant component associated with a product variant.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariant", "description": "The product variant associated with the component.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The required quantity of the component.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantComponentConnection", "description": "An auto-generated type for paginating through multiple ProductVariantComponents.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantComponentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductVariantComponentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantComponent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantComponentEdge", "description": "An auto-generated type which holds one ProductVariantComponent and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductVariantComponentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantComponent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantConnection", "description": "An auto-generated type for paginating through multiple ProductVariants.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductVariantEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantContextualPricing", "description": "The price of a product variant in a specific country.\nPrices vary between countries.\n", "fields": [ { "name": "compareAtPrice", "description": "The final compare-at price after all adjustments are applied.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The final price after all adjustments are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityPriceBreaks", "description": "A list of quantity breaks for the product variant.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "QuantityPriceBreakSortKeys", "ofType": null }, "defaultValue": "MINIMUM_QUANTITY" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPriceBreakConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantityRule", "description": "The quantity rule applied for a given context.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRule", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantCreatePayload", "description": "Return type for `productVariantCreate` mutation.", "fields": [ { "name": "product", "description": "The product associated with the variant.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariant", "description": "The successfully created variant.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantDeletePayload", "description": "Return type for `productVariantDelete` mutation.", "fields": [ { "name": "deletedProductVariantId", "description": "The ID of the deleted product variant.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The product associated with the deleted product variant.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantDetachMediaInput", "description": "The input fields required to detach media from a single variant.", "fields": null, "inputFields": [ { "name": "variantId", "description": "Specifies the variant from which media will be detached.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "mediaIds", "description": "Specifies the media to detach from the variant.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantDetachMediaPayload", "description": "Return type for `productVariantDetachMedia` mutation.", "fields": [ { "name": "product", "description": "The product associated with the variants and media.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The product variants that were updated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantEdge", "description": "An auto-generated type which holds one ProductVariant and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductVariantEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantGroupRelationshipInput", "description": "The input fields for the bundle components for core.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the product variant that's a component of the bundle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The number of units of the product variant required to construct one unit of the bundle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantInput", "description": "The input fields for specifying a product variant to create or update.", "fields": null, "inputFields": [ { "name": "requiresComponents", "description": "Whether a product variant requires components. The default value is `false`.\nIf `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted\nfrom channels that don't support bundles.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "barcode", "description": "The value of the barcode associated with the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "compareAtPrice", "description": "The compare-at price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "Specifies the product variant to update or create a new variant if absent.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "mediaId", "description": "The ID of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the IDs being created on the product. This field only accepts one value.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "mediaSrc", "description": "The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "inventoryPolicy", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "type": { "kind": "ENUM", "name": "ProductVariantInventoryPolicy", "ofType": null }, "defaultValue": null }, { "name": "inventoryQuantities", "description": "The inventory quantities at each location where the variant is stocked. Supported as input with the `productVariantCreate` mutation only.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryLevelInput", "ofType": null } } }, "defaultValue": null }, { "name": "inventoryItem", "description": "The inventory item associated with the variant. Used for unit cost.", "type": { "kind": "INPUT_OBJECT", "name": "InventoryItemInput", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional customizable information about the product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "options", "description": "The custom properties that a shop owner uses to define product variants.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "position", "description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "productId", "description": "The product to create the variant for. Used as input only to the `productVariantCreate` mutation.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "The SKU for the variant. Case-sensitive string.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "taxCode", "description": "The tax code associated with the variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantInventoryManagement", "description": "The valid values for the method of inventory tracking for a product variant.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHOPIFY", "description": "This product variant's inventory is tracked by Shopify. Inventory can be tracked by store location(s) and/or third-party fulfillment service(s).", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_MANAGED", "description": "This product variant's inventory is not tracked.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_SERVICE", "description": "This product variant's inventory is tracked by a third-party fulfillment service.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantInventoryPolicy", "description": "The valid values for the inventory policy of a product variant once it is out of stock.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DENY", "description": "Customers can't buy this product variant after it's out of stock.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTINUE", "description": "Customers can buy this product variant after it's out of stock.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantJoinSellingPlanGroupsPayload", "description": "Return type for `productVariantJoinSellingPlanGroups` mutation.", "fields": [ { "name": "productVariant", "description": "The product variant object.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantLeaveSellingPlanGroupsPayload", "description": "Return type for `productVariantLeaveSellingPlanGroups` mutation.", "fields": [ { "name": "productVariant", "description": "The product variant object.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantPositionInput", "description": "The input fields representing a product variant position.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the ID of the product variant to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "position", "description": "The order of the product variant in the list of product variants. The first position in the list is 1.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantPricePair", "description": "The compare-at price and price of a variant sharing a currency.\n", "fields": [ { "name": "compareAtPrice", "description": "The compare-at price of the variant with associated currency.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the variant with associated currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantPricePairConnection", "description": "An auto-generated type for paginating through multiple ProductVariantPricePairs.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantPricePairEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ProductVariantPricePairEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantPricePair", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantPricePairEdge", "description": "An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ProductVariantPricePairEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantPricePair", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantRelationshipBulkUpdatePayload", "description": "Return type for `productVariantRelationshipBulkUpdate` mutation.", "fields": [ { "name": "parentProductVariants", "description": "The product variants with successfully updated product variant relationships.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantRelationshipBulkUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantRelationshipBulkUpdateUserError", "description": "An error that occurs during the execution of `ProductVariantRelationshipBulkUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductVariantRelationshipBulkUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantRelationshipBulkUpdateUserErrorCode", "description": "Possible error codes that can be returned by `ProductVariantRelationshipBulkUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PARENT_REQUIRED", "description": "A parent product variant ID or product ID must be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_CREATE", "description": "Unable to create parent product variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANTS_NOT_FOUND", "description": "The product variants were not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CIRCULAR_REFERENCE", "description": "A parent product variant cannot contain itself as a component.", "isDeprecated": false, "deprecationReason": null }, { "name": "NESTED_PARENT_PRODUCT_VARIANT", "description": "Nested parent product variants aren't supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_QUANTITY", "description": "Product variant relationships must have a quantity greater than 0.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_PRODUCT_VARIANT_RELATIONSHIP", "description": "A parent product variant must not contain duplicate product variant relationships.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCEEDED_PRODUCT_VARIANT_RELATIONSHIP_LIMIT", "description": "Exceeded the maximum allowable product variant relationships in a parent product variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_RELATIONSHIP_TYPE_CONFLICT", "description": "A Core type relationship cannot be added to a composite product variant with SFN type relationships.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNEXPECTED_ERROR", "description": "Unexpected error.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_REMOVE", "description": "Unable to remove product variant relationships.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUST_SPECIFY_COMPONENTS", "description": "The product variant relationships to remove must be specified if all the parent product variant's components aren't being removed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_UPDATE", "description": "Unable to update product variant relationships.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED_TO_UPDATE_PARENT_PRODUCT_VARIANT_PRICE", "description": "Unable to update parent product variant price.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATE_PARENT_VARIANT_PRICE_REQUIRED", "description": "A price must be provided for a parent product variant if the price calucation is set to fixed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANTS_NOT_COMPONENTS", "description": "Some of the provided product variants are not components of the specified parent product variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_EXPANDER_APP_OWNERSHIP_ALREADY_EXISTS", "description": "The products for these product variants are already owned by another App.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_MULTIPACK_RELATIONSHIP", "description": "Multipack bundles are not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARENT_PRODUCT_VARIANT_CANNOT_BE_GIFT_CARD", "description": "Gift cards cannot be parent product variants.", "isDeprecated": false, "deprecationReason": null }, { "name": "PARENT_PRODUCT_VARIANT_CANNOT_REQUIRE_SELLING_PLAN", "description": "Parent product variants cannot require a selling plan.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantRelationshipUpdateInput", "description": "The input fields for updating a composite product variant.", "fields": null, "inputFields": [ { "name": "parentProductVariantId", "description": "The product variant ID representing that which contains the relationships with other variants.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "parentProductId", "description": "A product ID which contains product variants that have relationships with other variants.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "productVariantRelationshipsToCreate", "description": "The product variants and associated quantitites to add to the product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantGroupRelationshipInput", "ofType": null } } }, "defaultValue": "null" }, { "name": "productVariantRelationshipsToUpdate", "description": "The product variants and associated quantitites to update in specified product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductVariantGroupRelationshipInput", "ofType": null } } }, "defaultValue": "null" }, { "name": "productVariantRelationshipsToRemove", "description": "The bundle component product variants to be removed from the product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": "null" }, { "name": "removeAllProductVariantRelationships", "description": "Whether to remove all components from the product variant. The default value is `false`.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "priceInput", "description": "Method in which to update the price of the parent product variant.", "type": { "kind": "INPUT_OBJECT", "name": "PriceInput", "ofType": null }, "defaultValue": "null" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantSetInput", "description": "The input fields for specifying a product variant to create or update.", "fields": null, "inputFields": [ { "name": "requiresComponents", "description": "Whether a product variant requires components. The default value is `false`.\nIf `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted\nfrom channels that don't support bundles.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "barcode", "description": "The value of the barcode associated with the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "compareAtPrice", "description": "The compare-at price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "harmonizedSystemCode", "description": "The Harmonized System code (or HS Tariff code) for the variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "Specifies the product variant to update or create a new variant if absent.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "mediaId", "description": "The ID of the media to associate with the variant.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "inventoryPolicy", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "type": { "kind": "ENUM", "name": "ProductVariantInventoryPolicy", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "Additional customizable information about the product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "optionValues", "description": "The custom properties that a shop owner uses to define product variants.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "VariantOptionValueInput", "ofType": null } } } }, "defaultValue": null }, { "name": "position", "description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "requiresShipping", "description": "Whether the variant requires shipping.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "The SKU for the variant. Case-sensitive string.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "taxCode", "description": "The tax code associated with the variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "weight", "description": "The weight of the variant.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "weightUnit", "description": "The unit of weight that's used to measure the variant.", "type": { "kind": "ENUM", "name": "WeightUnit", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantSortKeys", "description": "The set of valid sort keys for the ProductVariant query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "SKU", "description": "Sort by the `sku` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_QUANTITY", "description": "Sort by the `inventory_quantity` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_MANAGEMENT", "description": "Sort by the `inventory_management` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_LEVELS_AVAILABLE", "description": "Sort by available inventory quantity in the location specified by the `query:\"location_id:\"` argument.\nDon't use this sort key when no `location_id` in query is specified.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_POLICY", "description": "Sort by the `inventory_policy` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULL_TITLE", "description": "Sort by the `full_title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "POPULAR", "description": "Sort by the `popular` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "POSITION", "description": "Sort by the `position` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantUpdatePayload", "description": "Return type for `productVariantUpdate` mutation.", "fields": [ { "name": "product", "description": "The product associated with the variant.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariant", "description": "The updated variant.", "args": [], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkCreatePayload", "description": "Return type for `productVariantsBulkCreate` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The newly created variants.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantsBulkCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantsBulkCreateStrategy", "description": "The set of strategies available for use on the `productVariantsBulkCreate` mutation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "The default strategy; keep the standalone variant (when product has only a single or default variant) when creating variants in bulk.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMOVE_STANDALONE_VARIANT", "description": "Delete the standalone variant (when product has only a single or default variant) when creating new variants in bulk.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkCreateUserError", "description": "Error codes for failed product variant bulk create mutations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductVariantsBulkCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantsBulkCreateUserErrorCode", "description": "Possible error codes that can be returned by `ProductVariantsBulkCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_KEY_ON_CREATE", "description": "On create, this key cannot be used.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_ALREADY_EXISTS", "description": "Variant already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "Variant price must be greater than or equal to zero.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEED_TO_ADD_OPTION_VALUES", "description": "Variant options are not enough.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS", "description": "Variant options are more than the product options.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_INVENTORY_LOCATIONS", "description": "Inventory locations cannot exceed the allowed resource limit or 10.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_VIOLATION", "description": "You reached the limit of available SKUs in your current plan.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_ALREADY_EXISTS_CHANGE_OPTION_VALUE", "description": "Variant options already exist. Please change the variant option(s).", "isDeprecated": false, "deprecationReason": null }, { "name": "TRACKED_VARIANT_LOCATION_NOT_FOUND", "description": "Quantity could not be set. The location was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUST_BE_FOR_THIS_PRODUCT", "description": "Input must be for this product.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_DEFINED_FOR_SHOP", "description": "Input is not defined for this shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "Invalid input detected.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEGATIVE_PRICE_VALUE", "description": "Price cannot take a negative value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkDeletePayload", "description": "Return type for `productVariantsBulkDelete` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantsBulkDeleteUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkDeleteUserError", "description": "Error codes for failed bulk variant delete mutations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductVariantsBulkDeleteUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantsBulkDeleteUserErrorCode", "description": "Possible error codes that can be returned by `ProductVariantsBulkDeleteUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_DELETE_LAST_VARIANT", "description": "Cannot delete default variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "AT_LEAST_ONE_VARIANT_DOES_NOT_BELONG_TO_THE_PRODUCT", "description": "The variant does not exist.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductVariantsBulkInput", "description": "The input fields for specifying a product variant to create as part of a variant bulk mutation.", "fields": null, "inputFields": [ { "name": "barcode", "description": "The value of the barcode associated with the product variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "compareAtPrice", "description": "The compare-at price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "id", "description": "Specifies the product variant to update or delete.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "mediaSrc", "description": "The URL of the media to associate with the variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "inventoryPolicy", "description": "Whether customers are allowed to place an order for the variant when it's out of stock.", "type": { "kind": "ENUM", "name": "ProductVariantInventoryPolicy", "ofType": null }, "defaultValue": null }, { "name": "inventoryQuantities", "description": "The inventory quantities at each location where the variant is stocked. The number of elements\nin the array of inventory quantities can't exceed the amount specified for the plan.\nSupported as input with the `productVariantsBulkCreate` mutation only.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "InventoryLevelInput", "ofType": null } } }, "defaultValue": null }, { "name": "inventoryItem", "description": "The inventory item associated with the variant, used for unit cost.", "type": { "kind": "INPUT_OBJECT", "name": "InventoryItemInput", "ofType": null }, "defaultValue": null }, { "name": "mediaId", "description": "The ID of the media that's associated with the variant.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "metafields", "description": "The additional customizable information about the product variant.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": null }, { "name": "optionValues", "description": "The custom properties that a shop owner uses to define product variants.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "VariantOptionValueInput", "ofType": null } } }, "defaultValue": null }, { "name": "price", "description": "The price of the variant.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "The SKU for the variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "taxCode", "description": "The tax code associated with the variant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkReorderPayload", "description": "Return type for `productVariantsBulkReorder` mutation.", "fields": [ { "name": "product", "description": "The updated product.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantsBulkReorderUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkReorderUserError", "description": "Error codes for failed bulk product variants reorder operation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductVariantsBulkReorderUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantsBulkReorderUserErrorCode", "description": "Possible error codes that can be returned by `ProductVariantsBulkReorderUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_VARIANT", "description": "Product variant does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_POSITION", "description": "Product variant position cannot be zero or negative number.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATED_VARIANT_ID", "description": "Product variant IDs must be unique.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkUpdatePayload", "description": "Return type for `productVariantsBulkUpdate` mutation.", "fields": [ { "name": "product", "description": "The updated product object.", "args": [], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "The updated variants.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantsBulkUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVariantsBulkUpdateUserError", "description": "Error codes for failed variant bulk update mutations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ProductVariantsBulkUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductVariantsBulkUpdateUserErrorCode", "description": "Possible error codes that can be returned by `ProductVariantsBulkUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_ID_MISSING", "description": "Product variant is missing ID attribute.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", "description": "Product variant does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_INVENTORY_QUANTITIES_ON_VARIANTS_UPDATE", "description": "Inventory quantities cannot be updated with variants API.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_ALREADY_EXISTS", "description": "The variant already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The price of the variant must be greater than or equal to zero.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEED_TO_ADD_OPTION_VALUES", "description": "Variant options are not enough.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS", "description": "Variant options are more than the product options.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_VIOLATION", "description": "You reached the limit of available SKUs in your current plan.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_INVENTORY_QUANTITES_DURING_UPDATE", "description": "Inventory quantities cannot be provided during update.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEGATIVE_PRICE_VALUE", "description": "Price cannot take a negative value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_SET_NAME_FOR_LINKED_OPTION_VALUE", "description": "Cannot set name for an option value linked to a metafield.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ProfileItemSortKeys", "description": "The set of valid sort keys for the ProfileItem query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TITLE", "description": "Sort by the `title` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_TYPE", "description": "Sort by the `product_type` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "VENDOR", "description": "Sort by the `vendor` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_TOTAL", "description": "Sort by the `inventory_total` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLISHED_AT", "description": "Sort by the `published_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PubSubServerPixelUpdatePayload", "description": "Return type for `pubSubServerPixelUpdate` mutation.", "fields": [ { "name": "serverPixel", "description": "The server pixel as configured by the mutation.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionCreatePayload", "description": "Return type for `pubSubWebhookSubscriptionCreate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was created.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionCreateUserError", "description": "An error that occurs during the execution of `PubSubWebhookSubscriptionCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PubSubWebhookSubscriptionCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PubSubWebhookSubscriptionCreateUserErrorCode", "description": "Possible error codes that can be returned by `PubSubWebhookSubscriptionCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID_PARAMETERS", "description": "Invalid parameters provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "Address for this topic has already been taken.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PubSubWebhookSubscriptionInput", "description": "The input fields for a PubSub webhook subscription.\n", "fields": null, "inputFields": [ { "name": "pubSubProject", "description": "The Pub/Sub project ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "pubSubTopic", "description": "The Pub/Sub topic ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "format", "description": "The format in which the webhook subscription should send the data.", "type": { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "ofType": null }, "defaultValue": null }, { "name": "includeFields", "description": "The list of fields to be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "metafieldNamespaces", "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionUpdatePayload", "description": "Return type for `pubSubWebhookSubscriptionUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PubSubWebhookSubscriptionUpdateUserError", "description": "An error that occurs during the execution of `PubSubWebhookSubscriptionUpdate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PubSubWebhookSubscriptionUpdateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PubSubWebhookSubscriptionUpdateUserErrorCode", "description": "Possible error codes that can be returned by `PubSubWebhookSubscriptionUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID_PARAMETERS", "description": "Invalid parameters provided.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Publication", "description": "A publication is a group of products and collections that is published to an app.\n", "fields": [ { "name": "app", "description": "The app associated with the publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use [AppCatalog.apps](https://shopify.dev/api/admin-graphql/unstable/objects/AppCatalog#connection-appcatalog-apps) instead." }, { "name": "autoPublish", "description": "Whether new products are automatically published to this publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalog", "description": "The catalog associated with the publication.", "args": [], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionPublicationsV3", "description": "The collection publications for the list of collections published to the publication.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collections", "description": "The list of collections published to the publication.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "hasCollection", "description": "Whether the collection is available to the publication.", "args": [ { "name": "id", "description": "Collection ID to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "Name of the publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use [Catalog.title](https://shopify.dev/api/admin-graphql/unstable/interfaces/Catalog#field-catalog-title) instead." }, { "name": "operation", "description": "A background operation associated with this publication.", "args": [], "type": { "kind": "UNION", "name": "PublicationOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productPublicationsV3", "description": "The product publications for the list of products published to the publication.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The list of products published to the publication.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "supportsFuturePublishing", "description": "Whether the publication supports future publishing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationConnection", "description": "An auto-generated type for paginating through multiple Publications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in PublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Publication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PublicationCreateInput", "description": "The input fields for creating a publication.", "fields": null, "inputFields": [ { "name": "catalogId", "description": "The ID of the catalog.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "defaultState", "description": "Whether to create an empty publication or prepopulate it with all products.", "type": { "kind": "ENUM", "name": "PublicationCreateInputPublicationDefaultState", "ofType": null }, "defaultValue": "EMPTY" }, { "name": "autoPublish", "description": "Whether to automatically add newly created products to this publication.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PublicationCreateInputPublicationDefaultState", "description": "The input fields for the possible values for the default state of a publication.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EMPTY", "description": "The publication is empty.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALL_PRODUCTS", "description": "The publication is populated with all products.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationCreatePayload", "description": "Return type for `publicationCreate` mutation.", "fields": [ { "name": "publication", "description": "The publication that's been created.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationDeletePayload", "description": "Return type for `publicationDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the publication that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationEdge", "description": "An auto-generated type which holds one Publication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of PublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Publication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PublicationInput", "description": "The input fields required to publish a resource.", "fields": null, "inputFields": [ { "name": "publicationId", "description": "ID of the publication.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "publishDate", "description": "The date and time that the resource was published. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing. This field has no effect if you include it in the `publishableUnpublish` mutation.\n", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "PublicationOperation", "description": "The possible types of publication operations.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AddAllProductsOperation", "ofType": null }, { "kind": "OBJECT", "name": "CatalogCsvOperation", "ofType": null }, { "kind": "OBJECT", "name": "PublicationResourceOperation", "ofType": null } ] }, { "kind": "OBJECT", "name": "PublicationResourceOperation", "description": "A bulk update operation on a publication.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "processedRowCount", "description": "The count of processed rows, summing imported, failed, and skipped rows.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rowCount", "description": "Represents a rows objects within this background operation.", "args": [], "type": { "kind": "OBJECT", "name": "RowCount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PublicationUpdateInput", "description": "The input fields for updating a publication.", "fields": null, "inputFields": [ { "name": "publishablesToAdd", "description": "A list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": "[]" }, { "name": "publishablesToRemove", "description": "A list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": "[]" }, { "name": "autoPublish", "description": "Whether new products should be automatically published to the publication.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationUpdatePayload", "description": "Return type for `publicationUpdate` mutation.", "fields": [ { "name": "publication", "description": "The publication that's been updated.", "args": [], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublicationUserError", "description": "Defines errors encountered while managing a publication.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "PublicationUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PublicationUserErrorCode", "description": "Possible error codes that can be returned by `PublicationUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "UNSUPPORTED_PUBLICATION_ACTION", "description": "Can't perform this action on a publication.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLICATION_NOT_FOUND", "description": "Publication not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLICATION_LOCKED", "description": "The publication is currently being modified. Please try again later.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSUPPORTED_PUBLISHABLE_TYPE", "description": "A catalog publication can only contain products.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_PUBLISHABLE_ID", "description": "Publishable ID not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_NOT_FOUND", "description": "Market does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_NOT_FOUND", "description": "Catalog does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_APP_CATALOG_PUBLICATION", "description": "Can't modify a publication that belongs to an app catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_MARKET_CATALOG_PUBLICATION", "description": "Can't modify a publication that belongs to a market catalog.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_APP_CATALOG", "description": "Cannot modify a catalog for an app.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANNOT_MODIFY_MARKET_CATALOG", "description": "Cannot modify a catalog for a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_TYPE_INCOMPATIBLE_WITH_CATALOG_TYPE", "description": "A product publication cannot be created because the catalog type associated with this publication does not permit publications of this product type.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLICATION_UPDATE_LIMIT_EXCEEDED", "description": "The limit for simultaneous publication updates has been exceeded.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "Publishable", "description": "Represents a resource that can be published to a channel.\nA publishable resource can be either a Product or Collection.\n", "fields": [ { "name": "availablePublicationsCount", "description": "The number of publications a resource is published to without feedback errors.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `resourcePublicationsCount` instead." }, { "name": "publishedOnChannel", "description": "Check to see whether the resource is published to a given channel.", "args": [ { "name": "channelId", "description": "The ID of the channel to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnPublication` instead." }, { "name": "publishedOnCurrentChannel", "description": "Check to see whether the resource is published to the calling app's channel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publishedOnCurrentPublication` instead." }, { "name": "publishedOnCurrentPublication", "description": "Check to see whether the resource is published to the calling app's publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishedOnPublication", "description": "Check to see whether the resource is published to a given publication.", "args": [ { "name": "publicationId", "description": "The ID of the publication to check.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublications", "description": "The list of resources that are published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsCount", "description": "The number of publications a resource is published on.", "args": [ { "name": "onlyPublished", "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourcePublicationsV2", "description": "The list of resources that are either published or staged to be published to a publication.", "args": [ { "name": "onlyPublished", "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" }, { "name": "catalogType", "description": "Filter publications by catalog type.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2Connection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unpublishedChannels", "description": "The list of channels that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `unpublishedPublications` instead." }, { "name": "unpublishedPublications", "description": "The list of publications that the resource is not published to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Collection", "ofType": null }, { "kind": "OBJECT", "name": "Product", "ofType": null } ] }, { "kind": "OBJECT", "name": "PublishablePublishPayload", "description": "Return type for `publishablePublish` mutation.", "fields": [ { "name": "publishable", "description": "Resource that has been published.", "args": [], "type": { "kind": "INTERFACE", "name": "Publishable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublishablePublishToCurrentChannelPayload", "description": "Return type for `publishablePublishToCurrentChannel` mutation.", "fields": [ { "name": "publishable", "description": "Resource that has been published.", "args": [], "type": { "kind": "INTERFACE", "name": "Publishable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublishableUnpublishPayload", "description": "Return type for `publishableUnpublish` mutation.", "fields": [ { "name": "publishable", "description": "Resource that has been unpublished.", "args": [], "type": { "kind": "INTERFACE", "name": "Publishable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PublishableUnpublishToCurrentChannelPayload", "description": "Return type for `publishableUnpublishToCurrentChannel` mutation.", "fields": [ { "name": "publishable", "description": "Resource that has been unpublished.", "args": [], "type": { "kind": "INTERFACE", "name": "Publishable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PurchasingCompany", "description": "Represents information about the purchasing company for the order or draft order.\n", "fields": [ { "name": "company", "description": "The company associated to the order or draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Company", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "contact", "description": "The company contact associated to the order or draft order.", "args": [], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The company location associated to the order or draft order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PurchasingCompanyInput", "description": "The input fields for a purchasing company, which is a combination of company, company contact, and company location.\n", "fields": null, "inputFields": [ { "name": "companyId", "description": "ID of the company.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyContactId", "description": "ID of the company contact.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "companyLocationId", "description": "ID of the company location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "PurchasingEntity", "description": "Represents information about the purchasing entity for the order or draft order.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "Customer", "ofType": null }, { "kind": "OBJECT", "name": "PurchasingCompany", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "PurchasingEntityInput", "description": "The input fields for a purchasing entity. Can either be a customer or a purchasing company.", "fields": null, "inputFields": [ { "name": "customerId", "description": "Represents a customer. Null if there's a purchasing company.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "purchasingCompany", "description": "Represents a purchasing company. Null if there's a customer.", "type": { "kind": "INPUT_OBJECT", "name": "PurchasingCompanyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityPriceBreak", "description": "Quantity price breaks lets you offer different rates that are based on the\namount of a specific variant being ordered.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimumQuantity", "description": "Minimum quantity required to reach new quantity break price.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of variant after reaching the minimum quanity.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "The price list associated with this quantity break.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceList", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "The product variant associated with this quantity break.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityPriceBreakConnection", "description": "An auto-generated type for paginating through multiple QuantityPriceBreaks.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPriceBreakEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in QuantityPriceBreakEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPriceBreak", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityPriceBreakEdge", "description": "An auto-generated type which holds one QuantityPriceBreak and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of QuantityPriceBreakEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPriceBreak", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "QuantityPriceBreakInput", "description": "The input fields and values to use when creating quantity price breaks.", "fields": null, "inputFields": [ { "name": "variantId", "description": "The product variant ID associated with the quantity break.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "price", "description": "The price of the product variant when its quantity meets the break's minimum quantity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "minimumQuantity", "description": "The minimum required quantity for a variant to qualify for this price.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "QuantityPriceBreakSortKeys", "description": "The set of valid sort keys for the QuantityPriceBreak query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "MINIMUM_QUANTITY", "description": "Sort by the `minimum_quantity` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "QuantityPricingByVariantUpdateInput", "description": "The input fields used to update quantity pricing.", "fields": null, "inputFields": [ { "name": "quantityPriceBreaksToAdd", "description": "A list of quantity price breaks to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "QuantityPriceBreakInput", "ofType": null } } } }, "defaultValue": null }, { "name": "quantityPriceBreaksToDelete", "description": "A list of quantity price break IDs that identify which quantity breaks to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "quantityRulesToAdd", "description": "A list of quantity rules to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "QuantityRuleInput", "ofType": null } } } }, "defaultValue": null }, { "name": "quantityRulesToDeleteByVariantId", "description": "A list of variant IDs that identify which quantity rules to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "pricesToAdd", "description": "A list of fixed prices to add.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PriceListPriceInput", "ofType": null } } } }, "defaultValue": null }, { "name": "pricesToDeleteByVariantId", "description": "A list of variant IDs that identify which fixed prices to remove.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityPricingByVariantUpdatePayload", "description": "Return type for `quantityPricingByVariantUpdate` mutation.", "fields": [ { "name": "productVariants", "description": "The variants for which quantity pricing was created successfully in the price list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityPricingByVariantUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityPricingByVariantUserError", "description": "Error codes for failed volume pricing operations.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "QuantityPricingByVariantUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "QuantityPricingByVariantUserErrorCode", "description": "Possible error codes that can be returned by `QuantityPricingByVariantUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_NOT_FOUND", "description": "Price List does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "Something went wrong when trying to update quantity pricing. Please try again later.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_INVALID", "description": "Invalid quantity price break.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_PRICE_LIST_PRICE_NOT_FOUND", "description": "Quantity price break's fixed price not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_LIMIT_EXCEEDED", "description": "Exceeded the allowed number of quantity price breaks per variant.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_CURRENCY_MISMATCH", "description": "Price list and quantity price break currency mismatch.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_FAILED_TO_SAVE", "description": "Failed to save quantity price break.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_MIN_LOWER_THAN_QUANTITY_RULES_MIN", "description": "Quantity price break miniumum is less than the quantity rule minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_MIN_HIGHER_THAN_QUANTITY_RULES_MAX", "description": "Quantity price break miniumum is higher than the quantity rule maximum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_MIN_NOT_A_MULTIPLE_OF_QUANTITY_RULES_INCREMENT", "description": "Quantity price break miniumum is not multiple of the quantity rule increment.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_VARIANT_NOT_FOUND", "description": "Quantity price break variant not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_ADD_DUPLICATE_INPUT_FOR_VARIANT_AND_MIN", "description": "Quantity price breaks to add inputs must be unique by variant id and minimum quantity.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_DELETE_NOT_FOUND", "description": "Quantity price break not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_PRICE_BREAK_DELETE_FAILED", "description": "Failed to delete quantity price break.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_VARIANT_NOT_FOUND", "description": "Quantity rule variant not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MIN_HIGHER_THAN_QUANTITY_PRICE_BREAK_MIN", "description": "Quantity rule minimum is higher than the quantity price break minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MAX_LOWER_THAN_QUANTITY_PRICE_BREAK_MIN", "description": "Quantity rule maximum is less than the quantity price break minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_INCREMENT_NOT_A_MULTIPLE_OF_QUANTITY_PRICE_BREAK_MIN", "description": "Quantity rule increment must be a multiple of the quantity price break minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_CATALOG_CONTEXT_NOT_SUPPORTED", "description": "Quantity rule catalog context not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_INCREMENT_IS_GREATER_THAN_MINIMUM", "description": "Quantity rule increment is greater than minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MINIMUM_NOT_A_MULTIPLE_OF_INCREMENT", "description": "Quantity rule minimum is not a multiple of increment.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MAXIMUM_NOT_A_MULTIPLE_OF_INCREMENT", "description": "Quantity rule maximum is not a multiple of increment.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MINIMUM_GREATER_THAN_MAXIMUM", "description": "Quantity rule minimum is greater than maximum.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_INCREMENT_IS_LESS_THAN_ONE", "description": "Quantity rule increment is less than one.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MINIMUM_IS_LESS_THAN_ONE", "description": "Quantity rule minimum is less than one.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_MAXIMUM_IS_LESS_THAN_ONE", "description": "Quantity rule maximum is less than one.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_ADD_DUPLICATE_INPUT_FOR_VARIANT", "description": "Quantity rules to add inputs must be unique by variant id.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_DELETE_RULE_NOT_FOUND", "description": "Quantity rule not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_RULE_DELETE_VARIANT_NOT_FOUND", "description": "Quantity rule variant not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_ADD_CURRENCY_MISMATCH", "description": "Price list and fixed price currency mismatch.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_ADD_VARIANT_NOT_FOUND", "description": "Fixed price's variant not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_ADD_DUPLICATE_INPUT_FOR_VARIANT", "description": "Prices to add inputs must be unique by variant id.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_DELETE_PRICE_NOT_FIXED", "description": "Price is not fixed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_DELETE_VARIANT_NOT_FOUND", "description": "Fixed price's variant not found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRule", "description": "The quantity rule for the product variant in a given context.\n", "fields": [ { "name": "increment", "description": "The value that specifies the quantity increment between minimum and maximum of the rule.\nOnly quantities divisible by this value will be considered valid.\n\nThe increment must be lower than or equal to the minimum and the maximum, and both minimum and maximum\nmust be divisible by this value.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDefault", "description": "Whether the quantity rule fields match one increment, one minimum and no maximum.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximum", "description": "An optional value that defines the highest allowed quantity purchased by the customer.\nIf defined, maximum must be lower than or equal to the minimum and must be a multiple of the increment.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimum", "description": "The value that defines the lowest allowed quantity purchased by the customer.\nThe minimum must be a multiple of the quantity rule's increment.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originType", "description": "Whether the values of the quantity rule were explicitly set.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "QuantityRuleOriginType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariant", "description": "The product variant for which the quantity rule is applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRuleConnection", "description": "An auto-generated type for paginating through multiple QuantityRules.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRuleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in QuantityRuleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRule", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRuleEdge", "description": "An auto-generated type which holds one QuantityRule and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of QuantityRuleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRule", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "QuantityRuleInput", "description": "The input fields for the per-order quantity rule to be applied on the product variant.\n", "fields": null, "inputFields": [ { "name": "increment", "description": "The quantity increment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "maximum", "description": "The maximum quantity.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "null" }, { "name": "minimum", "description": "The minimum quantity.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "variantId", "description": "Product variant on which to apply the quantity rule.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "QuantityRuleOriginType", "description": "The origin of quantity rule on a price list.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FIXED", "description": "Quantity rule is explicitly defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELATIVE", "description": "Quantity rule falls back to the relative rule.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRuleUserError", "description": "An error for a failed quantity rule operation.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "QuantityRuleUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "QuantityRuleUserErrorCode", "description": "Possible error codes that can be returned by `QuantityRuleUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", "description": "Product variant ID does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_LIST_DOES_NOT_EXIST", "description": "Price list does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANT_QUANTITY_RULE_DOES_NOT_EXIST", "description": "Quantity rule for variant associated with the price list provided does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MINIMUM_IS_GREATER_THAN_MAXIMUM", "description": "Minimum must be lower than or equal to the maximum.", "isDeprecated": false, "deprecationReason": null }, { "name": "MINIMUM_IS_HIGHER_THAN_QUANTITY_PRICE_BREAK_MINIMUM", "description": "Minimum must be less than or equal to all quantity price break minimums associated with this variant in the specified price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_IS_LOWER_THAN_QUANTITY_PRICE_BREAK_MINIMUM", "description": "Maximum must be greater than or equal to all quantity price break minimums associated with this variant in the specified price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCREMENT_NOT_A_MULTIPLE_OF_QUANTITY_PRICE_BREAK_MINIMUM", "description": "Increment must be a multiple of all quantity price break minimums associated with this variant in the specified price list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCREMENT_IS_GREATER_THAN_MINIMUM", "description": "Increment must be lower than or equal to the minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "Value must be greater than or equal to 1.", "isDeprecated": false, "deprecationReason": null }, { "name": "MAXIMUM_NOT_MULTIPLE_OF_INCREMENT", "description": "The maximum must be a multiple of the increment.", "isDeprecated": false, "deprecationReason": null }, { "name": "MINIMUM_NOT_MULTIPLE_OF_INCREMENT", "description": "The minimum must be a multiple of the increment.", "isDeprecated": false, "deprecationReason": null }, { "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", "description": "Quantity rules can be associated only with company location catalogs.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_INPUT_FOR_VARIANT", "description": "Quantity rule inputs must be unique by variant id.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "Something went wrong when trying to save the quantity rule. Please try again later.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRulesAddPayload", "description": "Return type for `quantityRulesAdd` mutation.", "fields": [ { "name": "quantityRules", "description": "The list of quantity rules that were added to or updated in the price list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRule", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QuantityRulesDeletePayload", "description": "Return type for `quantityRulesDelete` mutation.", "fields": [ { "name": "deletedQuantityRulesVariantIds", "description": "A list of product variant IDs whose quantity rules were removed from the price list.\n", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "QuantityRuleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "QueryRoot", "description": "The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.", "fields": [ { "name": "abandonment", "description": "Returns an abandonment by ID.", "args": [ { "name": "id", "description": "The ID of the Abandonment to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Abandonment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "abandonmentByAbandonedCheckoutId", "description": "Returns an Abandonment by the Abandoned Checkout ID.", "args": [ { "name": "abandonedCheckoutId", "description": "The ID of the Abandoned Checkout ID to query by.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Abandonment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "Lookup an App by ID or return the currently authenticated App.", "args": [ { "name": "id", "description": "The ID to lookup the App by.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appByHandle", "description": "Fetches app by handle.\nReturns null if the app doesn't exist.\n", "args": [ { "name": "handle", "description": "Handle of the App.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appByKey", "description": "Fetches an app by its client ID.\nReturns null if the app doesn't exist.\n", "args": [ { "name": "apiKey", "description": "Client ID of the app.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appDiscountType", "description": "An app discount type.\n", "args": [ { "name": "functionId", "description": "The ID for the function providing the app discount type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AppDiscountType", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appDiscountTypes", "description": "A list of app discount types installed by apps.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppDiscountType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appInstallation", "description": "Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.", "args": [ { "name": "id", "description": "ID used to lookup AppInstallation.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AppInstallation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appInstallations", "description": "A list of app installations. To use this query, you need to contact [Shopify Support](https://partners.shopify.com/current/support/) to grant your custom app the `read_apps` access scope. Public apps can't be granted this access scope.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AppInstallationSortKeys", "ofType": null }, "defaultValue": "INSTALLED_AT" }, { "name": "category", "description": "The category of app installations to fetch.", "type": { "kind": "ENUM", "name": "AppInstallationCategory", "ofType": null }, "defaultValue": null }, { "name": "privacy", "description": "The privacy level of app installations to fetch.", "type": { "kind": "ENUM", "name": "AppInstallationPrivacy", "ofType": null }, "defaultValue": "PUBLIC" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppInstallationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "automaticDiscount", "description": "Returns an automatic discount resource by ID.", "args": [ { "name": "id", "description": "The ID of the DiscountAutomatic to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "UNION", "name": "DiscountAutomatic", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `automaticDiscountNode` instead." }, { "name": "automaticDiscountNode", "description": "Returns an automatic discount resource by ID.", "args": [ { "name": "id", "description": "The ID of the DiscountAutomaticNode to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountAutomaticNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "automaticDiscountNodes", "description": "List of automatic discounts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AutomaticDiscountSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| status |\n| type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticNodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "automaticDiscountSavedSearches", "description": "List of the shop's automatic discount saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "automaticDiscounts", "description": "List of automatic discounts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "AutomaticDiscountSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| status |\n| type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAutomaticConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `automaticDiscountNodes` instead." }, { "name": "availableCarrierServices", "description": "Returns a list of activated carrier services and associated shop locations that support them.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCarrierServiceAndLocations", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "availableLocales", "description": "A list of available locales.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Locale", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "carrierService", "description": "Returns a `DeliveryCarrierService` object by ID.", "args": [ { "name": "id", "description": "The ID of the DeliveryCarrierService to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartTransforms", "description": "List of Cart transform objects owned by the current API client.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cashTrackingSession", "description": "Lookup a cash tracking session by ID.", "args": [ { "name": "id", "description": "The ID of the CashTrackingSession to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CashTrackingSession", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cashTrackingSessions", "description": "Returns a shop's cash tracking sessions for locations with a POS Pro subscription.\n\nTip: To query for cash tracking sessions in bulk, you can\n[perform a bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/queries).\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CashTrackingSessionsSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| closing_time |\n| location_id |\n| opening_time |\n| point_of_sale_device_ids |\n| status |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CashTrackingSessionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalog", "description": "Returns a Catalog resource by ID.", "args": [ { "name": "id", "description": "The ID of the Catalog to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "INTERFACE", "name": "Catalog", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogOperations", "description": "Returns the most recent catalog operations for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ResourceOperation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogs", "description": "The catalogs belonging to the shop.", "args": [ { "name": "type", "description": "The type of the catalogs to be returned.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": "null" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CatalogSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id |\n| company_id |\n| company_location_id |\n| managed_country_id |\n| market_id |\n| status |\n| title |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CatalogConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalogsCount", "description": "The count of catalogs belonging to the shop. Limited to a maximum of 10000.", "args": [ { "name": "type", "description": "The type of the catalogs to be returned.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": "null" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id |\n| company_id |\n| company_location_id |\n| managed_country_id |\n| market_id |\n| status |\n| title |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "channel", "description": "Lookup a channel by ID.", "args": [ { "name": "id", "description": "The ID of the Channel to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Channel", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `publication` instead." }, { "name": "channels", "description": "List of the active sales channels.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publications` instead." }, { "name": "checkoutBranding", "description": "Returns the visual customizations for checkout for a given checkout profile.\n\nTo learn more about updating checkout branding settings, refer to the\n[checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert)\nmutation and the checkout branding [tutorial](https://shopify.dev/docs/apps/checkout/styling).\n", "args": [ { "name": "checkoutProfileId", "description": "A globally-unique identifier.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CheckoutBranding", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkoutProfile", "description": "A checkout profile on a shop.", "args": [ { "name": "id", "description": "The ID of the checkout profile.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CheckoutProfile", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkoutProfiles", "description": "List of checkout profiles on a shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CheckoutProfileSortKeys", "ofType": null }, "defaultValue": "UPDATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| is_published |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutProfileConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codeDiscountNode", "description": "Returns a code discount resource by ID.", "args": [ { "name": "id", "description": "The ID of the DiscountCodeNode to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "codeDiscountNodeByCode", "description": "Returns a code discount identified by its discount code.", "args": [ { "name": "code", "description": "The case-insensitive code of the `DiscountCodeNode` to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountCodeNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "codeDiscountNodes", "description": "List of code discounts. Special fields for query params:\n * status: active, expired, scheduled\n * discount_type: bogo, fixed_amount, free_shipping, percentage.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CodeDiscountSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| combines_with |\n| created_at |\n| discount_type |\n| ends_at |\n| starts_at |\n| status |\n| times_used |\n| title |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountCodeNodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "codeDiscountSavedSearches", "description": "List of the shop's code discount saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collection", "description": "Returns a Collection resource by ID.", "args": [ { "name": "id", "description": "The ID of the Collection to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionByHandle", "description": "Return a collection by its handle.\n", "args": [ { "name": "handle", "description": "The handle of the collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionRulesConditions", "description": "Lists all rules that can be used to create smart collections.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionRuleConditions", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionSavedSearches", "description": "Returns a list of the shop's collection saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collections", "description": "Returns a list of collections.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CollectionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| collection_type |\n| product_publication_status |\n| publishable_status |\n| published_status |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companies", "description": "Returns the list of companies in the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanySortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| active_customers_count |\n| created_at |\n| external_id |\n| name |\n| since_date |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "companiesCount", "description": "The number of companies for a shop.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "Returns a `Company` object by ID.", "args": [ { "name": "id", "description": "The ID of the Company to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Company", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContact", "description": "Returns a `CompanyContact` object by ID.", "args": [ { "name": "id", "description": "The ID of the CompanyContact to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContact", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyContactRole", "description": "Returns a `CompanyContactRole` object by ID.", "args": [ { "name": "id", "description": "The ID of the CompanyContactRole to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyContactRole", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocation", "description": "Returns a `CompanyLocation` object by ID.", "args": [ { "name": "id", "description": "The ID of the CompanyLocation to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompanyLocation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "companyLocations", "description": "Returns the list of company locations in the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CompanyLocationSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| company_id |\n| created_at |\n| external_id |\n| ids |\n| name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CompanyLocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentAppInstallation", "description": "Return the AppInstallation for the currently authenticated App.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppInstallation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currentBulkOperation", "description": "Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.", "args": [ { "name": "type", "description": "The current bulk operation's type.", "type": { "kind": "ENUM", "name": "BulkOperationType", "ofType": null }, "defaultValue": "QUERY" } ], "type": { "kind": "OBJECT", "name": "BulkOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "Returns a Customer resource by ID.", "args": [ { "name": "id", "description": "The ID of the Customer to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerMergeJobStatus", "description": "Returns the status of a customer merge request job.", "args": [ { "name": "jobId", "description": "The ID of the job performing the customer merge request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerMergeRequest", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerMergePreview", "description": "Returns a preview of a customer merge request.", "args": [ { "name": "customerOneId", "description": "The ID of the first customer that will be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "customerTwoId", "description": "The ID of the second customer that will be merged.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "overrideFields", "description": "The fields to override the default customer merge rules.", "type": { "kind": "INPUT_OBJECT", "name": "CustomerMergeOverrideFields", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerMergePreview", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethod", "description": "Returns a CustomerPaymentMethod resource by its ID.", "args": [ { "name": "id", "description": "The ID of the CustomerPaymentMethod to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSegmentMembers", "description": "The list of members, such as customers, that's associated with an individual segment.", "args": [ { "name": "segmentId", "description": "The ID of the segment.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "query", "description": "The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "queryId", "description": "The ID of the segment members query.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "timezone", "description": "The timezone that's used to interpret relative date arguments. The timezone defaults to UTC if the timezone isn't provided.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the list. The sorting behaviour defaults to ascending order.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the list by a given key.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerSegmentMemberConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSegmentMembersQuery", "description": "Returns a segment members query resource by ID.", "args": [ { "name": "id", "description": "The ID of the CustomerSegmentMembersQuery to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerSegmentMembersQuery", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSegmentMembership", "description": "Whether a member, which is a customer, belongs to a segment.", "args": [ { "name": "segmentIds", "description": "The segments to evaluate for the given customer.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "customerId", "description": "The ID of the customer that has the membership.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMembershipResponse", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customers", "description": "List of customers.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CustomerSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| accepts_marketing |\n| country |\n| customer_date |\n| email |\n| last_abandoned_order_date |\n| order_date |\n| orders_count |\n| phone |\n| state |\n| tag |\n| tag_not |\n| total_spent |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deletionEvents", "description": "The paginated list of deletion events.", "args": [ { "name": "subjectTypes", "description": "List of subject types to filter by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DeletionEventSubjectType", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DeletionEventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| occurred_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeletionEventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomization", "description": "The delivery customization.", "args": [ { "name": "id", "description": "The ID of the delivery customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCustomizations", "description": "The delivery customizations.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| enabled |\n| function_id |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryCustomizationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfile", "description": "Returns a Delivery Profile resource by ID.", "args": [ { "name": "id", "description": "The ID of the DeliveryProfile to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfiles", "description": "Returns a list of saved delivery profiles.", "args": [ { "name": "merchantOwnedOnly", "description": "If `true`, returns only delivery profiles that were created by the merchant.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DeliveryProfileConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliverySettings", "description": "Returns the shop-wide shipping settings.", "args": [], "type": { "kind": "OBJECT", "name": "DeliverySetting", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountCodesCount", "description": "The total number of discount codes for the shop.", "args": [ { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountNode", "description": "Returns a discount resource by ID.", "args": [ { "name": "id", "description": "The ID of the DiscountNode to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountNodes", "description": "List of discounts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| combines_with | | - `PRODUCT_DISCOUNTS`
- `ORDER_DISCOUNTS`
- `SHIPPING_DISCOUNTS` | | |\n| discount_class | | - `PRODUCT`
- `ORDER`
- `SHIPPING` | | |\n| discount_type |\n| method |\n| starts_at |\n| status |\n| times_used |\n| title |\n| type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountNodeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountRedeemCodeBulkCreation", "description": "Returns a bulk code creation resource by ID.", "args": [ { "name": "id", "description": "The ID of the DiscountRedeemCodeBulkCreation to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DiscountRedeemCodeBulkCreation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountRedeemCodeSavedSearches", "description": "List of the shop's redeemed discount code saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DiscountCodeSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| times_used |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "dispute", "description": "Returns dispute details based on ID.", "args": [ { "name": "id", "description": "The ID of the ShopifyPaymentsDispute to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "disputeEvidence", "description": "Returns dispute evidence details based on ID.", "args": [ { "name": "id", "description": "The ID of the ShopifyPaymentsDisputeEvidence to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEvidence", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "domain", "description": "Lookup a Domain by ID.", "args": [ { "name": "id", "description": "The ID of the Domain to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Domain", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrder", "description": "Returns a DraftOrder resource by ID.", "args": [ { "name": "id", "description": "The ID of the DraftOrder to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderSavedSearches", "description": "List of the shop's draft order saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrderTag", "description": "Returns a DraftOrderTag resource by ID.", "args": [ { "name": "id", "description": "The ID of the DraftOrderTag to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DraftOrderTag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "List of saved draft orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| customer_id |\n| source |\n| status |\n| tag |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileSavedSearches", "description": "A list of the shop's file saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "files", "description": "Returns a paginated list of files that have been uploaded to Shopify.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "FileSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| filename |\n| ids |\n| media_type |\n| original_upload_size |\n| product_id |\n| status |\n| updated_at |\n| used_in |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillment", "description": "Returns a Fulfillment resource by ID.", "args": [ { "name": "id", "description": "The ID of the Fulfillment to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentConstraintRules", "description": "The fulfillment constraint rules that belong to a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentConstraintRule", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrder", "description": "Returns a Fulfillment order resource by ID.", "args": [ { "name": "id", "description": "The ID of the FulfillmentOrder to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrders", "description": "The paginated list of all fulfillment orders.\nThe returned fulfillment orders are filtered according to the\n[fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes)\ngranted to the app.\n\nUse this query to retrieve fulfillment orders assigned to merchant-managed locations,\nthird-party fulfillment service locations, or all kinds of locations together.\n\nFor fetching only the fulfillment orders assigned to the app's locations, use the\n[Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders)\nconnection.\n", "args": [ { "name": "includeClosed", "description": "Whether to include closed fulfillment orders.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "FulfillmentOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| assigned_location_id |\n| status |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentService", "description": "Returns a FulfillmentService resource by ID.", "args": [ { "name": "id", "description": "The ID of the FulfillmentService to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCard", "description": "Returns a gift card resource by ID.", "args": [ { "name": "id", "description": "The ID of the GiftCard to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCard", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCards", "description": "Returns a list of gift cards.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "GiftCardSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| balance_status |\n| created_at |\n| expires_on |\n| initial_value |\n| source |\n| status |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardsCount", "description": "The total number of gift cards issued for the shop. Limited to a maximum of 10000.", "args": [ { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| balance_status |\n| created_at |\n| expires_on |\n| initial_value |\n| source |\n| status |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItem", "description": "Returns an\n[InventoryItem](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem)\nobject by ID.\n", "args": [ { "name": "id", "description": "The ID of the InventoryItem to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItems", "description": "Returns a list of inventory items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| id |\n| sku |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryLevel", "description": "Returns an\n[InventoryLevel](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel)\nobject by ID.\n", "args": [ { "name": "id", "description": "The ID of the InventoryLevel to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "InventoryLevel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryProperties", "description": "General inventory properties for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryProperties", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "job", "description": "Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.\n", "args": [ { "name": "id", "description": "ID of the job to query.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "Returns an inventory Location resource by ID.", "args": [ { "name": "id", "description": "The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": "Returns a list of active inventory locations.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "LocationSortKeys", "ofType": null }, "defaultValue": "NAME" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| active |\n| address1 |\n| address2 |\n| city |\n| country |\n| legacy |\n| name |\n| province |\n| zip |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "includeLegacy", "description": "If true, also include the legacy locations of fulfillment services.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "includeInactive", "description": "If true, also include the locations that are deactivated.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locationsAvailableForDeliveryProfiles", "description": "Returns a list of all origin locations available for a delivery profile.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } } }, "isDeprecated": true, "deprecationReason": "Use `locationsAvailableForDeliveryProfilesConnection` instead." }, { "name": "locationsAvailableForDeliveryProfilesConnection", "description": "Returns a list of all origin locations available for a delivery profile.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "manualHoldsFulfillmentOrders", "description": "Returns a list of fulfillment orders that are on hold.", "args": [ { "name": "query", "description": "The query conditions used to filter fulfillment orders. Only fulfillment orders corresponding to orders matching the query will be counted.\nSupported filter parameters:\n - `order_financial_status`\n - `order_risk_level`\n - `shipping_address_coordinates_validated`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "Returns a market resource by ID.", "args": [ { "name": "id", "description": "The ID of the Market to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketByGeography", "description": "Returns the applicable market for a customer based on where they are in the world.", "args": [ { "name": "countryCode", "description": "The code for the country where the customer is.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizableResource", "description": "A resource that can have localized values for different markets.", "args": [ { "name": "resourceId", "description": "Find a market localizable resource by ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketLocalizableResource", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizableResources", "description": "Resources that can have localized values for different markets.", "args": [ { "name": "resourceType", "description": "Return only resources of a type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MarketLocalizableResourceType", "ofType": null } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableResourceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketLocalizableResourcesByIds", "description": "Resources that can have localized values for different markets.", "args": [ { "name": "resourceIds", "description": "Return only resources for given IDs.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketLocalizableResourceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivities", "description": "A list of marketing activities associated with the marketing app.", "args": [ { "name": "marketingActivityIds", "description": "The list of marketing activity IDs to filter by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": "[]" }, { "name": "remoteIds", "description": "The list of remote IDs associated with marketing activities to filter by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": "[]" }, { "name": "utm", "description": "The UTM parameters associated with marketing activities to filter by.", "type": { "kind": "INPUT_OBJECT", "name": "UTMInput", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MarketingActivitySortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id |\n| app_name |\n| created_at |\n| marketing_campaign_id |\n| scheduled_to_end_at |\n| scheduled_to_start_at |\n| tactic |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingActivityConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingActivity", "description": "Returns a MarketingActivity resource by ID.", "args": [ { "name": "id", "description": "The ID of the MarketingActivity to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingActivity", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEvent", "description": "Returns a MarketingEvent resource by ID.", "args": [ { "name": "id", "description": "The ID of the MarketingEvent to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MarketingEvent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketingEvents", "description": "A list of marketing events associated with the marketing app.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MarketingEventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id |\n| description |\n| started_at |\n| type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingEventConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "markets", "description": "The markets configured for the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinition", "description": "Returns a metafield definition by ID.", "args": [ { "name": "id", "description": "The ID of the MetafieldDefinition to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitionTypes", "description": "Each metafield definition has a type, which defines the type of information that it can store.\nThis type is enforced across every instance of the resource that owns the metafield definition.\n\nRefer to the [list of supported metafield types](https://shopify.dev/apps/metafields/types).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "key", "description": "Filter metafield definition by key.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "namespace", "description": "Filter metafield definition by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "ownerType", "description": "Filter the metafield definition by the specific owner type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter the metafield definition by the pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldStorefrontVisibilities", "description": "List of the `MetafieldStorefrontVisibility` records.", "args": [ { "name": "namespace", "description": "Filter the visible metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibilityConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "This query will be removed in a future version. Use the `access.storefront` field for nodes inside the `metafieldDefinitions` query instead.\n" }, { "name": "metafieldStorefrontVisibility", "description": "Returns a `MetafieldStorefrontVisibility` record by ID. A `MetafieldStorefrontVisibility` record lists the\nmetafields to make visible in the Storefront API.\n", "args": [ { "name": "id", "description": "The ID of the MetafieldStorefrontVisibility to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetafieldStorefrontVisibility", "ofType": null }, "isDeprecated": true, "deprecationReason": "This query will be removed in a future version. Use the `access.storefront` field inside the `metafieldDefinition` query instead.\n" }, { "name": "metaobject", "description": "Retrieves a metaobject by ID.", "args": [ { "name": "id", "description": "The ID of the metaobject to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectByHandle", "description": "Retrieves a metaobject by handle.", "args": [ { "name": "handle", "description": "The identifier of the metaobject to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetaobjectHandleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metaobject", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinition", "description": "Retrieves a metaobject definition by ID.", "args": [ { "name": "id", "description": "The ID of the metaobject to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinitionByType", "description": "Finds a metaobject definition by type.", "args": [ { "name": "type", "description": "The type of the metaobject definition to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjectDefinitions", "description": "All metaobject definitions.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metaobjects", "description": "All metaobjects for the shop.", "args": [ { "name": "type", "description": "The type of the metaobjects to query.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "sortKey", "description": "The key of a field to sort with. Supports \"id\", \"type\", \"updated_at\", and \"display_name\".\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| display_name |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "Returns a specific node (any object that implements the\n[Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node)\ninterface) by ID, in accordance with the\n[Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification).\nThis field is commonly used for refetching an object.\n", "args": [ { "name": "id", "description": "The ID of the Node to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "INTERFACE", "name": "Node", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "Returns the list of nodes (any objects that implement the\n[Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node)\ninterface) with the given IDs, in accordance with the\n[Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification).\n", "args": [ { "name": "ids", "description": "The IDs of the Nodes to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "Node", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "Returns an Order resource by ID.", "args": [ { "name": "id", "description": "The ID of the Order to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderPaymentStatus", "description": "Returns a payment status by payment reference ID. Used to check the status of a deferred payment.", "args": [ { "name": "paymentReferenceId", "description": "Unique identifier returned by orderCreatePayment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "orderId", "description": "ID of the order for which the payment was initiated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "OrderPaymentStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderSavedSearches", "description": "List of the shop's order saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "Returns a list of orders placed.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "PROCESSED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| cart_token |\n| channel |\n| channel_id |\n| chargeback_status |\n| checkout_token |\n| confirmation_number |\n| created_at |\n| credit_card_last4 |\n| customer_id |\n| delivery_method |\n| discount_code |\n| email |\n| financial_status |\n| fraud_protection_level |\n| fulfillment_location_id |\n| fulfillment_status |\n| gateway |\n| location_id |\n| name |\n| payment_id |\n| payment_provider_id |\n| po_number |\n| processed_at |\n| reference_location_id |\n| return_status |\n| risk_level |\n| sales_channel |\n| sku |\n| source_identifier |\n| source_name |\n| status |\n| tag |\n| tag_not |\n| test |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomization", "description": "The payment customization.", "args": [ { "name": "id", "description": "The ID of the payment customization.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaymentCustomization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentCustomizations", "description": "The payment customizations.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| enabled |\n| function_id |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentCustomizationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentTermsTemplates", "description": "The list of payment terms templates eligible for all shops and users.", "args": [ { "name": "paymentTermsType", "description": "The payment terms type to filter the payment terms templates list.", "type": { "kind": "ENUM", "name": "PaymentTermsType", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentTermsTemplate", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pendingOrdersCount", "description": "The number of pendings orders. Limited to a maximum of 10000.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceList", "description": "Returns a price list resource by ID.", "args": [ { "name": "id", "description": "The ID of the `PriceList` to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceLists", "description": "All price lists for a shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "PriceListSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceListConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRule", "description": "Returns a code price rule resource by ID.", "args": [ { "name": "id", "description": "The ID of the PriceRule to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PriceRule", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `codeDiscountNode` instead." }, { "name": "priceRuleSavedSearches", "description": "List of the shop's price rule saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRules", "description": "Returns a list of price rule resources that have at least one associated discount code.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "PriceRuleSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| combines_with |\n| created_at |\n| discount_type |\n| ends_at |\n| starts_at |\n| status |\n| times_used |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `codeDiscountNodes` instead." }, { "name": "primaryMarket", "description": "The primary market of the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Market", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by ID.\nPrivate metafields are accessible only by the application that created them.\n", "args": [ { "name": "id", "description": "The ID of the PrivateMetafield to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "Returns a list of private metafields associated to a resource.\n", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "owner", "description": "Retrieve the private metafields of a certain resource, specified by the resource ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "product", "description": "Returns a Product resource by ID.", "args": [ { "name": "id", "description": "The ID of the Product to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productByHandle", "description": "Return a product by its handle.\n", "args": [ { "name": "handle", "description": "A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: `-`. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called `Potion`, then their handles would be `potion` and `potion-1`. After a product has been created, changing the product title doesn't update the handle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDuplicateJob", "description": "Returns the product duplicate job.", "args": [ { "name": "id", "description": "An ID of a product duplicate job to fetch.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductDuplicateJob", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productFeed", "description": "Returns a ProductFeed resource by ID.", "args": [ { "name": "id", "description": "The ID of the ProductFeed to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductFeed", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productFeeds", "description": "The product feeds for the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductFeedConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productOperation", "description": "Returns a ProductOperation resource by ID.\n\nThis can be used to query the\n[ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), using\nthe ID that was returned\n[when the product was created or updated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously)\nby the\n[ProductSet](https://shopify.dev/api/admin-graphql/current/mutations/productSet) mutation.\n\nThe `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`.\n\nThe `product` field provides the details of the created or updated product.\n\nFor the\n[ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), the\n`userErrors` field provides mutation errors that occurred during the operation.\n", "args": [ { "name": "id", "description": "The ID of the ProductOperation to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "INTERFACE", "name": "ProductOperation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productResourceFeedback", "description": "Returns the product resource feedback for the currently authenticated app.\n", "args": [ { "name": "id", "description": "The product associated with the resource feedback.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductResourceFeedback", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productSavedSearches", "description": "Returns a list of the shop's product saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariant", "description": "Returns a ProductVariant resource by ID.", "args": [ { "name": "id", "description": "The ID of the ProductVariant to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ProductVariant", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "List of the product variants.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductVariantSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| collection |\n| delivery_profile_id |\n| exclude_composite |\n| exclude_variants_with_components |\n| gift_card |\n| inventory_quantity |\n| location_id |\n| managed |\n| managed_by |\n| option1 |\n| option2 |\n| option3 |\n| product_id |\n| product_ids |\n| product_publication_status |\n| product_status |\n| product_type |\n| publishable_status |\n| published_status |\n| requires_components |\n| sku |\n| tag |\n| tag_not |\n| taxable |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "List of products.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| bundles |\n| created_at |\n| delivery_profile_id |\n| error_feedback |\n| gift_card |\n| has_only_composites |\n| has_only_default_variant |\n| has_variant_with_components |\n| id |\n| inventory_total |\n| is_price_reduced |\n| out_of_stock_somewhere |\n| price |\n| product_configuration_owner |\n| product_publication_status |\n| product_type |\n| publishable_status |\n| published_status |\n| sku |\n| status |\n| tag |\n| tag_not |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsCount", "description": "Count of products. Limited to a maximum of 10000.", "args": [ { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| bundles |\n| created_at |\n| delivery_profile_id |\n| error_feedback |\n| gift_card |\n| has_only_composites |\n| has_only_default_variant |\n| has_variant_with_components |\n| id |\n| inventory_total |\n| is_price_reduced |\n| out_of_stock_somewhere |\n| price |\n| product_configuration_owner |\n| product_publication_status |\n| product_type |\n| publishable_status |\n| published_status |\n| sku |\n| status |\n| tag |\n| tag_not |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "limit", "description": "The upper bound on count value before returning a result.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicApiVersions", "description": "The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ApiVersion", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "Lookup a publication by ID.\n", "args": [ { "name": "id", "description": "The ID of the Publication to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Publication", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publications", "description": "List of publications.", "args": [ { "name": "catalogType", "description": "Filter publications by catalog type.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PublicationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicationsCount", "description": "Count of publications.", "args": [ { "name": "catalogType", "description": "Filter publications by catalog type.", "type": { "kind": "ENUM", "name": "CatalogType", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refund", "description": "Returns a Refund resource by ID.", "args": [ { "name": "id", "description": "The ID of the Refund to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Refund", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "return", "description": "Returns a Return resource by ID.", "args": [ { "name": "id", "description": "The ID of the Return to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnableFulfillment", "description": "Lookup a returnable fulfillment by ID.", "args": [ { "name": "id", "description": "The ID of the ReturnableFulfillment to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReturnableFulfillment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnableFulfillments", "description": "List of returnable fulfillments.", "args": [ { "name": "orderId", "description": "Order ID that will scope all returnable fulfillments.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseDelivery", "description": "Lookup a reverse delivery by ID.", "args": [ { "name": "id", "description": "The ID of the ReverseDelivery to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseFulfillmentOrder", "description": "Lookup a reverse fulfillment order by ID.", "args": [ { "name": "id", "description": "The ID of the reverse fulfillment order to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scriptTag", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nLookup a script tag resource by ID.\n", "args": [ { "name": "id", "description": "The ID of the ScriptTag to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ScriptTag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "scriptTags", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nA list of script tags.\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "src", "description": "The source URL of the script tag to filter by.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ScriptTagConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segment", "description": "The Customer Segment.", "args": [ { "name": "id", "description": "Find a segment by ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Segment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentFilterSuggestions", "description": "A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.", "args": [ { "name": "search", "description": "Returns the elements of a list by keyword or term.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentFilterConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentFilters", "description": "A list of filters.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentFilterConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentMigrations", "description": "A list of a shop's segment migrations.", "args": [ { "name": "savedSearchId", "description": "Search a segment migration by its saved search ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMigrationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentValueSuggestions", "description": "The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.", "args": [ { "name": "search", "description": "Returns the elements of a list by keyword or term.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "filterQueryName", "description": "Returns the elements of a list by filter handle.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "functionParameterQueryName", "description": "Returns the elements of a list by filter parameter name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentValueConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segments", "description": "A list of a shop's segments.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SegmentSortKeys", "ofType": null }, "defaultValue": "CREATION_DATE" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| name |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentsCount", "description": "The number of segments for a shop.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroup", "description": "Returns a Selling Plan Group resource by ID.", "args": [ { "name": "id", "description": "The ID of the SellingPlanGroup to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroups", "description": "List Selling Plan Groups.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SellingPlanGroupSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id | | - `CURRENT`
- `ALL`
- `App ID number` | `CURRENT` | |\n| category | | - `SUBSCRIPTION`
- `PRE_ORDER`
- `TRY_BEFORE_YOU_BUY`
- `OTHER` | | |\n| created_at |\n| delivery_frequency |\n| name |\n| percentage_off |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "serverPixel", "description": "The server pixel configured by the app.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains\nbusiness and store management settings for the shop.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopBillingPreferences", "description": "The shop's billing preferences.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopBillingPreferences", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopLocales", "description": "A list of locales available on a shop.", "args": [ { "name": "published", "description": "Return only published locales.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopLocale", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyFunction", "description": "The Shopify Function.", "args": [ { "name": "id", "description": "The ID of the Shopify Function.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyFunctions", "description": "Returns the Shopify Functions for apps installed on the shop.", "args": [ { "name": "apiType", "description": "Filter the functions by the API type.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "useCreationUi", "description": "Filter the functions by whether or not the function uses the creation UI in the Admin.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunctionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyPaymentsAccount", "description": "Shopify Payments account information, including balances and payouts.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsAccount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyqlQuery", "description": "Returns the results of a ShopifyQL query. Refer to the [ShopifyQL documentation](https://shopify.dev/api/shopifyql) for more information.", "args": [ { "name": "query", "description": "A ShopifyQL query.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "INTERFACE", "name": "ShopifyqlResponse", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The StaffMember resource, by ID.", "args": [ { "name": "id", "description": "The ID of the staff member to return. If no ID is provided, then the staff member making the query (if any) is returned.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardMetafieldDefinitionTemplates", "description": "Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved.\n\nRefer to all available [`Standard Metafield Definition Templates`](https://shopify.dev/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate).\n", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplateConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingAttempt", "description": "Returns a SubscriptionBillingAttempt by ID.", "args": [ { "name": "id", "description": "The ID of the SubscriptionBillingAttempt to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingAttempts", "description": "Returns subscription billing attempts on a store.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SubscriptionBillingAttemptsSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| error_code |\n| error_message |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttemptConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycle", "description": "Returns a subscription billing cycle found either by cycle index or date.", "args": [ { "name": "billingCycleInput", "description": "Input object used to select and use billing cycles.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionBillingCycles", "description": "Returns subscription billing cycles for a contract ID.", "args": [ { "name": "contractId", "description": "The ID of the subscription contract to retrieve billing cycles for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "billingCyclesDateRangeSelector", "description": "Select subscription billing cycles within a date range.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCyclesDateRangeSelector", "ofType": null }, "defaultValue": null }, { "name": "billingCyclesIndexRangeSelector", "description": "Select subscription billing cycles within an index range.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCyclesIndexRangeSelector", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SubscriptionBillingCyclesSortKeys", "ofType": null }, "defaultValue": "CYCLE_INDEX" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContract", "description": "Returns a Subscription Contract resource by ID.", "args": [ { "name": "id", "description": "The ID of the Subscription Contract to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContracts", "description": "List Subscription Contracts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| status |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionDraft", "description": "Returns a Subscription Draft resource by ID.", "args": [ { "name": "id", "description": "The ID of the Subscription Draft to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxonomy", "description": "The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.", "args": [], "type": { "kind": "OBJECT", "name": "Taxonomy", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tenderTransactions", "description": "Returns a list of TenderTransactions associated with the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| point_of_sale_device_id |\n| processed_at |\n| test |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TenderTransactionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatableResource", "description": "A resource that can have localized values for different languages.", "args": [ { "name": "resourceId", "description": "Find a translatable resource by ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "TranslatableResource", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatableResources", "description": "Resources that can have localized values for different languages.", "args": [ { "name": "resourceType", "description": "Return only resources of a type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TranslatableResourceType", "ofType": null } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableResourceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatableResourcesByIds", "description": "Resources that can have localized values for different languages.", "args": [ { "name": "resourceIds", "description": "Return only resources for given IDs.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableResourceConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirect", "description": "Returns a redirect resource by ID.", "args": [ { "name": "id", "description": "The ID of the UrlRedirect to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectImport", "description": "Returns a redirect import resource by ID.", "args": [ { "name": "id", "description": "The ID of the UrlRedirectImport to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UrlRedirectImport", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirectSavedSearches", "description": "A list of the shop's URL redirect saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlRedirects", "description": "A list of redirects for a shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "UrlRedirectSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| path |\n| target |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validation", "description": "Validation available on the shop.", "args": [ { "name": "id", "description": "The ID of the validation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Validation", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "validations", "description": "Validations available on the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ValidationSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ValidationConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixel", "description": "The web pixel configured by the app.", "args": [ { "name": "id", "description": "Returns a web pixel by ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "Returns a webhook subscription by ID.", "args": [ { "name": "id", "description": "The ID of the WebhookSubscription to return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscriptions", "description": "Returns a list of webhook subscriptions.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "WebhookSubscriptionSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "callbackUrl", "description": "Callback URL to filter by.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "format", "description": "Response format to filter by.", "type": { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "ofType": null }, "defaultValue": null }, { "name": "topics", "description": "List of webhook subscription topics to filter by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "WebhookSubscriptionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Refund", "description": "The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items.", "fields": [ { "name": "createdAt", "description": "The date and time when the refund was created.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "duties", "description": "A list of the refunded duties as part of this refund.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundDuty", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The optional note associated with the refund.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the refund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundLineItems", "description": "The `RefundLineItem` resources attached to the refund.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundShippingLines", "description": "The `RefundShippingLine` resources attached to the refund.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundShippingLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "return", "description": "The return associated with the refund.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMember", "description": "The staff member who created the refund.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalRefunded", "description": "The total amount across all transactions for the refund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalRefundedSet` instead." }, { "name": "totalRefundedSet", "description": "The total amount across all transactions for the refund, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactions", "description": "The transactions associated with the refund.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderTransactionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the refund was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundAgreement", "description": "An agreement between the merchant and customer to refund all or a portion of the order.", "fields": [ { "name": "app", "description": "The application that created the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The date and time at which the agreement occured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the agremeent was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refund", "description": "The refund associated with the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Refund", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The sales associated with the agreement.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member associated with the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundConnection", "description": "An auto-generated type for paginating through multiple Refunds.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in RefundEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Refund", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundCreatePayload", "description": "Return type for `refundCreate` mutation.", "fields": [ { "name": "order", "description": "The order associated with the created refund.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refund", "description": "The created refund.", "args": [], "type": { "kind": "OBJECT", "name": "Refund", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundDuty", "description": "Represents a refunded duty.", "fields": [ { "name": "amountSet", "description": "The amount of a refunded duty in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalDuty", "description": "The duty associated with this refunded duty.", "args": [], "type": { "kind": "OBJECT", "name": "Duty", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RefundDutyInput", "description": "The input fields required to reimburse duties on a refund.", "fields": null, "inputFields": [ { "name": "dutyId", "description": "The ID of the duty in the refund.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "refundType", "description": "The type of refund for this duty.", "type": { "kind": "ENUM", "name": "RefundDutyRefundType", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "RefundDutyRefundType", "description": "The type of refund to perform for a particular refund duty.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PROPORTIONAL", "description": "The duty is proportionally refunded based on the quantity of the refunded line item.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULL", "description": "The duty is fully refunded.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundEdge", "description": "An auto-generated type which holds one Refund and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of RefundEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Refund", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RefundInput", "description": "The input fields to create a refund.", "fields": null, "inputFields": [ { "name": "currency", "description": "The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ.", "type": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null }, "defaultValue": null }, { "name": "orderId", "description": "The ID of the order that's being refunded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "note", "description": "An optional note that's attached to the refund.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "notify", "description": "Whether to send a refund notification to the customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "shipping", "description": "The input fields that are required to reimburse shipping costs.", "type": { "kind": "INPUT_OBJECT", "name": "ShippingRefundInput", "ofType": null }, "defaultValue": null }, { "name": "refundLineItems", "description": "A list of line items to refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundLineItemInput", "ofType": null } } }, "defaultValue": null }, { "name": "refundDuties", "description": "A list of duties to refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundDutyInput", "ofType": null } } }, "defaultValue": null }, { "name": "transactions", "description": "A list of transactions involved in the refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "OrderTransactionInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundLineItem", "description": "A line item that's included in a refund.", "fields": [ { "name": "lineItem", "description": "The `LineItem` resource associated to the refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The inventory restock location.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of a refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `priceSet` instead." }, { "name": "priceSet", "description": "The price of a refunded line item in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of a refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockType", "description": "The type of restock for the refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RefundLineItemRestockType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restocked", "description": "Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The subtotal price of a refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `subtotalSet` instead." }, { "name": "subtotalSet", "description": "The subtotal price of a refunded line item in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTax", "description": "The total tax charged on a refunded line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalTaxSet` instead." }, { "name": "totalTaxSet", "description": "The total tax charged on a refunded line item in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundLineItemConnection", "description": "An auto-generated type for paginating through multiple RefundLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in RefundLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundLineItemEdge", "description": "An auto-generated type which holds one RefundLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of RefundLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RefundLineItemInput", "description": "The input fields required to reimburse line items on a refund.", "fields": null, "inputFields": [ { "name": "lineItemId", "description": "The ID of the line item in the refund.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the associated line item to be refunded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "restockType", "description": "The type of restock for this line item.", "type": { "kind": "ENUM", "name": "RefundLineItemRestockType", "ofType": null }, "defaultValue": null }, { "name": "locationId", "description": "The intended location for restocking. If the `restockType` is set to `NO_RESTOCK`, then this value is empty.`", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "RefundLineItemRestockType", "description": "The type of restock performed for a particular refund line item.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RETURN", "description": "The refund line item was returned. Use this when restocking line items that were fulfilled.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCEL", "description": "The refund line item was canceled. Use this when restocking unfulfilled line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "LEGACY_RESTOCK", "description": "Deprecated. The refund line item was restocked, without specifically beingidentified as a return or cancelation. This value is not accepted when creating new refunds.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_RESTOCK", "description": "Refund line item was not restocked.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RefundShippingInput", "description": "The input fields for the shipping cost to refund.", "fields": null, "inputFields": [ { "name": "shippingRefundAmount", "description": "The input fields required to refund shipping cost, in the presentment currency of the order.\nThis overrides the `fullRefund` argument.\n", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "fullRefund", "description": "Whether to refund the full shipping amount.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundShippingLine", "description": "A shipping line item that's included in a refund.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLine", "description": "The `ShippingLine` resource associated to the refunded shipping line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundShippingLineConnection", "description": "An auto-generated type for paginating through multiple RefundShippingLines.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundShippingLineEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in RefundShippingLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundShippingLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RefundShippingLineEdge", "description": "An auto-generated type which holds one RefundShippingLine and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of RefundShippingLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundShippingLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoteAuthorizeNetCustomerPaymentProfileInput", "description": "The input fields for a remote Authorize.net customer payment profile.\n", "fields": null, "inputFields": [ { "name": "customerProfileId", "description": "The customerProfileId value from the Authorize.net API.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "customerPaymentProfileId", "description": "The customerPaymentProfileId value from the Authorize.net API.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoteBraintreePaymentMethodInput", "description": "The input fields for a remote Braintree customer payment profile.\n", "fields": null, "inputFields": [ { "name": "customerId", "description": "The `customer_id` value from the Braintree API.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "paymentMethodToken", "description": "The `payment_method_token` value from the Braintree API.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoteStripePaymentMethodInput", "description": "The input fields for a remote stripe payment method.\n", "fields": null, "inputFields": [ { "name": "customerId", "description": "The customer_id value from the Stripe API.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "paymentMethodId", "description": "The payment_method_id value from the Stripe API.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourceAlert", "description": "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.\nThey can optionally have a specific icon and be dismissed by merchants.\n", "fields": [ { "name": "actions", "description": "Buttons in the alert that link to related information.\nFor example, _Edit variants_.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourceAlertAction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "content", "description": "The secondary text in the alert that includes further information or instructions about how to solve a problem.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "HTML", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "dismissibleHandle", "description": "Unique identifier that appears when an alert is manually closed by the merchant.\nMost alerts can't be manually closed.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "icon", "description": "An icon that's optionally displayed with the alert.", "args": [], "type": { "kind": "ENUM", "name": "ResourceAlertIcon", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "severity", "description": "Indication of how important the alert is.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceAlertSeverity", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The primary text in the alert that includes information or describes the problem.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourceAlertAction", "description": "An action associated to a resource alert, such as editing variants.", "fields": [ { "name": "primary", "description": "Whether the action appears as a button or as a link.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "show", "description": "Resource for the action to show.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The text for the button in the alert. For example, _Edit variants_.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The target URL that the button links to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ResourceAlertIcon", "description": "The available icons for resource alerts.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CHECKMARK_CIRCLE", "description": "A checkmark inside a circle.", "isDeprecated": false, "deprecationReason": null }, { "name": "INFORMATION_CIRCLE", "description": "A lowercase `i` inside a circle.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ResourceAlertSeverity", "description": "The possible severity levels for a resource alert.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "Indicates a neutral alert. For example, an accepted dispute.", "isDeprecated": false, "deprecationReason": null }, { "name": "INFO", "description": "Indicates an informative alert. For example, an escalated dispute.", "isDeprecated": false, "deprecationReason": null }, { "name": "WARNING", "description": "Indicates an informative alert. For example, a new dispute.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUCCESS", "description": "Indicates a success alert. For example, a winning a dispute.", "isDeprecated": false, "deprecationReason": null }, { "name": "CRITICAL", "description": "Indicates a critical alert. For example, a blocked app.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERROR", "description": null, "isDeprecated": true, "deprecationReason": "`ERROR` severity is being deprecated in favour of `WARNING` or `CRITICAL` instead." } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourceFeedback", "description": "Represents feedback from apps about a resource, and the steps required to set up the apps on the shop.\n", "fields": [ { "name": "appFeedback", "description": "Feedback from an app about the steps a merchant needs to take to set up the app on their store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppFeedback", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `details` instead." }, { "name": "details", "description": "List of AppFeedback detailing issues regarding a resource.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppFeedback", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "Summary of resource feedback pertaining to the resource.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ResourceFeedbackCreateInput", "description": "The input fields for a resource feedback object.", "fields": null, "inputFields": [ { "name": "feedbackGeneratedAt", "description": "The date and time when the feedback was generated. Used to help determine whether\nincoming feedback is outdated compared to existing feedback.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "messages", "description": "If the feedback state is `requires_action`, then you can send a string message that communicates the action to be taken by the merchant.\nThe string must be a single message up to 100 characters long and must end with a period.\nYou need to adhere to the message formatting rules or your requests will fail:\n- `[Explanation of the problem]. [Suggested action].`\n\n**Examples:**\n- `[Your app name]` isn't connected. Connect your account to use this sales channel. `[Learn more]`\n- `[Your app name]` isn't configured. Agree to the terms and conditions to use this app. `[Learn more]`\nBoth `Your app name` and `Learn more` (a button which directs merchants to your app) are automatically populated in the Shopify admin.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "state", "description": "The state of the feedback and whether it requires merchant action.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceFeedbackState", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ResourceFeedbackState", "description": "The state of the resource feedback.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACCEPTED", "description": "No action required from merchant.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUIRES_ACTION", "description": "The merchant needs to resolve an issue with the resource.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "ResourceOperation", "description": "Represents a merchandising background operation interface.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "processedRowCount", "description": "The count of processed rows, summing imported, failed, and skipped rows.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rowCount", "description": "Represents a rows objects within this background operation.", "args": [], "type": { "kind": "OBJECT", "name": "RowCount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of this operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ResourceOperationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AddAllProductsOperation", "ofType": null }, { "kind": "OBJECT", "name": "CatalogCsvOperation", "ofType": null }, { "kind": "OBJECT", "name": "PublicationResourceOperation", "ofType": null } ] }, { "kind": "ENUM", "name": "ResourceOperationStatus", "description": "Represents the state of this catalog operation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED", "description": "Operation has been created.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE", "description": "Operation is currently running.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPLETE", "description": "Operation is complete.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublication", "description": "A resource publication represents information about the publication of a resource.\nAn instance of `ResourcePublication`, unlike `ResourcePublicationV2`, can be neither published or scheduled to be published.\n\nSee [ResourcePublicationV2](/api/admin-graphql/latest/objects/ResourcePublicationV2) for more context.\n", "fields": [ { "name": "channel", "description": "The channel the resource publication is published to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Channel", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `publication` instead." }, { "name": "isPublished", "description": "Whether the resource publication is published. Also returns true if the resource publication is scheduled to be published.\nIf false, then the resource publication is neither published nor scheduled to be published.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "The publication the resource publication is published to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Publication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishDate", "description": "The date that the resource publication was or is going to be published to the publication.\nIf the product isn't published, then this field returns an epoch timestamp.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishable", "description": "The resource published to the publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Publishable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublicationConnection", "description": "An auto-generated type for paginating through multiple ResourcePublications.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ResourcePublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublication", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublicationEdge", "description": "An auto-generated type which holds one ResourcePublication and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ResourcePublicationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublicationV2", "description": "A resource publication represents information about the publication of a resource.\nUnlike `ResourcePublication`, an instance of `ResourcePublicationV2` can't be unpublished. It must either be published or scheduled to be published.\n\nSee [ResourcePublication](/api/admin-graphql/latest/objects/ResourcePublication) for more context.\n", "fields": [ { "name": "isPublished", "description": "Whether the resource publication is published. If true, then the resource publication is published to the publication.\nIf false, then the resource publication is staged to be published to the publication.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publication", "description": "The publication the resource publication is published to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Publication", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishDate", "description": "The date that the resource publication was or is going to be published to the publication.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "publishable", "description": "The resource published to the publication.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Publishable", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublicationV2Connection", "description": "An auto-generated type for paginating through multiple ResourcePublicationV2s.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2Edge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ResourcePublicationV2Edge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ResourcePublicationV2Edge", "description": "An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ResourcePublicationV2Edge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ResourcePublicationV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RestockingFee", "description": "A restocking fee is a fee captured as part of a return to cover the costs of handling a return line item.\nTypically, this would cover the costs of inspecting, repackaging, and restocking the item.\n", "fields": [ { "name": "amountSet", "description": "The amount of the restocking fee, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the Fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "percentage", "description": "The value of the fee as a percentage.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Fee", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Return", "description": "Represents a return.", "fields": [ { "name": "decline", "description": "Additional information about the declined return.", "args": [], "type": { "kind": "OBJECT", "name": "ReturnDecline", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "exchangeLineItems", "description": "The exchange line items attached to the return.", "args": [ { "name": "includeRemovedItems", "description": "Include exchange line items that have been removed from the order by an order edit, return, etc. Items that have been removed have a zero ([LineItem.currentQuantity](https://shopify.dev/docs/api/admin-graphql/unstable/objects/LineItem#field-lineitem-currentquantity)).", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the return.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order that the return belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refunds", "description": "The list of refunds associated with the return.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnLineItems", "description": "The return line items attached to the return.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnShippingFees", "description": "The return shipping fees for the return.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnShippingFee", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseFulfillmentOrders", "description": "The list of reverse fulfillment orders for the return.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the return.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suggestedRefund", "description": "A suggested refund for the return.", "args": [ { "name": "returnRefundLineItems", "description": "The line items from the return to include in the refund.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRefundLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "refundShipping", "description": "The shipping amount from the associated order to include in the refund.", "type": { "kind": "INPUT_OBJECT", "name": "RefundShippingInput", "ofType": null }, "defaultValue": null }, { "name": "refundDuties", "description": "The duties from to associated order to include in the refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundDutyInput", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SuggestedReturnRefund", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalQuantity", "description": "The sum of all return line item quantities for the return.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnAgreement", "description": "An agreement between the merchant and customer for a return.", "fields": [ { "name": "app", "description": "The application that created the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The date and time at which the agreement occured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the agremeent was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "return", "description": "The return associated with the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Return", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The sales associated with the agreement.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member associated with the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnApproveRequestInput", "description": "The input fields for approving a customer's return request.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the return that's being approved.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnApproveRequestPayload", "description": "Return type for `returnApproveRequest` mutation.", "fields": [ { "name": "return", "description": "The approved return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnCancelPayload", "description": "Return type for `returnCancel` mutation.", "fields": [ { "name": "return", "description": "The canceled return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnClosePayload", "description": "Return type for `returnClose` mutation.", "fields": [ { "name": "return", "description": "The closed return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnConnection", "description": "An auto-generated type for paginating through multiple Returns.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReturnEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Return", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnCreatePayload", "description": "Return type for `returnCreate` mutation.", "fields": [ { "name": "return", "description": "The created return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnDecline", "description": "Additional information about why a merchant declined the customer's return request.", "fields": [ { "name": "note", "description": "The notification message sent to the customer about their declined return request.\nMaximum length: 500 characters.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the customer's return request was declined.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnDeclineReason", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnDeclineReason", "description": "The reason why the merchant declined a customer's return request.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RETURN_PERIOD_ENDED", "description": "The return period has ended.", "isDeprecated": false, "deprecationReason": null }, { "name": "FINAL_SALE", "description": "The return contains final sale items.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The return is declined for another reason.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnDeclineRequestInput", "description": "The input fields for declining a customer's return request.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the return that's being declined.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "declineReason", "description": "The reason why the merchant declined the customer's return request.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnDeclineReason", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnDeclineRequestPayload", "description": "Return type for `returnDeclineRequest` mutation.", "fields": [ { "name": "return", "description": "The declined return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnEdge", "description": "An auto-generated type which holds one Return and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReturnEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Return", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnErrorCode", "description": "Possible error codes that can be returned by `ReturnUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INTERNAL_ERROR", "description": "Unexpected internal error happened.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_ARGUMENTS", "description": "Too many arguments provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "EQUAL_TO", "description": "The input value should be equal to the value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The input value should be greater than or equal to the minimum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The input value should be less than the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_A_NUMBER", "description": "The input value is not a number.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_BIG", "description": "The input value is too big.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "WRONG_LENGTH", "description": "The input value is the wrong length.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALREADY_EXISTS", "description": "The requested resource already exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATION_FAILED", "description": "A requested resource could not be created.", "isDeprecated": false, "deprecationReason": null }, { "name": "FEATURE_NOT_ENABLED", "description": "A required feature is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_STATE", "description": "A resource was not in the correct state for the operation to succeed.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOTIFICATION_FAILED", "description": "A requested notification could not be sent.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_EDITABLE", "description": "A requested item is not editable.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "A requested item could not be found.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnInput", "description": "The input fields for a return.", "fields": null, "inputFields": [ { "name": "orderId", "description": "The ID of the order to be returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "returnLineItems", "description": "The return line items list to be handled.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "notifyCustomer", "description": "When `true` the customer will receive a notification if there's an `Order.email` present.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "requestedAt", "description": "The UTC date and time when the return was first solicited by the customer.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnLineItem", "description": "A return line item.", "fields": [ { "name": "customerNote", "description": "A note from the customer that describes the item to be returned. Maximum length: 300 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentLineItem", "description": "The fulfillment line item from which items are returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity being returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundableQuantity", "description": "The quantity that can be refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundedQuantity", "description": "The quantity that was refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "restockingFee", "description": "The restocking fee for the return line item.", "args": [], "type": { "kind": "OBJECT", "name": "RestockingFee", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnReason", "description": "The reason for returning the item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnReason", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnReasonNote", "description": "Additional information about the reason for the return. Maximum length: 255 characters.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalWeight", "description": "The total weight of the item.", "args": [], "type": { "kind": "OBJECT", "name": "Weight", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "withCodeDiscountedTotalPriceSet", "description": "The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnLineItemConnection", "description": "An auto-generated type for paginating through multiple ReturnLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReturnLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnLineItemEdge", "description": "An auto-generated type which holds one ReturnLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReturnLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnLineItemInput", "description": "The input fields for a return line item.", "fields": null, "inputFields": [ { "name": "fulfillmentLineItemId", "description": "The ID of the fulfillment line item to be returned.\nSpecifically, this field expects a `FulfillmentLineItem.id`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the item to be returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "returnReason", "description": "The reason for the item to be returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnReason", "ofType": null } }, "defaultValue": null }, { "name": "returnReasonNote", "description": "A note about the reason that the item is being returned.\nMaximum length: 255 characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"\"" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnReason", "description": "The reason for returning the return line item.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SIZE_TOO_SMALL", "description": "The item is returned because the size was too small.", "isDeprecated": false, "deprecationReason": null }, { "name": "SIZE_TOO_LARGE", "description": "The item is returned because the size was too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNWANTED", "description": "The item is returned because the customer changed their mind.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_AS_DESCRIBED", "description": "The item is returned because it was not as described.", "isDeprecated": false, "deprecationReason": null }, { "name": "WRONG_ITEM", "description": "The item is returned because the customer received the wrong one.", "isDeprecated": false, "deprecationReason": null }, { "name": "DEFECTIVE", "description": "The item is returned because it is damaged or defective.", "isDeprecated": false, "deprecationReason": null }, { "name": "STYLE", "description": "The item is returned because the buyer did not like the style.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLOR", "description": "The item is returned because the buyer did not like the color.", "isDeprecated": false, "deprecationReason": null }, { "name": "OTHER", "description": "The item is returned for another reason. For this value, a return reason note is also provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "The item is returned because of an unknown reason.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnRefundInput", "description": "The input fields to refund a return.", "fields": null, "inputFields": [ { "name": "returnId", "description": "The ID of the return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "returnRefundLineItems", "description": "A list of return line items to refund.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRefundLineItemInput", "ofType": null } } } }, "defaultValue": null }, { "name": "refundShipping", "description": "The shipping amount to refund.", "type": { "kind": "INPUT_OBJECT", "name": "RefundShippingInput", "ofType": null }, "defaultValue": null }, { "name": "refundDuties", "description": "A list of duties to refund.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RefundDutyInput", "ofType": null } } }, "defaultValue": null }, { "name": "orderTransactions", "description": "A list of transactions involved in refunding the return.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRefundOrderTransactionInput", "ofType": null } } }, "defaultValue": "[]" }, { "name": "notifyCustomer", "description": "Whether to send a refund notification to the customer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnRefundLineItemInput", "description": "The input fields for a return refund line item.", "fields": null, "inputFields": [ { "name": "returnLineItemId", "description": "The ID of the return line item to be refunded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the return line item to be refunded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnRefundOrderTransactionInput", "description": "The input fields to create order transactions when refunding a return.", "fields": null, "inputFields": [ { "name": "transactionAmount", "description": "The amount of money for the transaction in the presentment currency of the order.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null } }, "defaultValue": null }, { "name": "parentId", "description": "The ID of the parent order transaction. The transaction must be of kind `CAPTURE` or a `SALE`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnRefundPayload", "description": "Return type for `returnRefund` mutation.", "fields": [ { "name": "refund", "description": "The created refund.", "args": [], "type": { "kind": "OBJECT", "name": "Refund", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnReopenPayload", "description": "Return type for `returnReopen` mutation.", "fields": [ { "name": "return", "description": "The reopened return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnRequestInput", "description": "The input fields for requesting a return.", "fields": null, "inputFields": [ { "name": "orderId", "description": "The ID of the order that's being returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "returnLineItems", "description": "The line items that are being handled in the return.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ReturnRequestLineItemInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReturnRequestLineItemInput", "description": "The input fields for a return line item.", "fields": null, "inputFields": [ { "name": "fulfillmentLineItemId", "description": "The ID of the fulfillment line item to be returned.\nSpecifically, this field expects a `FulfillmentLineItem.id`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the item that's being returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "returnReason", "description": "The reason why the line item is being returned.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnReason", "ofType": null } }, "defaultValue": null }, { "name": "customerNote", "description": "A note from the customer that describes the item to be returned.\nFor example, the note can communicate issues with the item to the merchant.\nMaximum length: 300 characters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnRequestPayload", "description": "Return type for `returnRequest` mutation.", "fields": [ { "name": "return", "description": "The requested return.", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShippingFee", "description": "A return shipping fee is a fee captured as part of a return to cover the costs of shipping the return.\n", "fields": [ { "name": "amountSet", "description": "The amount of the return shipping fee, in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the Fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Fee", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnStatus", "description": "The status of a return.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANCELED", "description": "The return has been canceled.", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSED", "description": "The return has been completed.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPEN", "description": "The return is in progress.", "isDeprecated": false, "deprecationReason": null }, { "name": "REQUESTED", "description": "The return was requested.", "isDeprecated": false, "deprecationReason": null }, { "name": "DECLINED", "description": "The return was declined.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnUserError", "description": "An error that occurs during the execution of a return mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ReturnErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillment", "description": "A returnable fulfillment, which is an order that has been delivered\nand is eligible to be returned to the merchant.\n", "fields": [ { "name": "fulfillment", "description": "The fulfillment that the returnable fulfillment refers to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Fulfillment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID of the Returnable Fulfillment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnableFulfillmentLineItems", "description": "The list of returnable fulfillment line items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillmentConnection", "description": "An auto-generated type for paginating through multiple ReturnableFulfillments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReturnableFulfillmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillmentEdge", "description": "An auto-generated type which holds one ReturnableFulfillment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReturnableFulfillmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItem", "description": "A returnable fulfillment line item.", "fields": [ { "name": "fulfillmentLineItem", "description": "The fulfillment line item that can be returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity available to be returned.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItemConnection", "description": "An auto-generated type for paginating through multiple ReturnableFulfillmentLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReturnableFulfillmentLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItemEdge", "description": "An auto-generated type which holds one ReturnableFulfillmentLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReturnableFulfillmentLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnableFulfillmentLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDelivery", "description": "A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant.\nFor example, a buyer requests a return, and a merchant sends the buyer a shipping label.\nThe reverse delivery contains the context of the items sent back, how they're being sent back\n(for example, a shipping label), and the current state of the delivery (tracking information).\n", "fields": [ { "name": "deliverable", "description": "The deliverable associated with the reverse delivery.", "args": [], "type": { "kind": "UNION", "name": "ReverseDeliveryDeliverable", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the reverse delivery.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseDeliveryLineItems", "description": "The reverse delivery line items attached to the reverse delivery.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseFulfillmentOrder", "description": "The `ReverseFulfillmentOrder` associated with the reverse delivery.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryConnection", "description": "An auto-generated type for paginating through multiple ReverseDeliveries.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReverseDeliveryEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryCreateWithShippingPayload", "description": "Return type for `reverseDeliveryCreateWithShipping` mutation.", "fields": [ { "name": "reverseDelivery", "description": "The created reverse delivery.", "args": [], "type": { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "ReverseDeliveryDeliverable", "description": "The delivery method and artifacts associated with a reverse delivery.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ReverseDeliveryShippingDeliverable", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryDisposeInput", "description": "The input fields to dispose a reverse delivery line item.", "fields": null, "inputFields": [ { "name": "reverseDeliveryLineItemId", "description": "The ID of the reverse delivery line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the reverse delivery line item to dispose.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "dispositionType", "description": "The final arrangement for the reverse delivery line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReverseFulfillmentOrderDispositionType", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the location where the reverse delivery line item is to be disposed. This is required\n when the disposition type is RESTOCKED.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryDisposePayload", "description": "Return type for `reverseDeliveryDispose` mutation.", "fields": [ { "name": "reverseDeliveryLineItems", "description": "The disposed reverse delivery line items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryLineItem", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryEdge", "description": "An auto-generated type which holds one ReverseDelivery and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReverseDeliveryEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryLabelInput", "description": "The input fields for a reverse label.", "fields": null, "inputFields": [ { "name": "fileUrl", "description": "The URL of the label file. If a label file was uploaded to be attached to the delivery, then provide the temporary staged URL.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryLabelV2", "description": "The return label file information for a reverse delivery.", "fields": [ { "name": "createdAt", "description": "The date and time when the reverse delivery label was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "publicFileUrl", "description": "A public link that can be used to download the label image.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the reverse delivery label was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryLineItem", "description": "The details about a reverse delivery line item.", "fields": [ { "name": "dispositions", "description": "The dispositions of the item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The expected number of units.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseFulfillmentOrderLineItem", "description": "The corresponding reverse fulfillment order line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryLineItemConnection", "description": "An auto-generated type for paginating through multiple ReverseDeliveryLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReverseDeliveryLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryLineItemEdge", "description": "An auto-generated type which holds one ReverseDeliveryLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReverseDeliveryLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryLineItemInput", "description": "The input fields for a reverse delivery line item.", "fields": null, "inputFields": [ { "name": "reverseFulfillmentOrderLineItemId", "description": "The ID of the related reverse fulfillment order line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the item to be included in the delivery.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryShippingDeliverable", "description": "A reverse shipping deliverable that may include a label and tracking information.", "fields": [ { "name": "label", "description": "The return label attached to the reverse delivery.", "args": [], "type": { "kind": "OBJECT", "name": "ReverseDeliveryLabelV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tracking", "description": "The information to track the reverse delivery.", "args": [], "type": { "kind": "OBJECT", "name": "ReverseDeliveryTrackingV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryShippingUpdatePayload", "description": "Return type for `reverseDeliveryShippingUpdate` mutation.", "fields": [ { "name": "reverseDelivery", "description": "The updated reverse delivery.", "args": [], "type": { "kind": "OBJECT", "name": "ReverseDelivery", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReverseDeliveryTrackingInput", "description": "The input fields for tracking information about a return delivery.", "fields": null, "inputFields": [ { "name": "number", "description": "The tracking number for the label.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "url", "description": "The tracking URL for the carrier. If the carrier isn't supported by Shopify, then provide the tracking URL of the delivery.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseDeliveryTrackingV2", "description": "Represents the information used to track a reverse delivery.", "fields": [ { "name": "carrierName", "description": "The provider of the tracking information, in a human-readable format for display purposes.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The identifier used by the courier to identify the shipment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL to track a shipment.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "description": "A group of one or more items in a return that will be processed at a fulfillment service.\nThere can be more than one reverse fulfillment order for a return at a given location.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItems", "description": "The list of reverse fulfillment order line items for the reverse fulfillment order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItemConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the reverse fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reverseDeliveries", "description": "The list of reverse deliveries for the reverse fulfillment order.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseDeliveryConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the reverse fulfillment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReverseFulfillmentOrderStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "thirdPartyConfirmation", "description": "The current confirmation for the reverse fulfillment order from a third-party logistics service. \nIf no third-party service is involved, then this value is `nil`.\n", "args": [], "type": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderThirdPartyConfirmation", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderConnection", "description": "An auto-generated type for paginating through multiple ReverseFulfillmentOrders.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReverseFulfillmentOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ReverseFulfillmentOrderDisposeInput", "description": "The input fields to dispose a reverse fulfillment order line item.", "fields": null, "inputFields": [ { "name": "reverseFulfillmentOrderLineItemId", "description": "The ID of the reverse fulfillment order line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the reverse fulfillment order line item to dispose.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the location where the reverse fulfillment order line item is to be disposed.\n This is required when the disposition type is RESTOCKED.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "dispositionType", "description": "The final arrangement for the reverse fulfillment order line item.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReverseFulfillmentOrderDispositionType", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposePayload", "description": "Return type for `reverseFulfillmentOrderDispose` mutation.", "fields": [ { "name": "reverseFulfillmentOrderLineItems", "description": "The disposed reverse fulfillment order line items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposition", "description": "The details of the arrangement of an item.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location where the disposition occurred.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of disposed units.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The final arrangement of an item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReverseFulfillmentOrderDispositionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReverseFulfillmentOrderDispositionType", "description": "The final arrangement of an item from a reverse fulfillment order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RESTOCKED", "description": "An item that was restocked.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROCESSING_REQUIRED", "description": "An item that requires further processing before being restocked or discarded.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_RESTOCKED", "description": "An item that wasn't restocked.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING", "description": "An item that was expected but absent.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderEdge", "description": "An auto-generated type which holds one ReverseFulfillmentOrder and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReverseFulfillmentOrderEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrder", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "description": "The details about a reverse fulfillment order line item.\n", "fields": [ { "name": "dispositions", "description": "The dispositions of the item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderDisposition", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentLineItem", "description": "The corresponding fulfillment line item for a reverse fulfillment order line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalQuantity", "description": "The total number of units to be processed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItemConnection", "description": "An auto-generated type for paginating through multiple ReverseFulfillmentOrderLineItems.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItemEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ReverseFulfillmentOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItemEdge", "description": "An auto-generated type which holds one ReverseFulfillmentOrderLineItem and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ReverseFulfillmentOrderLineItemEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReverseFulfillmentOrderLineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReverseFulfillmentOrderStatus", "description": "The status of a reverse fulfillment order.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CANCELED", "description": "The reverse fulfillment order has been canceled.", "isDeprecated": false, "deprecationReason": null }, { "name": "CLOSED", "description": "The reverse fulfillment order has been completed.", "isDeprecated": false, "deprecationReason": null }, { "name": "OPEN", "description": "The reverse fulfillment order is in progress.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ReverseFulfillmentOrderThirdPartyConfirmation", "description": "The third-party confirmation of a reverse fulfillment order.", "fields": [ { "name": "status", "description": "The status of the reverse fulfillment order third-party confirmation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReverseFulfillmentOrderThirdPartyConfirmationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReverseFulfillmentOrderThirdPartyConfirmationStatus", "description": "The status of a reverse fulfillment order third-party confirmation.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACCEPTED", "description": "The reverse fulfillment order was accepted by the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCEL_ACCEPTED", "description": "The reverse fulfillment order cancelation was accepted by the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCEL_REJECTED", "description": "The reverse fulfillment order cancelation was rejected by the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING_ACCEPTANCE", "description": "The reverse fulfillment order is awaiting acceptance by the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING_CANCELATION", "description": "The reverse fulfillment order is awaiting cancelation by the fulfillment service.", "isDeprecated": false, "deprecationReason": null }, { "name": "REJECTED", "description": "The reverse fulfillment order was rejected by the fulfillment service.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "RiskAssessmentResult", "description": "List of possible values for a RiskAssessment result.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "HIGH", "description": "Indicates a high likelihood that the order is fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "MEDIUM", "description": "Indicates a medium likelihood that the order is fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOW", "description": "Indicates a low likelihood that the order is fraudulent.", "isDeprecated": false, "deprecationReason": null }, { "name": "NONE", "description": "Indicates that the risk assessment will not provide a recommendation for the order.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "Indicates that the risk assessment is still pending.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "RiskFact", "description": "A risk fact belongs to a single risk assessment and serves to provide additional context for an assessment. Risk facts are not necessarily tied to the result of the recommendation.", "fields": [ { "name": "description", "description": "A description of the fact.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sentiment", "description": "Indicates whether the fact is a negative, neutral or positive contributor with regards to risk.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RiskFactSentiment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "RiskFactSentiment", "description": "List of possible values for a RiskFact sentiment.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "POSITIVE", "description": "A positive contributor that lowers the risk.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEUTRAL", "description": "A neutral contributor with regards to risk.", "isDeprecated": false, "deprecationReason": null }, { "name": "NEGATIVE", "description": "A negative contributor that increases the risk.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "RowCount", "description": "A row count represents rows on background operation.", "fields": [ { "name": "count", "description": "Estimated number of rows contained within this background operation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "exceedsMax", "description": "Whether the operation exceeds max number of reportable rows.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SEO", "description": "SEO information.", "fields": [ { "name": "description", "description": "SEO Description.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "SEO Title.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SEOInput", "description": "The input fields for SEO information.", "fields": null, "inputFields": [ { "name": "title", "description": "SEO title of the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "SEO description of the product.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "Sale", "description": "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.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AdditionalFeeSale", "ofType": null }, { "kind": "OBJECT", "name": "AdjustmentSale", "ofType": null }, { "kind": "OBJECT", "name": "DutySale", "ofType": null }, { "kind": "OBJECT", "name": "FeeSale", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardSale", "ofType": null }, { "kind": "OBJECT", "name": "ProductSale", "ofType": null }, { "kind": "OBJECT", "name": "ShippingLineSale", "ofType": null }, { "kind": "OBJECT", "name": "TipSale", "ofType": null }, { "kind": "OBJECT", "name": "UnknownSale", "ofType": null } ] }, { "kind": "ENUM", "name": "SaleActionType", "description": "The possible order action types for a sale.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ORDER", "description": "A purchase or charge.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURN", "description": "A removal or return.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATE", "description": "A change to the price, taxes, or discounts for a prior purchase.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "An unknown order action. Represents new actions that may be added in future versions.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SaleAdditionalFee", "description": "The additional fee details for a line item.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "A list of taxes charged on the additional fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SaleConnection", "description": "An auto-generated type for paginating through multiple Sales.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SaleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Sale", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SaleEdge", "description": "An auto-generated type which holds one Sale and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SaleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Sale", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SaleLineType", "description": "The possible line types for a sale record. One of the possible order line types for a sale is an adjustment. Sales adjustments occur when a refund is issued for a line item that is either more or less than the total value of the line item. Examples are restocking fees and goodwill payments. When this happens, Shopify produces a sales agreement with sale records for each line item that is returned or refunded and an additional sale record for the adjustment (for example, a restocking fee). The sales records for the returned or refunded items represent the reversal of the original line item sale value. The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT", "description": "A product purchased, returned or exchanged.", "isDeprecated": false, "deprecationReason": null }, { "name": "TIP", "description": "A tip added by the customer.", "isDeprecated": false, "deprecationReason": null }, { "name": "GIFT_CARD", "description": "A gift card.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING", "description": "A shipping cost.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUTY", "description": "A duty charge.", "isDeprecated": false, "deprecationReason": null }, { "name": "ADDITIONAL_FEE", "description": "An additional fee.", "isDeprecated": false, "deprecationReason": null }, { "name": "FEE", "description": "A fee charge.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "An unknown sale line. Represents new types that may be added in future versions.", "isDeprecated": false, "deprecationReason": null }, { "name": "ADJUSTMENT", "description": "A sale adjustment.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SaleTax", "description": "The tax allocated to a sale from a single tax line.", "fields": [ { "name": "amount", "description": "The portion of the total tax amount on the related sale that comes from the associated tax line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale tax.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLine", "description": "The tax line associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "SalesAgreement", "description": "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.", "fields": [ { "name": "app", "description": "The application that created the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "happenedAt", "description": "The date and time at which the agreement occured.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the agreement.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason the agremeent was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "OrderActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales", "description": "The sales associated with the agreement.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member associated with the agreement.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "OrderAgreement", "ofType": null }, { "kind": "OBJECT", "name": "OrderEditAgreement", "ofType": null }, { "kind": "OBJECT", "name": "RefundAgreement", "ofType": null }, { "kind": "OBJECT", "name": "ReturnAgreement", "ofType": null } ] }, { "kind": "OBJECT", "name": "SalesAgreementConnection", "description": "An auto-generated type for paginating through multiple SalesAgreements.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesAgreementEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SalesAgreementEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SalesAgreementEdge", "description": "An auto-generated type which holds one SalesAgreement and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SalesAgreementEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "SalesAgreement", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearch", "description": "A saved search is a representation of a search query saved in the admin.", "fields": [ { "name": "filters", "description": "The filters of a saved search.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchFilter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of a saved search.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "query", "description": "The query string of a saved search. This includes search terms and filters.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourceType", "description": "The type of resource this saved search is searching in.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SearchResultType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "searchTerms", "description": "The search terms of a saved search.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearchConnection", "description": "An auto-generated type for paginating through multiple SavedSearches.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SavedSearchEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearch", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SavedSearchCreateInput", "description": "The input fields to create a saved search.", "fields": null, "inputFields": [ { "name": "resourceType", "description": "The type of resource this saved search is searching in.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SearchResultType", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "A descriptive name of the saved search.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "query", "description": "The query string of a saved search. This includes search terms and filters.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearchCreatePayload", "description": "Return type for `savedSearchCreate` mutation.", "fields": [ { "name": "savedSearch", "description": "The saved search that was created.", "args": [], "type": { "kind": "OBJECT", "name": "SavedSearch", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SavedSearchDeleteInput", "description": "The input fields to delete a saved search.", "fields": null, "inputFields": [ { "name": "id", "description": "ID of the saved search to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearchDeletePayload", "description": "Return type for `savedSearchDelete` mutation.", "fields": [ { "name": "deletedSavedSearchId", "description": "The ID of the saved search that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shop", "description": "The shop of the saved search that was deleted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearchEdge", "description": "An auto-generated type which holds one SavedSearch and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SavedSearchEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearch", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SavedSearchUpdateInput", "description": "The input fields to update a saved search.", "fields": null, "inputFields": [ { "name": "id", "description": "ID of the saved search to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "A descriptive name of the saved search.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "query", "description": "The query string of a saved search. This included search terms and filters.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SavedSearchUpdatePayload", "description": "Return type for `savedSearchUpdate` mutation.", "fields": [ { "name": "savedSearch", "description": "The saved search that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "SavedSearch", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ScheduledChangeSortKeys", "description": "The set of valid sort keys for the ScheduledChange query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "EXPECTED_AT", "description": "Sort by the `expected_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptDiscountApplication", "description": "Script discount applications capture the intentions of a discount that\nwas created by a Shopify Script for an order's line item or shipping line.\n\nDiscount 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.\n", "fields": [ { "name": "allocationMethod", "description": "The method by which the discount's value is applied to its entitled items.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationAllocationMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the application as defined by the Script.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `title` instead." }, { "name": "index", "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetSelection", "description": "How the discount amount is distributed on the discounted lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Whether the discount is applied on line items or shipping lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountApplicationTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the application as defined by the Script.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the discount application.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "PricingValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DiscountApplication", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTag", "description": "

Theme app extensions

\n

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.

\n\n

Script tag deprecation

\n

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

\n\n\nA script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the **Order status** page of checkout.\n", "fields": [ { "name": "cache", "description": "Whether the Shopify CDN can cache and serve the script tag.\nIf `true`, then the script will be cached and served by the CDN.\nThe cache expires 15 minutes after the script tag is successfully returned.\nIf `false`, then the script will be served as is.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the script tag was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayScope", "description": "The page or pages on the online store that the script should be included.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ScriptTagDisplayScope", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "src", "description": "The URL to the remote script.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the script tag was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTagConnection", "description": "An auto-generated type for paginating through multiple ScriptTags.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ScriptTagEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ScriptTagEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ScriptTag", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTagCreatePayload", "description": "Return type for `scriptTagCreate` mutation.", "fields": [ { "name": "scriptTag", "description": "The script tag that was created.", "args": [], "type": { "kind": "OBJECT", "name": "ScriptTag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTagDeletePayload", "description": "Return type for `scriptTagDelete` mutation.", "fields": [ { "name": "deletedScriptTagId", "description": "The ID of the deleted script tag.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ScriptTagDisplayScope", "description": "The page or pages on the online store where the script should be included.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALL", "description": "Include the script on both the web storefront and the Order status page.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_STATUS", "description": "Include the script only on the Order status page.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE", "description": "Include the script only on the web storefront.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTagEdge", "description": "An auto-generated type which holds one ScriptTag and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ScriptTagEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ScriptTag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ScriptTagInput", "description": "The input fields for a script tag. This input object is used when creating or updating\na script tag to specify its URL, where it should be included, and how it will be cached.\n", "fields": null, "inputFields": [ { "name": "src", "description": "The URL of the remote script. For example: `https://example.com/path/to/script.js`.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "displayScope", "description": "The page or pages on the online store where the script should be included.", "type": { "kind": "ENUM", "name": "ScriptTagDisplayScope", "ofType": null }, "defaultValue": null }, { "name": "cache", "description": "Whether the Shopify CDN can cache and serve the script tag.\nIf `true`, then the script will be cached and served by the CDN.\nThe cache expires 15 minutes after the script tag is successfully returned.\nIf `false`, then the script is served as is.\nThe default value is `false`.\n", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ScriptTagUpdatePayload", "description": "Return type for `scriptTagUpdate` mutation.", "fields": [ { "name": "scriptTag", "description": "The script tag that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "ScriptTag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchFilter", "description": "A filter in a search query represented by a key value pair.", "fields": [ { "name": "key", "description": "The key of the search filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the search filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchFilterOptions", "description": "A list of search filters along with their specific options in value and label pair for filtering.", "fields": [ { "name": "productAvailability", "description": "A list of options that can be use to filter product availability.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FilterOption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchResult", "description": "Represents an individual result returned from a search.", "fields": [ { "name": "description", "description": "Returns the search result description text.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image", "description": "Returns the Image resource presented to accompany a search result.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reference", "description": "Returns the ID of the resource returned in the search result.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "Node", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Returns the resource title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "Returns the absolute URL to the resource in the search result.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchResultConnection", "description": "The connection type for SearchResult.", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchResultEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resultsAfterCount", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The provided information is not accurate." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchResultEdge", "description": "An auto-generated type which holds one SearchResult and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SearchResultEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchResult", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SearchResultType", "description": "Specifies the type of resources to be returned from a search.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CUSTOMER", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT_ORDER", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "FILE", "description": "A file.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_PAGE", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_BLOG", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_ARTICLE", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "URL_REDIRECT", "description": "A URL redirect.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE_RULE", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNT_REDEEM_CODE", "description": "A code discount redeem code.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "BALANCE_TRANSACTION", "description": "A balance transaction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Segment", "description": "A dynamic collection of customers based on specific criteria.\n", "fields": [ { "name": "creationDate", "description": "The date and time when the segment was added to the store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastEditDate", "description": "The date and time when the segment was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the segment.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "query", "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentAssociationFilter", "description": "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.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentAttributeStatistics", "description": "The statistics of a given attribute.", "fields": [ { "name": "average", "description": "The average of a given attribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sum", "description": "The sum of a given attribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentBooleanFilter", "description": "A filter with a Boolean value that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentConnection", "description": "An auto-generated type for paginating through multiple Segments.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SegmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Segment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentCreatePayload", "description": "Return type for `segmentCreate` mutation.", "fields": [ { "name": "segment", "description": "The newly created segment.", "args": [], "type": { "kind": "OBJECT", "name": "Segment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentDateFilter", "description": "A filter with a date value that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentDeletePayload", "description": "Return type for `segmentDelete` mutation.", "fields": [ { "name": "deletedSegmentId", "description": "ID of the deleted segment.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentEdge", "description": "An auto-generated type which holds one Segment and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SegmentEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Segment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentEnumFilter", "description": "A filter with a set of possible values that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentEventFilter", "description": "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.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "parameters", "description": "The parameters for an event segment filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentEventFilterParameter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returnValueType", "description": "The return value type for an event segment filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentEventFilterParameter", "description": "The parameters for an event segment filter.", "fields": [ { "name": "acceptsMultipleValues", "description": "Whether the parameter accepts a list of values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localizedDescription", "description": "The localized description of the parameter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localizedName", "description": "The localized name of the parameter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "optional", "description": "Whether the parameter is optional.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "parameterType", "description": "The type of the parameter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the parameter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "SegmentFilter", "description": "The filters used in segment queries associated with a shop.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SegmentAssociationFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentBooleanFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentDateFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentEnumFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentEventFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentFloatFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentIntegerFilter", "ofType": null }, { "kind": "OBJECT", "name": "SegmentStringFilter", "ofType": null } ] }, { "kind": "OBJECT", "name": "SegmentFilterConnection", "description": "An auto-generated type for paginating through multiple SegmentFilters.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentFilterEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SegmentFilterEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentFilterEdge", "description": "An auto-generated type which holds one SegmentFilter and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SegmentFilterEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentFloatFilter", "description": "A filter with a double-precision, floating-point value that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentIntegerFilter", "description": "A filter with an integer that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentMembership", "description": "The response type for the `segmentMembership` object.\n", "fields": [ { "name": "isMember", "description": "A Boolean that indicates whether or not the customer in the query is a member of the segment, which is identified using the `segmentId`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentId", "description": "A `segmentId` that's used for testing membership.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentMembershipResponse", "description": "A list of maps that contain `segmentId` IDs and `isMember` Booleans. The maps represent segment memberships.\n", "fields": [ { "name": "memberships", "description": "The membership status for the given list of segments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMembership", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentMigration", "description": "A segment and its corresponding saved search. \nFor example, you can use `SegmentMigration` to retrieve the segment ID that corresponds to a saved search ID.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "savedSearchId", "description": "The ID of the saved search.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "segmentId", "description": "The ID of the segment.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentMigrationConnection", "description": "An auto-generated type for paginating through multiple SegmentMigrations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMigrationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SegmentMigrationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMigration", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentMigrationEdge", "description": "An auto-generated type which holds one SegmentMigration and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SegmentMigrationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentMigration", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SegmentSortKeys", "description": "The set of valid sort keys for the Segment query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATION_DATE", "description": "Sort by the `creation_date` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "LAST_EDIT_DATE", "description": "Sort by the `last_edit_date` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentStatistics", "description": "The statistics of a given segment.", "fields": [ { "name": "attributeStatistics", "description": "The statistics of a given attribute.", "args": [ { "name": "attributeName", "description": "The attribute that statistics are retrieved for.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentAttributeStatistics", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentStringFilter", "description": "A filter with a string that's been added to a segment query.", "fields": [ { "name": "localizedName", "description": "The localized name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiValue", "description": "Whether a file can have multiple values for a single customer.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The query name of the filter.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SegmentFilter", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentUpdatePayload", "description": "Return type for `segmentUpdate` mutation.", "fields": [ { "name": "segment", "description": "The updated segment.", "args": [], "type": { "kind": "OBJECT", "name": "Segment", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentValue", "description": "A list of suggested values associated with an individual segment. A\nsegment is a group of members, such as customers, that meet specific\ncriteria.\n", "fields": [ { "name": "localizedValue", "description": "The localized version of the value's name. This name is displayed to the merchant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryName", "description": "The name of the query associated with the suggestion.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentValueConnection", "description": "An auto-generated type for paginating through multiple SegmentValues.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentValueEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SegmentValueEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SegmentValueEdge", "description": "An auto-generated type which holds one SegmentValue and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SegmentValueEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SegmentValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedOption", "description": "Properties used by customers to select a product variant.\nProducts can have multiple options, like different sizes or colors.\n", "fields": [ { "name": "name", "description": "The product option’s name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "optionValue", "description": "The product option’s value object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductOptionValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The product option’s value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlan", "description": "Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups\nand policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing\nup these records if you need to restore them later.\n\nFor more information on selling plans, refer to\n[*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans).\n", "fields": [ { "name": "billingPolicy", "description": "A selling plan policy which describes the recurring billing details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanBillingPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "category", "description": "The category used to classify the selling plan for reporting purposes.", "args": [], "type": { "kind": "ENUM", "name": "SellingPlanCategory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the selling plan was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPolicy", "description": "A selling plan policy which describes the delivery details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanDeliveryPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Buyer facing string which describes the selling plan commitment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryPolicy", "description": "When to reserve inventory for a selling plan.", "args": [], "type": { "kind": "OBJECT", "name": "SellingPlanInventoryPolicy", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "A customer-facing description of the selling plan.\n\nIf your store supports multiple currencies, then don't include country-specific pricing content, such as \"Buy monthly, get 10$ CAD off\". This field won't be converted to reflect different currencies.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "Relative position of the selling plan for display. A lower position will be displayed before a higher position.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricingPolicies", "description": "Selling plan pricing details.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanPricingPolicy", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanAnchor", "description": "Represents a selling plan policy anchor.", "fields": [ { "name": "cutoffDay", "description": "The cutoff day for the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` is MONTHDAY, then the value must be between 1-31.\n\nIf `type` is YEARDAY, then the value must be `null`.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "day", "description": "The day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` isn't WEEKDAY, then the value must be between 1-31.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "month", "description": "The month of the anchor. If type is different than YEARDAY, then the value must\nbe `null` or between 1-12.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanAnchorType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "description": "The input fields required to create or update a selling plan anchor.", "fields": null, "inputFields": [ { "name": "type", "description": "Represents the anchor type, must be one of WEEKDAY, MONTHDAY, YEARDAY.\n", "type": { "kind": "ENUM", "name": "SellingPlanAnchorType", "ofType": null }, "defaultValue": null }, { "name": "day", "description": "The day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` isn't WEEKDAY, then the value must be between 1-31.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "month", "description": "The month of the anchor. If type is different than YEARDAY, then the value must\nbe `null` or between 1-12.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "cutoffDay", "description": "The cutoff day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` is MONTHDAY, then the value must be between 1-31.\n\nIf `type` is YEARDAY, then the value must be `null`.\n\nThis field should only be set if the cutoff field for the delivery policy is `null`.\n", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanAnchorType", "description": "Represents the anchor type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "WEEKDAY", "description": "Which day of the week, between 1-7.", "isDeprecated": false, "deprecationReason": null }, { "name": "MONTHDAY", "description": "Which day of the month, between 1-31.", "isDeprecated": false, "deprecationReason": null }, { "name": "YEARDAY", "description": "Which days of the month and year, month between 1-12, and day between 1-31.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "SellingPlanBillingPolicy", "description": "Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every\nthree months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing\npolicies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.\nWe recommend backing up these records if you need to restore them later.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SellingPlanFixedBillingPolicy", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringBillingPolicy", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "SellingPlanBillingPolicyInput", "description": "The input fields that are required to create or update a billing policy type.", "fields": null, "inputFields": [ { "name": "fixed", "description": "The fixed billing policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedBillingPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "recurring", "description": "The recurring billing policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringBillingPolicyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanCategory", "description": "The category of the selling plan. For the `OTHER` category,\n you must fill out our [request form](https://docs.google.com/forms/d/e/1FAIpQLSeU18Xmw0Q61V8wdH-dfGafFqIBfRchQKUO8WAF3yJTvgyyZQ/viewform),\n where we'll review your request for a new purchase option.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OTHER", "description": "The selling plan is for anything not in one of the other categories.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRE_ORDER", "description": "The selling plan is for pre-orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION", "description": "The selling plan is for subscriptions.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRY_BEFORE_YOU_BUY", "description": "The selling plan is for try before you buy purchases.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanCheckoutCharge", "description": "The amount charged at checkout when the full amount isn't charged at checkout.", "fields": [ { "name": "type", "description": "The charge type for the checkout charge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanCheckoutChargeType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The charge value for the checkout charge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanCheckoutChargeValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanCheckoutChargeInput", "description": "The input fields that are required to create or update a checkout charge.", "fields": null, "inputFields": [ { "name": "type", "description": "The checkout charge type defined by the policy.", "type": { "kind": "ENUM", "name": "SellingPlanCheckoutChargeType", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "The checkout charge value defined by the policy.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanCheckoutChargeValueInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanCheckoutChargePercentageValue", "description": "The percentage value of the price used for checkout charge.", "fields": [ { "name": "percentage", "description": "The percentage value of the price used for checkout charge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanCheckoutChargeType", "description": "The checkout charge when the full amount isn't charged at checkout.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PERCENTAGE", "description": "The checkout charge is a percentage of the product or variant price.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE", "description": "The checkout charge is a fixed price amount.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "SellingPlanCheckoutChargeValue", "description": "The portion of the price to be charged at checkout.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanCheckoutChargePercentageValue", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "SellingPlanCheckoutChargeValueInput", "description": "The input fields required to create or update an checkout charge value.", "fields": null, "inputFields": [ { "name": "percentage", "description": "The percentage value.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "fixedValue", "description": "The fixed value for an checkout charge.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanConnection", "description": "An auto-generated type for paginating through multiple SellingPlans.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SellingPlanEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlan", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SellingPlanDeliveryPolicy", "description": "Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver\nevery other week). The selling plan delivery policy and associated records (selling plan groups, selling plans,\npricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.\nWe recommend backing up these records if you need to restore them later.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SellingPlanFixedDeliveryPolicy", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringDeliveryPolicy", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "SellingPlanDeliveryPolicyInput", "description": "The input fields that are required to create or update a delivery policy.", "fields": null, "inputFields": [ { "name": "fixed", "description": "The fixed delivery policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedDeliveryPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "recurring", "description": "The recurring delivery policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringDeliveryPolicyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanEdge", "description": "An auto-generated type which holds one SellingPlan and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SellingPlanEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlan", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanFixedBillingPolicy", "description": "The fixed selling plan billing policy defines how much of the price of the product will be billed to customer\nat checkout. If there is an outstanding balance, it determines when it will be paid.\n", "fields": [ { "name": "checkoutCharge", "description": "The checkout charge when the full amount isn't charged at checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanCheckoutCharge", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingBalanceChargeExactTime", "description": "The exact time when to capture the full payment.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingBalanceChargeTimeAfterCheckout", "description": "The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remainingBalanceChargeTrigger", "description": "When to capture payment for amount due.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanRemainingBalanceChargeTrigger", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedBillingPolicyInput", "description": "The input fields required to create or update a fixed billing policy.", "fields": null, "inputFields": [ { "name": "remainingBalanceChargeTrigger", "description": "When to capture the payment for the amount due.", "type": { "kind": "ENUM", "name": "SellingPlanRemainingBalanceChargeTrigger", "ofType": null }, "defaultValue": null }, { "name": "remainingBalanceChargeExactTime", "description": "The date and time to capture the full payment.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "remainingBalanceChargeTimeAfterCheckout", "description": "The period after capturing the payment for the amount due (`remainingBalanceChargeTrigger`), and before capturing the full payment. Expressed as an ISO8601 duration.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "checkoutCharge", "description": "The checkout charge policy for the selling plan.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanCheckoutChargeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanFixedDeliveryPolicy", "description": "Represents a fixed selling plan delivery policy.", "fields": [ { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanAnchor", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cutoff", "description": "A buffer period for orders to be included in next fulfillment anchor.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentExactTime", "description": "The date and time when the fulfillment should trigger.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentTrigger", "description": "What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanFulfillmentTrigger", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "intent", "description": "Whether the delivery policy is merchant or buyer-centric.\nBuyer-centric delivery policies state the time when the buyer will receive the goods.\nMerchant-centric delivery policies state the time when the fulfillment should be started.\nCurrently, only merchant-centric delivery policies are supported.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyIntent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "preAnchorBehavior", "description": "The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedDeliveryPolicyInput", "description": "The input fields required to create or update a fixed delivery policy.", "fields": null, "inputFields": [ { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "ofType": null } } }, "defaultValue": null }, { "name": "fulfillmentTrigger", "description": "What triggers the fulfillment.", "type": { "kind": "ENUM", "name": "SellingPlanFulfillmentTrigger", "ofType": null }, "defaultValue": null }, { "name": "fulfillmentExactTime", "description": "The date and time when the fulfillment should trigger.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "cutoff", "description": "A buffer period for orders to be included in a cycle.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "intent", "description": "Whether the delivery policy is merchant or buyer-centric.", "type": { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyIntent", "ofType": null }, "defaultValue": null }, { "name": "preAnchorBehavior", "description": "The pre-anchor behavior.", "type": { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyIntent", "description": "Possible intentions of a Delivery Policy.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_BEGIN", "description": "A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", "description": "The fulfillment or delivery behavior of the first fulfillment when the orderis placed before the anchor.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ASAP", "description": "Orders placed can be fulfilled / delivered immediately. Orders placed inside a cutoff can be fulfilled / delivered at the next anchor.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "NEXT", "description": "Orders placed can be fulfilled / delivered at the next anchor date.\nOrders placed inside a cutoff will skip the next anchor and can be fulfilled /\ndelivered at the following anchor.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanFixedPricingPolicy", "description": "Represents the pricing policy of a subscription or deferred purchase option selling plan.\nThe selling plan fixed pricing policy works with the billing and delivery policy\nto determine the final price. Discounts are divided among fulfillments.\nFor example, a subscription with a $10 discount and two deliveries will have a $5\ndiscount applied to each delivery.\n", "fields": [ { "name": "adjustmentType", "description": "The price adjustment type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "adjustmentValue", "description": "The price adjustment value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanPricingPolicyAdjustmentValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the fixed selling plan pricing policy was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SellingPlanPricingPolicyBase", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedPricingPolicyInput", "description": "The input fields required to create or update a fixed selling plan pricing policy.", "fields": null, "inputFields": [ { "name": "id", "description": "ID of the pricing policy.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "adjustmentType", "description": "Price adjustment type defined by the policy.", "type": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null }, "defaultValue": null }, { "name": "adjustmentValue", "description": "Price adjustment value defined by the policy.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyValueInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanFulfillmentTrigger", "description": "Describes what triggers fulfillment.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ANCHOR", "description": "Use the anchor values to calculate fulfillment date.", "isDeprecated": false, "deprecationReason": null }, { "name": "ASAP", "description": "As soon as possible.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXACT_TIME", "description": "At an exact time defined by the fulfillment_exact_time field.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNKNOWN", "description": "Unknown. Usually to be determined in the future.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroup", "description": "Represents a selling method (for example, \"Subscribe and save\" or \"Pre-paid\"). Selling plan groups\nand associated records (selling plans and policies) are deleted 48 hours after a merchant\nuninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.\n", "fields": [ { "name": "appId", "description": "The ID for app, exposed in Liquid and product JSON.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesToProduct", "description": "Whether the given product is directly associated to the selling plan group.", "args": [ { "name": "productId", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesToProductVariant", "description": "Whether the given product variant is directly associated to the selling plan group.", "args": [ { "name": "productVariantId", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesToProductVariants", "description": "Whether any of the product variants of the given product are associated to the selling plan group.\n", "args": [ { "name": "productId", "description": "The ID of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the selling plan group was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The merchant-facing description of the selling plan group.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantCode", "description": "The merchant-facing label of the selling plan group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The buyer-facing label of the selling plan group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The relative position of the selling plan group for display.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "Product variants associated to the selling plan group.", "args": [ { "name": "productId", "description": "Filters the product variants by a product ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariantsCount", "description": "A count of product variants associated to the selling plan group.", "args": [ { "name": "productId", "description": "The ID of the product to scope the count to.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "Products associated to the selling plan group.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productsCount", "description": "A count of products associated to the selling plan group.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlans", "description": "Selling plans associated to the selling plan group.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "A summary of the policies associated to the selling plan group.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupAddProductVariantsPayload", "description": "Return type for `sellingPlanGroupAddProductVariants` mutation.", "fields": [ { "name": "sellingPlanGroup", "description": "The updated selling plan group.", "args": [], "type": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupAddProductsPayload", "description": "Return type for `sellingPlanGroupAddProducts` mutation.", "fields": [ { "name": "sellingPlanGroup", "description": "The updated selling plan group.", "args": [], "type": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupConnection", "description": "An auto-generated type for paginating through multiple SellingPlanGroups.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SellingPlanGroupEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupCreatePayload", "description": "Return type for `sellingPlanGroupCreate` mutation.", "fields": [ { "name": "sellingPlanGroup", "description": "The created selling plan group object.", "args": [], "type": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupDeletePayload", "description": "Return type for `sellingPlanGroupDelete` mutation.", "fields": [ { "name": "deletedSellingPlanGroupId", "description": "The ID of the deleted selling plan group object.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupEdge", "description": "An auto-generated type which holds one SellingPlanGroup and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SellingPlanGroupEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanGroupInput", "description": "The input fields required to create or update a selling plan group.", "fields": null, "inputFields": [ { "name": "name", "description": "Buyer facing label of the selling plan group.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "appId", "description": "ID for app, exposed in Liquid and product JSON.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "merchantCode", "description": "Merchant facing label of the selling plan group.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Merchant facing description of the selling plan group.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "sellingPlansToCreate", "description": "List of selling plans to create.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanInput", "ofType": null } } }, "defaultValue": null }, { "name": "sellingPlansToUpdate", "description": "List of selling plans to update.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanInput", "ofType": null } } }, "defaultValue": null }, { "name": "sellingPlansToDelete", "description": "List of selling plans ids to delete.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "options", "description": "The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "position", "description": "Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupRemoveProductVariantsPayload", "description": "Return type for `sellingPlanGroupRemoveProductVariants` mutation.", "fields": [ { "name": "removedProductVariantIds", "description": "The removed product variant ids.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupRemoveProductsPayload", "description": "Return type for `sellingPlanGroupRemoveProducts` mutation.", "fields": [ { "name": "removedProductIds", "description": "The removed product ids.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanGroupResourceInput", "description": "The input fields for resource association with a Selling Plan Group.", "fields": null, "inputFields": [ { "name": "productVariantIds", "description": "The IDs of the Variants to add to the Selling Plan Group.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "productIds", "description": "The IDs of the Products to add to the Selling Plan Group.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanGroupSortKeys", "description": "The set of valid sort keys for the SellingPlanGroup query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NAME", "description": "Sort by the `name` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATED_AT", "description": "Sort by the `updated_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupUpdatePayload", "description": "Return type for `sellingPlanGroupUpdate` mutation.", "fields": [ { "name": "deletedSellingPlanIds", "description": "The IDs of the deleted Subscription Plans.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanGroup", "description": "The updated Selling Plan Group.", "args": [], "type": { "kind": "OBJECT", "name": "SellingPlanGroup", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanGroupUserError", "description": "Represents a selling plan group custom error.\n", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SellingPlanGroupUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanGroupUserErrorCode", "description": "Possible error codes that can be returned by `SellingPlanGroupUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "EQUAL_TO", "description": "The input value should be equal to the value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The input value should be greater than or equal to the minimum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The input value should be less than the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_A_NUMBER", "description": "The input value is not a number.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "The record with the ID used as the input value couldn't be found.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_BIG", "description": "The input value is too big.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "WRONG_LENGTH", "description": "The input value is the wrong length.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_COUNT_UPPER_BOUND", "description": "Exceeded the selling plan limit (31).", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_COUNT_LOWER_BOUND", "description": "Must include at least one selling plan.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES", "description": "Selling plan's billing policy max cycles must be greater than min cycles.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_BILLING_AND_DELIVERY_POLICY_ANCHORS_MUST_BE_EQUAL", "description": "Selling plan's billing and delivery policies anchors must be equal.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_BILLING_CYCLE_MUST_BE_A_MULTIPLE_OF_DELIVERY_CYCLE", "description": "Selling plan's billing cycle must be a multiple of delivery cycle.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_PRICING_POLICIES_MUST_CONTAIN_A_FIXED_PRICING_POLICY", "description": "Selling plan's pricing policies must contain one fixed pricing policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_MISSING_OPTION2_LABEL_ON_PARENT_GROUP", "description": "Cannot define option2 on this selling plan as there's no label on the parent selling plan group.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_MISSING_OPTION3_LABEL_ON_PARENT_GROUP", "description": "Cannot define option3 on this selling plan as there's no label on the parent selling plan group.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_OPTION2_REQUIRED_AS_DEFINED_ON_PARENT_GROUP", "description": "Selling plan's option2 is required because option2 exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_OPTION3_REQUIRED_AS_DEFINED_ON_PARENT_GROUP", "description": "Selling plan's option3 is required because option3 exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_PRICING_POLICIES_LIMIT", "description": "Selling plans can't have more than 2 pricing policies.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_LIST_CONTAINS_INVALID_IDS", "description": "The selling plan list provided contains 1 or more invalid IDs.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", "description": "Product variant does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_DOES_NOT_EXIST", "description": "Product does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "GROUP_DOES_NOT_EXIST", "description": "Selling plan group does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "GROUP_COULD_NOT_BE_DELETED", "description": "Selling plan group could not be deleted.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERROR_ADDING_RESOURCE_TO_GROUP", "description": "Could not add the resource to the selling plan group.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_DELIVERY_POLICY_MISSING", "description": "Missing delivery policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_BILLING_POLICY_MISSING", "description": "Missing billing policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "PLAN_DOES_NOT_EXIST", "description": "Selling plan does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "PLAN_ID_MUST_BE_SPECIFIED_TO_UPDATE", "description": "Selling plan ID must be specified to update.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_NEED_ONE_BILLING_POLICY_TYPE", "description": "Only one billing policy type can be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_NEED_ONE_DELIVERY_POLICY_TYPE", "description": "Only one delivery policy type can be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_NEED_ONE_PRICING_POLICY_TYPE", "description": "Only one pricing policy type can be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_AND_DELIVERY_POLICY_TYPES_MUST_BE_THE_SAME", "description": "Billing and delivery policy types must be the same.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_NEED_ONE_PRICING_POLICY_VALUE", "description": "Only one pricing policy adjustment value type can be defined.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICING_POLICY_ADJUSTMENT_VALUE_AND_TYPE_MUST_MATCH", "description": "Pricing policy's adjustment value and adjustment type must match.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_DUPLICATE_NAME", "description": "Cannot have multiple selling plans with the same name.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_DUPLICATE_OPTIONS", "description": "Cannot have multiple selling plans with the same options.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_FIXED_PRICING_POLICIES_LIMIT", "description": "A fixed selling plan can have at most one pricing policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_EXACT_TIME_REQUIRED", "description": "A fixed billing policy's remaining_balance_charge_exact_time can't be blank when the remaining_balance_charge_trigger is EXACT_TIME.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHECKOUT_CHARGE_VALUE_AND_TYPE_MUST_MATCH", "description": "A fixed billing policy's checkout charge value and type must match.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_NEED_ONE_CHECKOUT_CHARGE_VALUE", "description": "A fixed billing policy's checkout charge can have at most one value.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_EXACT_TIME_NOT_ALLOWED", "description": "A fixed billing policy's remaining_balance_charge_exact_time must not be present when the remaining_balance_charge_trigger isn't EXACT_TIME.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_TIME_AFTER_CHECKOUT_MUST_BE_GREATER_THAN_ZERO", "description": "A fixed billing policy's remaining_balance_charge_time_after_checkout must be present and greater than zero when the remaining_balance_charge_trigger is TIME_AFTER_CHECKOUT.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_TRIGGER_ON_FULL_CHECKOUT", "description": "A fixed billing policy's remaining_balance_charge_trigger must be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is 100.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PARTIAL_PERCENTAGE_CHECKOUT_CHARGE", "description": "A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is less than 100.", "isDeprecated": false, "deprecationReason": null }, { "name": "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PRICE_CHECKOUT_CHARGE", "description": "A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PRICE.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_EXACT_TIME_REQUIRED", "description": "A fixed billing policy's fulfillment_exact_time can't be blank when the fulfillment_trigger is EXACT_TIME.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_EXACT_TIME_NOT_ALLOWED", "description": "A fixed billing policy's fulfillment_exact_time must not be present when the fulfillment_trigger isn't EXACT_TIME.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_ANCHORS_NOT_ALLOWED", "description": "A fixed delivery policy's anchors must not be present when the fulfillment_trigger isn't ANCHOR.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_ANCHORS_REQUIRED", "description": "A fixed delivery policy's anchors must be present when the fulfillment_trigger is ANCHOR.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_ONE_OF_FIXED_OR_RECURRING_BILLING", "description": "A selling plan can't have both fixed and recurring billing policies.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLY_ONE_OF_FIXED_OR_RECURRING_DELIVERY", "description": "A selling plan can't have both fixed and recurring delivery policies.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_POLICY_INTERVAL_TOO_LARGE", "description": "Billing policy's interval is too large.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_POLICY_INTERVAL_TOO_LARGE", "description": "Delivery policy's interval is too large.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanInput", "description": "The input fields to create or update a selling plan.", "fields": null, "inputFields": [ { "name": "id", "description": "ID of the selling plan.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Buyer facing string which describes the selling plan content.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Buyer facing string which describes the selling plan commitment.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "billingPolicy", "description": "Selling plan policy which describes the billing details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanBillingPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "deliveryPolicy", "description": "A selling plan policy which describes the delivery details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanDeliveryPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "inventoryPolicy", "description": "A selling plan policy which describes the inventory details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanInventoryPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "pricingPolicies", "description": "The pricing policies which describe the pricing details. Each selling plan\ncan only contain a maximum of 2 pricing policies.\n", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyInput", "ofType": null } } }, "defaultValue": null }, { "name": "options", "description": "The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "position", "description": "Relative value for display purposes of this plan. A lower position will be displayed before a higher one.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "category", "description": "The category used to classify this selling plan for reporting purposes.", "type": { "kind": "ENUM", "name": "SellingPlanCategory", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanInterval", "description": "Represents valid selling plan interval.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DAY", "description": "Day interval.", "isDeprecated": false, "deprecationReason": null }, { "name": "WEEK", "description": "Week interval.", "isDeprecated": false, "deprecationReason": null }, { "name": "MONTH", "description": "Month interval.", "isDeprecated": false, "deprecationReason": null }, { "name": "YEAR", "description": "Year interval.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanInventoryPolicy", "description": "The selling plan inventory policy.", "fields": [ { "name": "reserve", "description": "When to reserve inventory for the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanReserve", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanInventoryPolicyInput", "description": "The input fields required to create or update an inventory policy.", "fields": null, "inputFields": [ { "name": "reserve", "description": "When to reserve inventory for the order. The value must be ON_FULFILLMENT or ON_SALE.", "type": { "kind": "ENUM", "name": "SellingPlanReserve", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SellingPlanPricingPolicy", "description": "Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set\nfor a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and\nassociated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48\nhours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need\nto restore them later.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SellingPlanFixedPricingPolicy", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringPricingPolicy", "ofType": null } ] }, { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "description": "Represents a selling plan pricing policy adjustment type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PERCENTAGE", "description": "Percentage off adjustment.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIXED_AMOUNT", "description": "Fixed amount off adjustment.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRICE", "description": "Price of the policy.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "SellingPlanPricingPolicyAdjustmentValue", "description": "Represents a selling plan pricing policy adjustment value type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanPricingPolicyPercentageValue", "ofType": null } ] }, { "kind": "INTERFACE", "name": "SellingPlanPricingPolicyBase", "description": "Represents selling plan pricing policy common fields.", "fields": [ { "name": "adjustmentType", "description": "The price adjustment type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "adjustmentValue", "description": "The price adjustment value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanPricingPolicyAdjustmentValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SellingPlanFixedPricingPolicy", "ofType": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringPricingPolicy", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyInput", "description": "The input fields required to create or update a selling plan pricing policy.", "fields": null, "inputFields": [ { "name": "recurring", "description": "Recurring pricing policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringPricingPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "fixed", "description": "Fixed pricing policy details.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanFixedPricingPolicyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanPricingPolicyPercentageValue", "description": "The percentage value of a selling plan pricing policy percentage type.", "fields": [ { "name": "percentage", "description": "The percentage value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyValueInput", "description": "The input fields required to create or update a pricing policy adjustment value.", "fields": null, "inputFields": [ { "name": "percentage", "description": "The percentage value.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "fixedValue", "description": "The fixed value for an fixed amount off or a new policy price.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringBillingPolicy", "description": "Represents a recurring selling plan billing policy.", "fields": [ { "name": "anchors", "description": "Specific anchor dates upon which the billing interval calculations should be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanAnchor", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the selling plan billing policy was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The billing frequency, it can be either: day, week, month or year.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "intervalCount", "description": "The number of intervals between billings.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxCycles", "description": "Maximum number of billing iterations.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minCycles", "description": "Minimum number of billing iterations.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringBillingPolicyInput", "description": "The input fields required to create or update a recurring billing policy.", "fields": null, "inputFields": [ { "name": "interval", "description": "The billing frequency, it can be either: day, week, month or year.", "type": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null }, "defaultValue": null }, { "name": "intervalCount", "description": "The number of intervals between billings.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "anchors", "description": "Specific anchor dates upon which the billing interval calculations should be made.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "ofType": null } } }, "defaultValue": null }, { "name": "minCycles", "description": "Minimum number of billing iterations.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "maxCycles", "description": "Maximum number of billing iterations.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringDeliveryPolicy", "description": "Represents a recurring selling plan delivery policy.", "fields": [ { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanAnchor", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the selling plan delivery policy was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cutoff", "description": "Number of days which represent a buffer period for orders to be included in a cycle.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "intent", "description": "Whether the delivery policy is merchant or buyer-centric.\nBuyer-centric delivery policies state the time when the buyer will receive the goods.\nMerchant-centric delivery policies state the time when the fulfillment should be started.\nCurrently, only merchant-centric delivery policies are supported.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyIntent", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The delivery frequency, it can be either: day, week, month or year.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "intervalCount", "description": "The number of intervals between deliveries.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "preAnchorBehavior", "description": "The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringDeliveryPolicyInput", "description": "The input fields to create or update a recurring delivery policy.", "fields": null, "inputFields": [ { "name": "interval", "description": "The delivery frequency, it can be either: day, week, month or year.", "type": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null }, "defaultValue": null }, { "name": "intervalCount", "description": "The number of intervals between deliveries.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "ofType": null } } }, "defaultValue": null }, { "name": "cutoff", "description": "A buffer period for orders to be included in a cycle.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "intent", "description": "Intention of this delivery policy, it can be either: delivery or fulfillment.", "type": { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyIntent", "ofType": null }, "defaultValue": null }, { "name": "preAnchorBehavior", "description": "The pre-anchor behavior. It can be either: asap or next.", "type": { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyIntent", "description": "Whether the delivery policy is merchant or buyer-centric.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FULFILLMENT_BEGIN", "description": "A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", "description": "The fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ASAP", "description": "The orders placed can be fulfilled or delivered immediately. The orders placed inside a cutoff can be fulfilled or delivered at the next anchor.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "NEXT", "description": "The orders placed can be fulfilled or delivered at the next anchor date.\nThe orders placed inside a cutoff will skip the next anchor and can be fulfilled or\ndelivered at the following anchor.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SellingPlanRecurringPricingPolicy", "description": "Represents a recurring selling plan pricing policy. It applies after the fixed pricing policy. By using the afterCycle parameter, you can specify the cycle when the recurring pricing policy comes into effect. Recurring pricing policies are not available for deferred purchase options.", "fields": [ { "name": "adjustmentType", "description": "The price adjustment type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "adjustmentValue", "description": "The price adjustment value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanPricingPolicyAdjustmentValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "afterCycle", "description": "Cycle after which this pricing policy applies.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the recurring selling plan pricing policy was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SellingPlanPricingPolicyBase", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SellingPlanRecurringPricingPolicyInput", "description": "The input fields required to create or update a recurring selling plan pricing policy.", "fields": null, "inputFields": [ { "name": "id", "description": "ID of the pricing policy.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "adjustmentType", "description": "Price adjustment type defined by the policy.", "type": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null }, "defaultValue": null }, { "name": "adjustmentValue", "description": "Price adjustment value defined by the policy.", "type": { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyValueInput", "ofType": null }, "defaultValue": null }, { "name": "afterCycle", "description": "Cycle after which the pricing policy applies.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanRemainingBalanceChargeTrigger", "description": "When to capture the payment for the remaining amount due.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NO_REMAINING_BALANCE", "description": "When there's no remaining balance to be charged after checkout.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXACT_TIME", "description": "At an exact time defined by the remaining_balance_charge_exact_time field.", "isDeprecated": false, "deprecationReason": null }, { "name": "TIME_AFTER_CHECKOUT", "description": "After the duration defined by the remaining_balance_charge_time_after_checkout field.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "SellingPlanReserve", "description": "When to reserve inventory for a selling plan.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ON_FULFILLMENT", "description": "Reserve inventory when order is fulfilled.", "isDeprecated": false, "deprecationReason": null }, { "name": "ON_SALE", "description": "Reserve inventory at time of sale.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ServerPixel", "description": "A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current state of this server pixel.", "args": [], "type": { "kind": "ENUM", "name": "ServerPixelStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookEndpointAddress", "description": "Address of the EventBridge or PubSub endpoint.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ServerPixelCreatePayload", "description": "Return type for `serverPixelCreate` mutation.", "fields": [ { "name": "serverPixel", "description": "The new server pixel.", "args": [], "type": { "kind": "OBJECT", "name": "ServerPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ServerPixelDeletePayload", "description": "Return type for `serverPixelDelete` mutation.", "fields": [ { "name": "deletedServerPixelId", "description": "The ID of the server pixel that was deleted, if one was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsServerPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ServerPixelStatus", "description": "The current state of a server pixel.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CONNECTED", "description": "This server pixel is connected: it will stream customer events to the endpoint if it is configured properly.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCONNECTED_UNCONFIGURED", "description": "This server pixel is disconnected and unconfigured: it does not stream events to the endpoint and no endpoint address had been added to the server pixel.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCONNECTED_CONFIGURED", "description": "This server pixel is disconnected: it does not stream events to the endpoint and an endpoint address has been added to the server pixel.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ShippingDiscountClass", "description": "The class of the discount for combining purposes.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHIPPING", "description": "Combined as a shipping discount.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingLabel", "description": "The optional shipping label for this fulfillment.", "fields": [ { "name": "cancellable", "description": "Indicates whether the label is cancellable or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location of the shipping origin. This will be null when the shipping origin is unknown.", "args": [], "type": { "kind": "OBJECT", "name": "Location", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "printed", "description": "Indicates whether the label was printed or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingLine", "description": "Represents the shipping details that the customer chose for their order.", "fields": [ { "name": "carrierIdentifier", "description": "A reference to the carrier service that provided the rate.\nPresent when the rate was computed by a third-party carrier service.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "A reference to the shipping method.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "custom", "description": "Whether the shipping line is custom or not.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryCategory", "description": "The general classification of the delivery method.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "The discounts that have been allocated to the shipping line.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedPrice", "description": "The pre-tax shipping price with discounts applied.\nAs of API version 2024-07, this will be calculated including cart level discounts, such as the free shipping discount.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `discountedPriceSet` instead." }, { "name": "discountedPriceSet", "description": "The shipping price after applying discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. If not, it's the pre-tax price.\nAs of API version 2024-07, this will be calculated including cart level discounts, such as the free shipping discount.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRemoved", "description": "Whether the shipping line has been removed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalPrice", "description": "The pre-tax shipping price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalPriceSet` instead." }, { "name": "originalPriceSet", "description": "The pre-tax shipping price without any discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number at the shipping address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "Returns the price of the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `originalPriceSet` instead." }, { "name": "requestedFulfillmentService", "description": "The fulfillment service requested for the shipping method.\nPresent if the shipping method requires processing by a third party fulfillment service.\n", "args": [], "type": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingRateHandle", "description": "A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "source", "description": "Returns the rate source for the shipping line.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxLines", "description": "The TaxLine objects connected to this shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Returns the title of the shipping line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingLineConnection", "description": "An auto-generated type for paginating through multiple ShippingLines.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLineEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShippingLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingLineEdge", "description": "An auto-generated type which holds one ShippingLine and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShippingLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShippingLineInput", "description": "The input fields for specifying the shipping details for the draft order.\n\n> Note:\n> A custom shipping line includes a title and price with `shippingRateHandle` set to `nil`. A shipping line with a carrier-provided shipping rate (currently set via the Shopify admin) includes the shipping rate handle.\n", "fields": null, "inputFields": [ { "name": "price", "description": "Price of the shipping rate.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "priceWithCurrency", "description": "Price of the shipping rate with currency. If provided, `price` will be ignored.", "type": { "kind": "INPUT_OBJECT", "name": "MoneyInput", "ofType": null }, "defaultValue": null }, { "name": "shippingRateHandle", "description": "A unique identifier for the shipping rate.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "title", "description": "Title of the shipping rate.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingLineSale", "description": "A sale associated with a shipping charge.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingLine", "description": "The shipping line item for the associated sale. `shippingLine` is not available if the `SaleActionType` is a return.", "args": [], "type": { "kind": "OBJECT", "name": "ShippingLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingMethod", "description": "The shipping method for the delivery. Customers will see applicable shipping methods in the shipping section of checkout.\n", "fields": [ { "name": "code", "description": "A unique code associated with the rate. For example: `expedited_mail`", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "A description of the rate, which customers will see at checkout.\nFor example: `Local delivery`, `Free Express Worldwide`, `Includes tracking and insurance`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingPackageDeletePayload", "description": "Return type for `shippingPackageDelete` mutation.", "fields": [ { "name": "deletedId", "description": "The ID of the deleted shipping package.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingPackageMakeDefaultPayload", "description": "Return type for `shippingPackageMakeDefault` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShippingPackageType", "description": "Type of a shipping package.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BOX", "description": "A shipping box.", "isDeprecated": false, "deprecationReason": null }, { "name": "FLAT_RATE", "description": "A flat rate packaging supplied by a carrier.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENVELOPE", "description": "An envelope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SOFT_PACK", "description": "A soft-pack, bubble-wrap or vinyl envelope.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingPackageUpdatePayload", "description": "Return type for `shippingPackageUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingRate", "description": "A shipping rate is an additional cost added to the cost of the products that were ordered.", "fields": [ { "name": "handle", "description": "Human-readable unique identifier for this shipping rate.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The cost associated with the shipping rate.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the shipping rate.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingRefund", "description": "Represents the shipping costs refunded on the Refund.", "fields": [ { "name": "amount", "description": "The monetary value of the shipping fees to be refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountSet` instead." }, { "name": "amountSet", "description": "The monetary value of the shipping fees to be refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumRefundable", "description": "The maximum amount of shipping fees currently refundable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `maximumRefundableSet` instead." }, { "name": "maximumRefundableSet", "description": "The maximum amount of shipping fees currently refundable in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tax", "description": "The monetary value of the tax allocated to shipping fees to be refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `taxSet` instead." }, { "name": "taxSet", "description": "The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShippingRefundInput", "description": "The input fields that are required to reimburse shipping costs.", "fields": null, "inputFields": [ { "name": "amount", "description": "The monetary value of the shipping fees to be reimbursed.", "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "defaultValue": null }, { "name": "fullRefund", "description": "Whether a full refund is provided.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Shop", "description": "Represents a collection of general settings and information about the shop.\n", "fields": [ { "name": "alerts", "description": "A list of the shop's active alert messages that appear in the Shopify admin.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopAlert", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "allProductCategories", "description": "A list of the shop's product categories. Limit: 1000 product categories.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductCategory", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "analyticsToken", "description": "The token required to query the shop's reports or dashboards.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Not supported anymore." }, { "name": "assignedFulfillmentOrders", "description": "The paginated list of fulfillment orders assigned to the shop locations owned by the app.\n\nAssigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations\nmanaged by\n[fulfillment services](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService)\nthat are registered by the app.\nOne app (api_client) can host multiple fulfillment services on a shop.\nEach fulfillment service manages a dedicated location on a shop.\nAssigned fulfillment orders can have associated\n[fulfillment requests](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus),\nor might currently not be requested to be fulfilled.\n\nThe app must have `read_assigned_fulfillment_orders`\n[access scope](https://shopify.dev/docs/api/usage/access-scopes)\nto be able to retrieve fulfillment orders assigned to its locations.\n\nAll assigned fulfillment orders (except those with the `CLOSED` status) will be returned by default.\nPerform filtering with the `assignmentStatus` argument\nto receive only fulfillment orders that have been requested to be fulfilled.\n", "args": [ { "name": "assignmentStatus", "description": "The assigment status of the fulfillment orders that should be returned.\nIf `assignmentStatus` argument is not provided, then\nthe query will return all assigned fulfillment orders,\nexcept those that have the `CLOSED` status.\n", "type": { "kind": "ENUM", "name": "FulfillmentOrderAssignmentStatus", "ofType": null }, "defaultValue": null }, { "name": "locationIds", "description": "Returns fulfillment orders only for certain locations, specified by a list of location IDs.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "FulfillmentOrderSortKeys", "ofType": null }, "defaultValue": "ID" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "availableChannelApps", "description": "The list of sales channels not currently installed on the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AppConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddress", "description": "The shop's billing address information.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channelDefinitionsForInstalledChannels", "description": "List of all channel definitions associated with a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AvailableChannelDefinitionsByChannel", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "channels", "description": "List of the shop's active sales channels.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ChannelConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.channels` instead." }, { "name": "checkoutApiSupported", "description": "Specifies whether the shop supports checkouts via Checkout API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "collectionByHandle", "description": "Return a collection by its handle.", "args": [ { "name": "handle", "description": "The handle of the collection.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Collection", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.collectionByHandle` instead." }, { "name": "collectionSavedSearches", "description": "List of the shop's collection saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.collectionSavedSearches` instead." }, { "name": "collections", "description": "List of the shop's collections.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CollectionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| collection_type |\n| product_publication_status |\n| publishable_status |\n| published_status |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CollectionConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.collections` instead." }, { "name": "contactEmail", "description": "The public-facing contact email address for the shop.\nCustomers will use this email to communicate with the shop owner.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "countriesInShippingZones", "description": "Countries that have been defined in shipping zones for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CountriesInShippingZones", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the shop was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The three letter code for the currency that the shop sells in.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyFormats", "description": "How currencies are displayed on your store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencyFormats", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencySettings", "description": "The presentment currency settings for the shop excluding the shop's own currency.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CurrencySettingConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerAccounts", "description": "Whether customer accounts are required, optional, or disabled for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopCustomerAccountsSetting", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerAccountsV2", "description": "Information about the shop's customer accounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerAccountsV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerSavedSearches", "description": "List of the shop's customer saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CustomerSavedSearchSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| name |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.customerSavedSearches` instead." }, { "name": "customerTags", "description": "A list of tags that have been added to customer accounts.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customers", "description": "Customer accounts associated to the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "CustomerSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| accepts_marketing |\n| country |\n| customer_date |\n| email |\n| last_abandoned_order_date |\n| order_date |\n| orders_count |\n| phone |\n| state |\n| tag |\n| tag_not |\n| total_spent |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.customers` instead." }, { "name": "description", "description": "The shop's meta description used in search engine results.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "domains", "description": "The domains configured for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Domain", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use `domainsPaginated` instead." }, { "name": "draftOrderSavedSearches", "description": "List of the shop's draft order saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.draftOrderSavedSearches` instead." }, { "name": "draftOrderTags", "description": "A list of tags that have been added to draft orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draftOrders", "description": "List of saved draft orders on the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "DraftOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| customer_id |\n| source |\n| status |\n| tag |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "DraftOrderConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.draftOrders` instead." }, { "name": "email", "description": "The shop owner's email address.\nShopify will use this email address to communicate with the shop owner.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabledPresentmentCurrencies", "description": "The presentment currencies enabled for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "features", "description": "The set of features enabled for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopFeatures", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillmentOrders", "description": "The paginated list of merchant-managed and third-party fulfillment orders.", "args": [ { "name": "includeClosed", "description": "Whether to include closed fulfillment orders.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "FulfillmentOrderSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| assigned_location_id |\n| status |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentOrderConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.fulfillmentOrders` instead." }, { "name": "fulfillmentServices", "description": "List of the shop's installed fulfillment services.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FulfillmentService", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ianaTimezone", "description": "The shop's time zone as defined by the IANA.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inventoryItems", "description": "List of the shop's inventory items.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| id |\n| sku |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "InventoryItemConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.inventoryItems` instead." }, { "name": "limitedPendingOrderCount", "description": "The number of pendings orders on the shop.\nLimited to a maximum of 10000.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LimitedPendingOrderCount", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.pendingOrdersCount` instead." }, { "name": "locations", "description": "List of active locations of the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "LocationSortKeys", "ofType": null }, "defaultValue": "NAME" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| active |\n| address1 |\n| address2 |\n| city |\n| country |\n| legacy |\n| name |\n| province |\n| zip |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "includeLegacy", "description": "If true, also include the legacy locations of fulfillment services.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "includeInactive", "description": "If true, also include the locations that are deactivated.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LocationConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.locations` instead." }, { "name": "marketingEvents", "description": "List of a shop's marketing events.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MarketingEventSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| app_id |\n| description |\n| started_at |\n| type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketingEventConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.marketingEvents` instead." }, { "name": "marketingSmsConsentEnabledAtCheckout", "description": "Whether SMS marketing has been enabled on the shop's checkout configuration settings.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "merchantApprovalSignals", "description": "The approval signals for a shop to support onboarding to channel apps.", "args": [], "type": { "kind": "OBJECT", "name": "MerchantApprovalSignals", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "myshopifyDomain", "description": "The shop's .myshopify.com domain name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The shop's name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "navigationSettings", "description": "The shop's settings related to navigation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "NavigationItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderNumberFormatPrefix", "description": "The prefix that appears before order numbers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderNumberFormatSuffix", "description": "The suffix that appears after order numbers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orderSavedSearches", "description": "List of the shop's order saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.orderSavedSearches` instead." }, { "name": "orderTags", "description": "A list of tags that have been added to orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "sort", "description": "Sort type.", "type": { "kind": "ENUM", "name": "ShopTagSort", "ofType": null }, "defaultValue": "ALPHABETICAL" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "A list of the shop's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "OrderSortKeys", "ofType": null }, "defaultValue": "PROCESSED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| cart_token |\n| channel |\n| channel_id |\n| chargeback_status |\n| checkout_token |\n| confirmation_number |\n| created_at |\n| credit_card_last4 |\n| customer_id |\n| delivery_method |\n| discount_code |\n| email |\n| financial_status |\n| fraud_protection_level |\n| fulfillment_location_id |\n| fulfillment_status |\n| gateway |\n| location_id |\n| name |\n| payment_id |\n| payment_provider_id |\n| po_number |\n| processed_at |\n| reference_location_id |\n| return_status |\n| risk_level |\n| sales_channel |\n| sku |\n| source_identifier |\n| source_name |\n| status |\n| tag |\n| tag_not |\n| test |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.orders` instead." }, { "name": "paymentSettings", "description": "The shop's settings related to payments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentSettings", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "plan", "description": "The shop's billing plan.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopPlan", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "priceRuleSavedSearches", "description": "List of the shop's price rule saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.priceRuleSavedSearches` instead." }, { "name": "priceRules", "description": "List of the shop’s price rules.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "PriceRuleSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| combines_with |\n| created_at |\n| discount_type |\n| ends_at |\n| starts_at |\n| status |\n| times_used |\n| title |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRuleConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.priceRules` instead." }, { "name": "primaryDomain", "description": "The primary domain of the shop's online store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Domain", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "productByHandle", "description": "Return a product by its handle.", "args": [ { "name": "handle", "description": "A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: `-`. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called `Potion`, then their handles would be `potion` and `potion-1`. After a product has been created, changing the product title doesn't update the handle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Product", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.productByHandle` instead." }, { "name": "productImages", "description": "The list of all images of all products for the shop.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductImageSortKeys", "ofType": null }, "defaultValue": "CREATED_AT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ImageConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `files` instead. See [filesQuery](https://shopify.dev/docs/api/admin-graphql/latest/queries/files) and its [query](https://shopify.dev/docs/api/admin-graphql/2024-01/queries/files#argument-query) argument for more information." }, { "name": "productSavedSearches", "description": "List of the shop's product saved searches.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SavedSearchConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.productSavedSearches` instead." }, { "name": "productTags", "description": "A list of tags that have been added to products.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productTypes", "description": "The list of types added to products.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productVariants", "description": "List of the shop's product variants.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductVariantSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| collection |\n| delivery_profile_id |\n| exclude_composite |\n| exclude_variants_with_components |\n| gift_card |\n| inventory_quantity |\n| location_id |\n| managed |\n| managed_by |\n| option1 |\n| option2 |\n| option3 |\n| product_id |\n| product_ids |\n| product_publication_status |\n| product_status |\n| product_type |\n| publishable_status |\n| published_status |\n| requires_components |\n| sku |\n| tag |\n| tag_not |\n| taxable |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductVariantConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.productVariants` instead." }, { "name": "productVendors", "description": "The list of vendors added to products.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "List of the shop's products.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "ProductSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| barcode |\n| bundles |\n| created_at |\n| delivery_profile_id |\n| error_feedback |\n| gift_card |\n| has_only_composites |\n| has_only_default_variant |\n| has_variant_with_components |\n| id |\n| inventory_total |\n| is_price_reduced |\n| out_of_stock_somewhere |\n| price |\n| product_configuration_owner |\n| product_publication_status |\n| product_type |\n| publishable_status |\n| published_status |\n| sku |\n| status |\n| tag |\n| tag_not |\n| title |\n| updated_at |\n| vendor |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.products`." }, { "name": "publicationCount", "description": "The number of publications for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `QueryRoot.publicationsCount` instead." }, { "name": "resourceLimits", "description": "The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopResourceLimits", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "richTextEditorUrl", "description": "The URL of the rich text editor that can be used for mobile devices.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "search", "description": "Fetches a list of admin search results by a specified query.", "args": [ { "name": "query", "description": "The search query to filter by.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "types", "description": "The search result types to filter by.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SearchResultType", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchResultConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "searchFilters", "description": "The list of search filter options for the shop. These can be used to filter productvisibility for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchFilterOptions", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "setupRequired", "description": "Whether the shop has outstanding setup steps.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipsToCountries", "description": "The list of countries that the shop ships to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopPolicies", "description": "The list of all legal policies associated with a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopPolicy", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "staffMembers", "description": "The paginated list of the shop's staff members.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMemberConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontAccessTokens", "description": "The storefront access token of a private application. These are scoped per-application.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StorefrontAccessTokenConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontUrl", "description": "The URL of the shop's storefront.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `url` instead." }, { "name": "taxShipping", "description": "Whether the shop charges taxes for shipping.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxesIncluded", "description": "Whether applicable taxes are included in the shop's product prices.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "timezoneAbbreviation", "description": "The shop's time zone abbreviation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "timezoneOffset", "description": "The shop's time zone offset.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "timezoneOffsetMinutes", "description": "The shop's time zone offset expressed as a number of minutes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactionalSmsDisabled", "description": "Whether transactional SMS sent by Shopify have been disabled for a shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unitSystem", "description": "The shop's unit system for weights and measures.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "UnitSystem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the shop was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uploadedImagesByIds", "description": "Fetches a list of images uploaded to the shop by their IDs.", "args": [ { "name": "imageIds", "description": "The IDs of the uploaded images.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the shop's online store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "weightUnit", "description": "The shop's primary unit of weight for products and shipping.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WeightUnit", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopAddress", "description": "An address for a shop.", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The name of the company or organization.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "coordinatesValidated", "description": "Whether the address coordinates are valid.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `countryCodeV2` instead." }, { "name": "countryCodeV2", "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Always null in this context." }, { "name": "formatted", "description": "A formatted version of the address, customized by the provided arguments.", "args": [ { "name": "withCompany", "description": "Whether to include the company in the formatted address.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "true" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedArea", "description": "A comma-separated list of the values for city, province, and country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Always null in this context." }, { "name": "latitude", "description": "The latitude coordinate of the address.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "longitude", "description": "The longitude coordinate of the address.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The full name, based on firstName and lastName.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Always null in this context." }, { "name": "phone", "description": "A phone number associated with the address.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The two-letter code for the region.\n\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopAlert", "description": "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.\n", "fields": [ { "name": "action", "description": "The text for the button in the alert that links to related information. For example, _Add credit card_.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopAlertAction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "A description of the alert and further information, such as whether the merchant will be charged.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopAlertAction", "description": "An action associated to a shop alert, such as adding a credit card.", "fields": [ { "name": "title", "description": "The text for the button in the alert. For example, _Add credit card_.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The target URL that the button links to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopBillingPreferences", "description": "Billing preferences for the shop.", "fields": [ { "name": "currency", "description": "The currency the shop uses to pay for apps and services.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopBranding", "description": "Possible branding of a shop.\nBranding can be used to define the look of a shop including its styling and logo in the Shopify Admin.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SHOPIFY_GOLD", "description": "Shop has Shopify Gold branding.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOPIFY_PLUS", "description": "Shop has Shopify Plus branding.", "isDeprecated": false, "deprecationReason": null }, { "name": "ROGERS", "description": "Shop has Rogers branding.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOPIFY", "description": "Shop has Shopify branding.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ShopCustomerAccountsSetting", "description": "Represents the shop's customer account requirement preference.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "REQUIRED", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "OPTIONAL", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "DISABLED", "description": null, "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopFeatures", "description": "Represents the feature set available to the shop.\nMost fields specify whether a feature is enabled for a shop, and some fields return information\nrelated to specific features.\n", "fields": [ { "name": "avalaraAvatax", "description": "Whether a shop has access to Avalara AvaTax.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "branding", "description": "The branding of the shop, which influences its look and feel in the Shopify admin.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopBranding", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "bundles", "description": "Represents the Bundles feature configuration for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BundlesFeature", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "captcha", "description": "Whether a shop's online store can have CAPTCHA protection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "captchaExternalDomains", "description": "Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cartTransform", "description": "Represents the cart transform feature configuration for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTransformFeature", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryProfiles", "description": "Whether the delivery profiles functionality is enabled for this shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Delivery profiles are now 100% enabled across Shopify." }, { "name": "dynamicRemarketing", "description": "Whether a shop has access to the Google Analytics dynamic remarketing feature.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligibleForSubscriptionMigration", "description": "Whether a shop can be migrated to use Shopify subscriptions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligibleForSubscriptions", "description": "Whether a shop is configured properly to sell subscriptions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCards", "description": "Whether a shop can create gift cards.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "harmonizedSystemCode", "description": "Whether a shop displays Harmonized System codes on products. This is used for customs when shipping\ninternationally.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "internationalDomains", "description": "Whether a shop can enable international domains.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "All shops have international domains through Shopify Markets." }, { "name": "internationalPriceOverrides", "description": "Whether a shop can enable international price overrides.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "internationalPriceRules", "description": "Whether a shop can enable international price rules.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacySubscriptionGatewayEnabled", "description": "Whether a shop has enabled a legacy subscription gateway to handle older subscriptions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "liveView", "description": "Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial\nor don't have a storefront.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "multiLocation", "description": "Whether a shop has multi-location functionality.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "All shops support multi-location inventory. Use `QueryRoot.locations` to determine whether shop has more than one location.\n" }, { "name": "onboardingVisual", "description": "Whether a shop has access to the onboarding visual.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paypalExpressSubscriptionGatewayStatus", "description": "Whether a shop is configured to sell subscriptions with PayPal Express.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PaypalExpressSubscriptionsGatewayStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reports", "description": "Whether a shop has access to all reporting features.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellsSubscriptions", "description": "Whether a shop has ever had subscription products.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyPlus", "description": "Whether the shop has a Shopify Plus subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use Shop.plan.shopifyPlus instead." }, { "name": "showMetrics", "description": "Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefront", "description": "Whether a shop has an online store.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usingShopifyBalance", "description": "Whether a shop is using Shopify Balance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopLocale", "description": "A locale that's been enabled on a shop.", "fields": [ { "name": "locale", "description": "The locale ISO code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "marketWebPresences", "description": "The market web presences that use the locale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MarketWebPresence", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The human-readable locale name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "primary", "description": "Whether the locale is the default locale for the shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "published", "description": "Whether the locale is visible to buyers.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopLocaleDisablePayload", "description": "Return type for `shopLocaleDisable` mutation.", "fields": [ { "name": "locale", "description": "ISO code of the locale that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopLocaleEnablePayload", "description": "Return type for `shopLocaleEnable` mutation.", "fields": [ { "name": "shopLocale", "description": "ISO code of the locale that was enabled.", "args": [], "type": { "kind": "OBJECT", "name": "ShopLocale", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShopLocaleInput", "description": "The input fields for a shop locale.\n", "fields": null, "inputFields": [ { "name": "published", "description": "Whether the locale is published. Only published locales are visible to the buyer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "marketWebPresenceIds", "description": "The market web presences on which the locale should be enabled. Pass in an empty array to remove the locale across all market web presences.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopLocaleUpdatePayload", "description": "Return type for `shopLocaleUpdate` mutation.", "fields": [ { "name": "shopLocale", "description": "The locale that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "ShopLocale", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopPayInstallmentsPaymentDetails", "description": "Shop Pay Installments payment details related to a transaction.", "fields": [ { "name": "paymentMethodName", "description": "The name of payment method used by the buyer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "BasePaymentDetails", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopPlan", "description": "The billing plan of the shop.\n", "fields": [ { "name": "displayName", "description": "The name of the shop's billing plan.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "partnerDevelopment", "description": "Whether the shop is a partner development shop for testing purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shopifyPlus", "description": "Whether the shop has a Shopify Plus subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopPolicy", "description": "Policy that a merchant has configured for their store, such as their refund or privacy policy.", "fields": [ { "name": "body", "description": "The text of the policy. The maximum size is 512kb.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "HTML", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "The translations associated with the resource.", "args": [ { "name": "locale", "description": "Filters translations locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The shop policy type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopPolicyType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The public URL of the policy.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasPublishedTranslations", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopPolicyErrorCode", "description": "Possible error codes that can be returned by `ShopPolicyUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOO_BIG", "description": "The input value is too big.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShopPolicyInput", "description": "The input fields required to update a policy.", "fields": null, "inputFields": [ { "name": "type", "description": "The shop policy type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopPolicyType", "ofType": null } }, "defaultValue": null }, { "name": "body", "description": "Policy text, maximum size of 512kb.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopPolicyType", "description": "Available shop policy types.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "REFUND_POLICY", "description": "The refund policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_POLICY", "description": "The shipping policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRIVACY_POLICY", "description": "The privacy policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "TERMS_OF_SERVICE", "description": "The terms of service.", "isDeprecated": false, "deprecationReason": null }, { "name": "TERMS_OF_SALE", "description": "The terms of sale.", "isDeprecated": false, "deprecationReason": null }, { "name": "LEGAL_NOTICE", "description": "The legal notice.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_POLICY", "description": "The purchase options cancellation policy.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTACT_INFORMATION", "description": "The contact information.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopPolicyUpdatePayload", "description": "Return type for `shopPolicyUpdate` mutation.", "fields": [ { "name": "shopPolicy", "description": "The shop policy that has been updated.", "args": [], "type": { "kind": "OBJECT", "name": "ShopPolicy", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopPolicyUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopPolicyUserError", "description": "An error that occurs during the execution of a shop policy mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ShopPolicyErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopResourceFeedbackCreatePayload", "description": "Return type for `shopResourceFeedbackCreate` mutation.", "fields": [ { "name": "feedback", "description": "The shop feedback that's created.", "args": [], "type": { "kind": "OBJECT", "name": "AppFeedback", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopResourceFeedbackCreateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopResourceFeedbackCreateUserError", "description": "An error that occurs during the execution of `ShopResourceFeedbackCreate`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ShopResourceFeedbackCreateUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopResourceFeedbackCreateUserErrorCode", "description": "Possible error codes that can be returned by `ShopResourceFeedbackCreateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "OUTDATED_FEEDBACK", "description": "The feedback for a later version of the resource was already accepted.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopResourceLimits", "description": "Resource limits of a shop.", "fields": [ { "name": "locationLimit", "description": "Maximum number of locations allowed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxProductOptions", "description": "Maximum number of product options allowed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxProductVariants", "description": "The maximum number of variants allowed per product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "redirectLimitReached", "description": "Whether the shop has reached the limit of the number of URL redirects it can make for resources.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopTagSort", "description": "Possible sort of tags.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALPHABETICAL", "description": "Alphabetical sort.", "isDeprecated": false, "deprecationReason": null }, { "name": "POPULAR", "description": "Popularity sort.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyFunction", "description": "A Shopify Function.", "fields": [ { "name": "apiType", "description": "The API type of the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "apiVersion", "description": "The API version of the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "app", "description": "The app that owns the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "App", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appBridge", "description": "The App Bridge information for the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FunctionsAppBridge", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appKey", "description": "The client ID of the app that owns the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the Shopify Function.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inputQuery", "description": "The input query of the Shopify Function.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the Shopify Function.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "useCreationUi", "description": "If the Shopify Function uses the creation UI in the Admin.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyFunctionConnection", "description": "An auto-generated type for paginating through multiple ShopifyFunctions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunctionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShopifyFunctionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyFunctionEdge", "description": "An auto-generated type which holds one ShopifyFunction and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShopifyFunctionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsAccount", "description": "Balance and payout information for a\n[Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments)\naccount. Balance includes all balances for the currencies supported by the shop.\nYou can also query for a list of payouts, where each payout includes the corresponding currencyCode field.\n", "fields": [ { "name": "activated", "description": "Whether the Shopify Payments setup is completed.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "balance", "description": "Current balances in all currencies for the account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "balanceTransactions", "description": "A list of balance transactions associated with the shop.", "args": [ { "name": "hideTransfers", "description": "Determines if returned transactions contain transaction type transfer.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "BalanceTransactionSortKeys", "ofType": null }, "defaultValue": "PROCESSED_AT" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| available_on |\n| credit_card_last4 |\n| currency |\n| payment_method_name |\n| payments_transfer_id |\n| payout_date |\n| payout_status |\n| processed_at |\n| tax_reporting_exempt |\n| transaction_type |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "savedSearchId", "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransactionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "bankAccounts", "description": "All bank accounts configured for the Shopify Payments account.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "chargeStatementDescriptor", "description": "The statement descriptor used for charges.\n\nThe statement descriptor appears on a customer's credit card or bank statement when they make a purchase.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `chargeStatementDescriptors` instead." }, { "name": "chargeStatementDescriptors", "description": "The statement descriptors used for charges.\n\nThese descriptors appear on a customer's credit card or bank statement when they make a purchase.\n", "args": [], "type": { "kind": "INTERFACE", "name": "ShopifyPaymentsChargeStatementDescriptor", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The Shopify Payments account country.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultCurrency", "description": "The default payout currency for the Shopify Payments account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "disputes", "description": "All disputes related to the Shopify Payments account.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| id |\n| initiated_at |\n| status |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fraudSettings", "description": "The fraud settings of the Shopify Payments account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsFraudSettings", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "notificationSettings", "description": "The notifications settings for the account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsNotificationSettings", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "onboardable", "description": "Whether the Shopify Payments account can be onboarded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "payoutSchedule", "description": "The payout schedule for the account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutSchedule", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "payoutStatementDescriptor", "description": "The descriptor used for payouts.\n\nThe descriptor appears on a merchant's bank statement when they receive a payout.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "payouts", "description": "All current and previous payouts made between the account and the bank account.", "args": [ { "name": "transactionType", "description": "Filter the direction of the payout.", "type": { "kind": "ENUM", "name": "ShopifyPaymentsPayoutTransactionType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "permittedVerificationDocuments", "description": "The permitted documents for identity verification.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsVerificationDocument", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "verifications", "description": "The verifications necessary for this account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsVerification", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsAdjustmentOrder", "description": "The adjustment order object.\n", "fields": [ { "name": "amount", "description": "The amount of the adjustment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "link", "description": "The link to the adjustment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the adjustment order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransaction", "description": "A transaction that contributes to a Shopify Payments account balance.\n", "fields": [ { "name": "adjustmentsOrders", "description": "The adjustment orders associated to the transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsAdjustmentOrder", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "net", "description": "The net amount contributing to the merchant's balance.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactionDate", "description": "The date and time when the balance transaction was processed.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransactionConnection", "description": "An auto-generated type for paginating through multiple ShopifyPaymentsBalanceTransactions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransactionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShopifyPaymentsBalanceTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransactionEdge", "description": "An auto-generated type which holds one ShopifyPaymentsBalanceTransaction and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShopifyPaymentsBalanceTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBalanceTransaction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccount", "description": "A bank account that can receive payouts.\n", "fields": [ { "name": "accountNumber", "description": "The account number of the bank account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "accountNumberLastDigits", "description": "The last digits of the account number (the rest is redacted).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "bankName", "description": "The name of the bank.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The country of the bank.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CountryCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date that the bank account was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currency", "description": "The currency of the bank account.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "payouts", "description": "All current and previous payouts made between the account and the bank account.", "args": [ { "name": "transactionType", "description": "Filter the direction of the payout.", "type": { "kind": "ENUM", "name": "ShopifyPaymentsPayoutTransactionType", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "routingNumber", "description": "The routing number of the bank account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the bank account.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsBankAccountStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccountConnection", "description": "An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccountEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShopifyPaymentsBankAccountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccount", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccountEdge", "description": "An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShopifyPaymentsBankAccountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsBankAccountStatus", "description": "The bank account status.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NEW", "description": "A bank account that hasn't had any activity and that's not validated.", "isDeprecated": false, "deprecationReason": null }, { "name": "VALIDATED", "description": "It was determined that the bank account exists.", "isDeprecated": false, "deprecationReason": null }, { "name": "VERIFIED", "description": "Bank account validation was successful.", "isDeprecated": false, "deprecationReason": null }, { "name": "ERRORED", "description": "A payout to the bank account failed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "ShopifyPaymentsChargeStatementDescriptor", "description": "The charge descriptors for a payments account.", "fields": [ { "name": "default", "description": "The default charge statement descriptor.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "The prefix of the statement descriptor.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ShopifyPaymentsDefaultChargeStatementDescriptor", "ofType": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsJpChargeStatementDescriptor", "ofType": null } ] }, { "kind": "OBJECT", "name": "ShopifyPaymentsDefaultChargeStatementDescriptor", "description": "The charge descriptors for a payments account.", "fields": [ { "name": "default", "description": "The default charge statement descriptor.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "The prefix of the statement descriptor.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShopifyPaymentsChargeStatementDescriptor", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "description": "A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.", "fields": [ { "name": "amount", "description": "The total amount disputed by the cardholder.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "evidenceDueBy", "description": "The deadline for evidence submission.", "args": [], "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "evidenceSentOn", "description": "The date when evidence was sent. Returns null if evidence hasn't yet been sent.", "args": [], "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "finalizedOn", "description": "The date when this dispute was resolved. Returns null if the dispute isn't yet resolved.", "args": [], "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "initiatedAt", "description": "The date when this dispute was initiated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order that contains the charge that's under dispute.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reasonDetails", "description": "The reason of the dispute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeReasonDetails", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current state of the dispute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DisputeStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DisputeType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeConnection", "description": "An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShopifyPaymentsDisputeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEdge", "description": "An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShopifyPaymentsDisputeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeEvidence", "description": "The evidence associated with the dispute.", "fields": [ { "name": "accessActivityLog", "description": "The activity logs associated with the dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAddress", "description": "The billing address that's provided by the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancellationPolicyDisclosure", "description": "The cancellation policy disclosure associated with the dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancellationPolicyFile", "description": "The cancellation policy file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cancellationRebuttal", "description": "The cancellation rebuttal associated with the dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerCommunicationFile", "description": "The customer communication file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerEmailAddress", "description": "The customer's email address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerFirstName", "description": "The customer's first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerLastName", "description": "The customer's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPurchaseIp", "description": "The customer purchase ip for this dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dispute", "description": "The dispute associated with the evidence.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDispute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "disputeFileUploads", "description": "The file uploads associated with the dispute evidence.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fulfillments", "description": "The fulfillments associated with the dispute evidence.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFulfillment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "productDescription", "description": "The product description for this dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundPolicyDisclosure", "description": "The refund policy disclosure associated with the dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundPolicyFile", "description": "The refund policy file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundRefusalExplanation", "description": "The refund refusal explanation associated with dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "serviceDocumentationFile", "description": "The service documentation file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingAddress", "description": "The mailing address for shipping that's provided by the customer.", "args": [], "type": { "kind": "OBJECT", "name": "MailingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingDocumentationFile", "description": "The shipping documentation file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "submitted", "description": "Whether the dispute evidence is submitted.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uncategorizedFile", "description": "The uncategorized file associated with the dispute evidence.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uncategorizedText", "description": "The uncategorized text for the dispute evidence.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsDisputeEvidenceFileType", "description": "The possible dispute evidence file types.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CUSTOMER_COMMUNICATION_FILE", "description": "Customer Communication File.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUND_POLICY_FILE", "description": "Refund Policy File.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLATION_POLICY_FILE", "description": "Cancellation Policy File.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNCATEGORIZED_FILE", "description": "Uncategorized File.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_DOCUMENTATION_FILE", "description": "Shipping Documentation File.", "isDeprecated": false, "deprecationReason": null }, { "name": "SERVICE_DOCUMENTATION_FILE", "description": "Service Documentation File.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeEvidenceUpdateInput", "description": "The input fields required to update a dispute evidence object.", "fields": null, "inputFields": [ { "name": "customerEmailAddress", "description": "Customer email address.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "customerLastName", "description": "Customer last name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "customerFirstName", "description": "Customer first name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "shippingAddress", "description": "The shipping address associated with the dispute evidence.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "uncategorizedText", "description": "Uncategorized text.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "accessActivityLog", "description": "Activity logs.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "cancellationPolicyDisclosure", "description": "Cancellation policy disclosure.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "cancellationRebuttal", "description": "Cancellation rebuttal.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "refundPolicyDisclosure", "description": "Refund policy disclosure.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "refundRefusalExplanation", "description": "Refund refusal explanation.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "cancellationPolicyFile", "description": "Cancellation policy file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "customerCommunicationFile", "description": "Customer communication file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "refundPolicyFile", "description": "Refund policy file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "shippingDocumentationFile", "description": "Shipping documentation file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "uncategorizedFile", "description": "Uncategorized file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "serviceDocumentationFile", "description": "Service documentation file.", "type": { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "ofType": null }, "defaultValue": null }, { "name": "submitEvidence", "description": "Whether to submit the evidence.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFileUpload", "description": "The file upload associated with the dispute evidence.", "fields": [ { "name": "disputeEvidenceType", "description": "The type of the file for the dispute evidence.", "args": [], "type": { "kind": "ENUM", "name": "ShopifyPaymentsDisputeEvidenceFileType", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileSize", "description": "The file size.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileType", "description": "The file type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalFileName", "description": "The original file name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL for accessing the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", "description": "The input fields required to update a dispute file upload object.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the file upload to be updated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "destroy", "description": "Whether to delete this file upload.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeFulfillment", "description": "The fulfillment associated with dispute evidence.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingCarrier", "description": "The shipping carrier for this fulfillment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingDate", "description": "The shipping date for this fulfillment.", "args": [], "type": { "kind": "SCALAR", "name": "Date", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingTrackingNumber", "description": "The shipping tracking number for this fulfillment.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsDisputeReason", "description": "The reason for the dispute provided by the cardholder's bank.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FRAUDULENT", "description": "The cardholder claims that they didn’t authorize the payment.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERAL", "description": "The dispute is uncategorized, so you should contact the customer for additional details to find out why the payment was disputed.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNRECOGNIZED", "description": "The customer doesn’t recognize the payment appearing on their card statement.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE", "description": "The customer claims they were charged multiple times for the same product or service.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CANCELLED", "description": "The customer claims that you continued to charge them after a subscription was canceled.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_UNACCEPTABLE", "description": "The product or service was received but was defective, damaged, or not as described.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_NOT_RECEIVED", "description": "The customer claims they did not receive the products or services purchased.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREDIT_NOT_PROCESSED", "description": "The customer claims that the purchased product was returned or the transaction was otherwise canceled, but you haven't yet provided a refund or credit.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCORRECT_ACCOUNT_DETAILS", "description": "The customer account associated with the purchase is incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "INSUFFICIENT_FUNDS", "description": "The customer's bank account has insufficient funds.", "isDeprecated": false, "deprecationReason": null }, { "name": "BANK_CANNOT_PROCESS", "description": "The customer's bank can't process the charge.", "isDeprecated": false, "deprecationReason": null }, { "name": "DEBIT_NOT_AUTHORIZED", "description": "The customer's bank can't proceed with the debit since it hasn't been authorized.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_INITIATED", "description": "The customer initiated the dispute. Contact the customer for additional details on why the payment was disputed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsDisputeReasonDetails", "description": "Details regarding a dispute reason.", "fields": [ { "name": "networkReasonCode", "description": "The raw code provided by the payment network.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reason", "description": "The reason for the dispute provided by the cardholder's banks.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsDisputeReason", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsExtendedAuthorization", "description": "Presents all Shopify Payments information related to an extended authorization.", "fields": [ { "name": "extendedAuthorizationExpiresAt", "description": "The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "standardAuthorizationExpiresAt", "description": "The time after which capture will incur an additional fee.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsFraudSettings", "description": "The fraud settings of a payments account.", "fields": [ { "name": "declineChargeOnAvsFailure", "description": "Decline a charge if there's an AVS failure.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "declineChargeOnCvcFailure", "description": "Decline a charge if there's an CVC failure.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsJpChargeStatementDescriptor", "description": "The charge descriptors for a Japanese payments account.", "fields": [ { "name": "default", "description": "The default charge statement descriptor.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "kana", "description": "The charge statement descriptor in kana.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "kanji", "description": "The charge statement descriptor in kanji.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "The prefix of the statement descriptor.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShopifyPaymentsChargeStatementDescriptor", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsNotificationSettings", "description": "The notification settings for the account.", "fields": [ { "name": "payouts", "description": "Receive email notifications when new payouts are sent or payouts fail.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayout", "description": "Payouts represent the movement of money between a merchant's Shopify\nPayments balance and their bank account.\n", "fields": [ { "name": "bankAccount", "description": "The bank account for the payout.", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsBankAccount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gross", "description": "The total amount and currency of the payout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `net` instead." }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "issuedAt", "description": "The exact time when the payout was issued. The payout only contains\nbalance transactions that were available at this time.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "net", "description": "The total amount and currency of the payout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The transfer status of the payout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsPayoutStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "The summary of the payout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutSummary", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactionType", "description": "The direction of the payout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsPayoutTransactionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutConnection", "description": "An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ShopifyPaymentsPayoutEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayout", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutEdge", "description": "An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ShopifyPaymentsPayoutEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsPayout", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsPayoutInterval", "description": "The interval at which payouts are sent to the connected bank account.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DAILY", "description": "Each business day.", "isDeprecated": false, "deprecationReason": null }, { "name": "WEEKLY", "description": "Each week, on the day of week specified by weeklyAnchor.", "isDeprecated": false, "deprecationReason": null }, { "name": "MONTHLY", "description": "Each month, on the day of month specified by monthlyAnchor.", "isDeprecated": false, "deprecationReason": null }, { "name": "MANUAL", "description": "Payouts will not be automatically made.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutSchedule", "description": "The payment schedule for a payments account.", "fields": [ { "name": "interval", "description": "The interval at which payouts are sent to the connected bank account.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsPayoutInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "monthlyAnchor", "description": "The day of the month funds will be paid out.\n\nThe value can be any day of the month from the 1st to the 31st.\nIf the payment interval is set to monthly, this value will be used.\nPayouts scheduled between 29-31st of the month are sent on the last day of shorter months.\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weeklyAnchor", "description": "The day of the week funds will be paid out.\n\nThe value can be any weekday from Monday to Friday.\nIf the payment interval is set to weekly, this value will be used.\n", "args": [], "type": { "kind": "ENUM", "name": "DayOfTheWeek", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsPayoutStatus", "description": "The transfer status of the payout.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SCHEDULED", "description": "The payout has been created and had transactions assigned to it, but\nit has not yet been submitted to the bank.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_TRANSIT", "description": "The payout has been submitted to the bank.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAID", "description": "The payout has been successfully deposited into the bank.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "The payout has been declined by the bank.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELED", "description": "The payout has been canceled by Shopify.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsPayoutSummary", "description": "Breakdown of the total fees and gross of each of the different types of transactions associated\nwith the payout.\n", "fields": [ { "name": "adjustmentsFee", "description": "Total fees for all adjustments including disputes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "adjustmentsGross", "description": "Total gross amount for all adjustments including disputes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "chargesFee", "description": "Total fees for all charges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "chargesGross", "description": "Total gross amount for all charges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundsFee", "description": "Total fees for all refunds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundsFeeGross", "description": "Total gross amount for all refunds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reservedFundsFee", "description": "Total fees for all reserved funds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reservedFundsGross", "description": "Total gross amount for all reserved funds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "retriedPayoutsFee", "description": "Total fees for all retried payouts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "retriedPayoutsGross", "description": "Total gross amount for all retried payouts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsPayoutTransactionType", "description": "The possible transaction types for a payout.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEPOSIT", "description": "The payout is a deposit.", "isDeprecated": false, "deprecationReason": null }, { "name": "WITHDRAWAL", "description": "The payout is a withdrawal.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsRefundSet", "description": "Presents all Shopify Payments specific information related to an order refund.", "fields": [ { "name": "acquirerReferenceNumber", "description": "The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsTransactionSet", "description": "Presents all Shopify Payments specific information related to an order transaction.", "fields": [ { "name": "extendedAuthorizationSet", "description": "Contains all fields related to an extended authorization.\n", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsExtendedAuthorization", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundSet", "description": "Contains all fields related to a refund.\n", "args": [], "type": { "kind": "OBJECT", "name": "ShopifyPaymentsRefundSet", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsVerification", "description": "Each subject (individual) of an account has a verification object giving\n information about the verification state.\n", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the verification.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsVerificationStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subject", "description": "The subject/individual who has to be verified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyPaymentsVerificationSubject", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsVerificationDocument", "description": "A document which can be used to verify an individual.", "fields": [ { "name": "backRequired", "description": "True if the back side of the document is required.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "frontRequired", "description": "True if the front side of the document is required.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of the document which can be used for verification.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyPaymentsVerificationDocumentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsVerificationDocumentType", "description": "The types of possible verification documents.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DRIVERS_LICENSE", "description": "The subject's driver's license.", "isDeprecated": false, "deprecationReason": null }, { "name": "GOVERNMENT_IDENTIFICATION", "description": "A government's identification document of the subject.", "isDeprecated": false, "deprecationReason": null }, { "name": "PASSPORT", "description": "The subject's passport.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyPaymentsVerificationStatus", "description": "The status of a verification.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "VERIFIED", "description": "The verification has been verified.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNVERIFIED", "description": "The verification has not yet been verified.", "isDeprecated": false, "deprecationReason": null }, { "name": "PENDING", "description": "The verification request has been submitted but a response has not yet been given.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyPaymentsVerificationSubject", "description": "The verification subject represents an individual that has to be verified.", "fields": [ { "name": "familyName", "description": "The family name of the individual to verify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "givenName", "description": "The given name of the individual to verify.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyProtectEligibilityStatus", "description": "The status of an order's eligibility for protection against fraudulent chargebacks by Shopify Protect.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "The eligibility of the order is pending and has not yet been determined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ELIGIBLE", "description": "The order is eligible for protection against fraudulent chargebacks.\nIf an order is updated, the order's eligibility may change and protection could be removed.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_ELIGIBLE", "description": "The order isn't eligible for protection against fraudulent chargebacks.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyProtectOrderEligibility", "description": "The eligibility details of an order's protection against fraudulent chargebacks by Shopify Protect.", "fields": [ { "name": "status", "description": "The status of whether an order is eligible for protection against fraudulent chargebacks.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyProtectEligibilityStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShopifyProtectOrderSummary", "description": "A summary of Shopify Protect details for an order.\n", "fields": [ { "name": "eligibility", "description": "The eligibility details of an order's protection against fraudulent chargebacks.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyProtectOrderEligibility", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order's protection against fraudulent chargebacks.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ShopifyProtectStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ShopifyProtectStatus", "description": "The status of an order's protection with Shopify Protect.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "The protection for the order is pending and has not yet been determined.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE", "description": "The protection for the order is active and eligible for reimbursement against fraudulent chargebacks.\nIf an order is updated, the order's eligibility may change and protection could become inactive.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INACTIVE", "description": "The protection for an order isn't active because the order didn't meet eligibility requirements.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROTECTED", "description": "The order received a fraudulent chargeback and it was protected.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_PROTECTED", "description": "The order received a chargeback but the order wasn't protected because it didn't meet coverage requirements.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INTERFACE", "name": "ShopifyqlResponse", "description": "A response to a ShopifyQL query.", "fields": [ { "name": "parseErrors", "description": "A list of parse errors, if parsing fails.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ParseError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tableData", "description": "The result in a tabular format with schema and row data.\n To be used as a raw 2-dimensional response of the query.\n It's always present even if query has a `VISUALIZE` keyword.", "args": [], "type": { "kind": "OBJECT", "name": "TableData", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "PolarisVizResponse", "ofType": null }, { "kind": "OBJECT", "name": "TableResponse", "ofType": null } ] }, { "kind": "OBJECT", "name": "StaffMember", "description": "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.\n", "fields": [ { "name": "active", "description": "Whether the staff member is active.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "avatar", "description": "The image used as the staff member's avatar in the Shopify admin.", "args": [ { "name": "fallback", "description": "The default image returned if the staff member has no avatar.", "type": { "kind": "ENUM", "name": "StaffMemberDefaultImage", "ofType": null }, "defaultValue": "DEFAULT" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Image", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": "The staff member's email address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "exists", "description": "Whether the staff member's account exists.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The staff member's first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "initials", "description": "The staff member's initials, if available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isShopOwner", "description": "Whether the staff member is the shop owner.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The staff member's last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "The staff member's preferred locale. Locale values use the format `language` or `language-COUNTRY`, where `language` is a two-letter language code, and `COUNTRY` is a two-letter country code. For example: `en` or `en-US`", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The staff member's full name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The staff member's phone number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateData", "description": "The data used to customize the Shopify admin experience for the staff member.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMemberPrivateData", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StaffMemberConnection", "description": "An auto-generated type for paginating through multiple StaffMembers.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMemberEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in StaffMemberEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMember", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "StaffMemberDefaultImage", "description": "Represents the fallback avatar image for a staff member. This is used only if the staff member has no avatar image.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DEFAULT", "description": "Returns a default avatar image for the staff member.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSPARENT", "description": "Returns a transparent avatar image for the staff member.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_FOUND", "description": "Returns a URL that returns a 404 error if the image is not present.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "StaffMemberEdge", "description": "An auto-generated type which holds one StaffMember and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of StaffMemberEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StaffMember", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "StaffMemberPermission", "description": "Represents access permissions for a staff member.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APPLICATIONS", "description": "The staff member can manage and install apps and channels.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHANNELS", "description": "The staff member can manage and install sales channels.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS", "description": "The staff member can view, create, update, and delete customers, and respond to customer messages in the Shopify Messaging API.", "isDeprecated": false, "deprecationReason": null }, { "name": "DASHBOARD", "description": "The staff member can view the Shopify Home page, which includes sales information and other shop data.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOMAINS", "description": "The staff member can view, buy, and manage domains.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT_ORDERS", "description": "The staff member can create, update, and delete draft orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "EDIT_ORDERS", "description": "The staff member can update orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULL", "description": "The staff has the same permissions as the [store owner](https://shopify.dev/en/manual/your-account/staff-accounts/staff-permissions#store-owner-permissions) with some exceptions, such as modifying the account billing or deleting staff accounts.", "isDeprecated": true, "deprecationReason": "Use the list of the staff member's explicit permissions returned in the `StaffMember.permissions.userPermissions` field instead of `full` permission." }, { "name": "GIFT_CARDS", "description": "The staff member can view, create, issue, and export gift cards to a CSV file.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINKS", "description": "The staff member can view and modify links and navigation menus.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS", "description": "The staff member can create, update, and delete locations where inventory is stocked or managed.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING", "description": "The staff member can view and create discount codes and automatic discounts, and export discounts to a CSV file.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETING_SECTION", "description": "The staff member can view, create, and automate marketing campaigns.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS", "description": "The staff member can view, create, update, delete, and cancel orders, and receive order notifications. The staff member can still create draft orders without this permission.", "isDeprecated": false, "deprecationReason": null }, { "name": "OVERVIEWS", "description": "The staff member can view the Overview and Live view pages, which include sales information, and other shop and sales channels data.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAGES", "description": "The staff member can view, create, update, publish, and delete blog posts and pages.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAY_ORDERS_BY_VAULTED_CARD", "description": "The staff member can pay for an order by using a vaulted card.", "isDeprecated": false, "deprecationReason": null }, { "name": "PREFERENCES", "description": "The staff member can view the preferences and configuration of a shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTS", "description": "The staff member can view, create, import, and update products, collections, and inventory.", "isDeprecated": false, "deprecationReason": null }, { "name": "REPORTS", "description": "The staff member can view and create all reports, which includes sales information and other shop data.", "isDeprecated": false, "deprecationReason": null }, { "name": "THEMES", "description": "The staff member can view, update, and publish themes.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSLATIONS", "description": "The staff member can view and create translations.", "isDeprecated": true, "deprecationReason": "Unused." } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "StaffMemberPrivateData", "description": "Represents the data used to customize the Shopify admin experience for a logged-in staff member.", "fields": [ { "name": "accountSettingsUrl", "description": "The URL to the staff member's account settings page.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the staff member was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "permissions", "description": "Access permissions for the staff member.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "StaffMemberPermission", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Use StaffMember.permissions.userPermissions instead" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StageImageInput", "description": "An image to be uploaded.\n\nDeprecated in favor of\n[StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput),\nwhich is used by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", "fields": null, "inputFields": [ { "name": "resource", "description": "The image resource.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "StagedUploadTargetGenerateUploadResource", "ofType": null } }, "defaultValue": null }, { "name": "filename", "description": "The image filename.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "mimeType", "description": "The image MIME type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "httpMethod", "description": "HTTP method to be used by the staged upload.", "type": { "kind": "ENUM", "name": "StagedUploadHttpMethodType", "ofType": null }, "defaultValue": "PUT" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedMediaUploadTarget", "description": "Information about a staged upload target, which should be used to send a request to upload\nthe file.\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", "fields": [ { "name": "parameters", "description": "Parameters needed to authenticate a request to upload the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StagedUploadParameter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "resourceUrl", "description": "The URL to be passed as `originalSource` in\n[CreateMediaInput](https://shopify.dev/api/admin-graphql/latest/input-objects/CreateMediaInput)\nand [FileCreateInput](https://shopify.dev/api/admin-graphql/2022-04/input-objects/FileCreateInput)\nfor the [productCreateMedia](https://shopify.dev/api/admin-graphql/2022-04/mutations/productCreateMedia)\nand [fileCreate](https://shopify.dev/api/admin-graphql/2022-04/mutations/fileCreate)\nmutations.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL to use when sending an request to upload the file. Should be used in conjunction with\nthe parameters field.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "StagedUploadHttpMethodType", "description": "The possible HTTP methods that can be used when sending a request to upload a file using information from a\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "POST", "description": "The POST HTTP method.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUT", "description": "The PUT HTTP method.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StagedUploadInput", "description": "The input fields for generating staged upload targets.", "fields": null, "inputFields": [ { "name": "resource", "description": "The file's intended Shopify resource type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "StagedUploadTargetGenerateUploadResource", "ofType": null } }, "defaultValue": null }, { "name": "filename", "description": "The file's name and extension.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "mimeType", "description": "The file's MIME type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "httpMethod", "description": "The HTTP method to be used when sending a request to upload the file using the returned staged\nupload target.\n", "type": { "kind": "ENUM", "name": "StagedUploadHttpMethodType", "ofType": null }, "defaultValue": "PUT" }, { "name": "fileSize", "description": "The size of the file to upload, in bytes. This is required when the request's resource property is set to\n[VIDEO](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-video)\nor [MODEL_3D](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-model3d).\n", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedUploadParameter", "description": "The parameters required to authenticate a file upload request using a\n[StagedMediaUploadTarget's url field](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-stagedmediauploadtarget-url).\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", "fields": [ { "name": "name", "description": "The parameter's name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The parameter's value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedUploadTarget", "description": "Information about the staged target.\n\nDeprecated in favor of\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget),\nwhich is returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", "fields": [ { "name": "parameters", "description": "The parameters of an image to be uploaded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ImageUploadParameter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The image URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StagedUploadTargetGenerateInput", "description": "The required fields and parameters to generate the URL upload an\"\nasset to Shopify.\n\nDeprecated in favor of\n[StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput),\nwhich is used by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", "fields": null, "inputFields": [ { "name": "resource", "description": "The resource type being uploaded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "StagedUploadTargetGenerateUploadResource", "ofType": null } }, "defaultValue": null }, { "name": "filename", "description": "The filename of the asset being uploaded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "mimeType", "description": "The MIME type of the asset being uploaded.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "httpMethod", "description": "The HTTP method to be used by the staged upload.", "type": { "kind": "ENUM", "name": "StagedUploadHttpMethodType", "ofType": null }, "defaultValue": "PUT" }, { "name": "fileSize", "description": "The size of the file to upload, in bytes.", "type": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedUploadTargetGeneratePayload", "description": "Return type for `stagedUploadTargetGenerate` mutation.", "fields": [ { "name": "parameters", "description": "The signed parameters that can be used to upload the asset.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MutationsStagedUploadTargetGenerateUploadParameter", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The signed URL where the asset can be uploaded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "StagedUploadTargetGenerateUploadResource", "description": "The resource type to receive.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "COLLECTION_IMAGE", "description": "An image associated with a collection.\n\nFor example, after uploading an image, you can use the\n[collectionUpdate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/collectionUpdate)\nto add the image to a collection.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "FILE", "description": "Represents any file other than HTML.\n\nFor example, after uploading the file, you can add the file to the\n[Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "IMAGE", "description": "An image.\n\nFor example, after uploading an image, you can add the image to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia)\nor to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "MODEL_3D", "description": "A Shopify hosted 3d model.\n\nFor example, after uploading the 3d model, you can add the 3d model to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_IMAGE", "description": "An image that's associated with a product.\n\nFor example, after uploading the image, you can add the image to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_IMAGE", "description": "An image.\n\nFor example, after uploading the image, you can add the image to the\n[Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "VIDEO", "description": "A Shopify-hosted video.\n\nFor example, after uploading the video, you can add the video to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia)\nor to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "BULK_MUTATION_VARIABLES", "description": "Represents bulk mutation variables.\n\nFor example, bulk mutation variables can be used for bulk operations using the\n[bulkOperationRunMutation mutation](https://shopify.dev/api/admin-graphql/latest/mutations/bulkOperationRunMutation).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURN_LABEL", "description": "Represents a label associated with a return.\n\nFor example, once uploaded, this resource can be used to [create a\nReverseDelivery](https://shopify.dev/api/admin-graphql/unstable/mutations/reverseDeliveryCreateWithShipping).\n", "isDeprecated": false, "deprecationReason": null }, { "name": "URL_REDIRECT_IMPORT", "description": "Represents a redirect CSV file.\n\nExample usage: This resource can be used for creating a\n[UrlRedirectImport](https://shopify.dev/api/admin-graphql/2022-04/objects/UrlRedirectImport)\nobject for use in the\n[urlRedirectImportCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate).\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedUploadTargetsGeneratePayload", "description": "Return type for `stagedUploadTargetsGenerate` mutation.", "fields": [ { "name": "urls", "description": "The staged upload targets that were generated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StagedUploadTarget", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StagedUploadsCreatePayload", "description": "Return type for `stagedUploadsCreate` mutation.", "fields": [ { "name": "stagedTargets", "description": "The staged upload targets that were generated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StagedMediaUploadTarget", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionEnablePayload", "description": "Return type for `standardMetafieldDefinitionEnable` mutation.", "fields": [ { "name": "createdDefinition", "description": "The metafield definition that was created.", "args": [], "type": { "kind": "OBJECT", "name": "MetafieldDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionEnableUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionEnableUserError", "description": "An error that occurs during the execution of `StandardMetafieldDefinitionEnable`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "StandardMetafieldDefinitionEnableUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "StandardMetafieldDefinitionEnableUserErrorCode", "description": "Possible error codes that can be returned by `StandardMetafieldDefinitionEnableUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "TEMPLATE_NOT_FOUND", "description": "The standard metafield definition template was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIMIT_EXCEEDED", "description": "The maximum number of definitions per owner type has been exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSTRUCTURED_ALREADY_EXISTS", "description": "The namespace and key is already in use for a set of your metafields.", "isDeprecated": false, "deprecationReason": null }, { "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", "description": "The definition type is not eligible to be used as collection condition.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplate", "description": "Standard metafield definition templates provide preset configurations to create metafield definitions.\nEach template has a specific namespace and key that we've reserved to have specific meanings for common use cases.\n\nRefer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions).\n", "fields": [ { "name": "description", "description": "The description of the standard metafield definition.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The key owned by the definition after the definition has been activated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The human-readable name for the standard metafield definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "namespace", "description": "The namespace owned by the definition after the definition has been activated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ownerTypes", "description": "The list of resource types that the standard metafield definition can be applied to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MetafieldOwnerType", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validations", "description": "The configured validations for the standard metafield definition.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionValidation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibleToStorefrontApi", "description": "Whether metafields for the definition are by default visible using the Storefront API.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplateConnection", "description": "An auto-generated type for paginating through multiple StandardMetafieldDefinitionTemplates.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplateEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in StandardMetafieldDefinitionTemplateEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplate", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplateEdge", "description": "An auto-generated type which holds one StandardMetafieldDefinitionTemplate and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of StandardMetafieldDefinitionTemplateEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StandardMetafieldDefinitionTemplate", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardMetaobjectDefinitionEnablePayload", "description": "Return type for `standardMetaobjectDefinitionEnable` mutation.", "fields": [ { "name": "metaobjectDefinition", "description": "The metaobject definition that was enabled using the standard template.", "args": [], "type": { "kind": "OBJECT", "name": "MetaobjectDefinition", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetaobjectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StandardizedProductType", "description": "Represents the details of a specific type of product within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt).", "fields": [ { "name": "productTaxonomyNode", "description": "The product taxonomy node associated with the standardized product type.", "args": [], "type": { "kind": "OBJECT", "name": "ProductTaxonomyNode", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StandardizedProductTypeInput", "description": "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.", "fields": null, "inputFields": [ { "name": "productTaxonomyNodeId", "description": "The ID of the node in the Shopify taxonomy that represents the product type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StorefrontAccessToken", "description": "A token that's used to delegate unauthenticated access scopes to clients that need to access\nthe unauthenticated Storefront API. An app can have a maximum of 100 active storefront access\ntokens for each shop.\n", "fields": [ { "name": "accessScopes", "description": "List of permissions associated with the token.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "AccessScope", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "accessToken", "description": "The issued public access token.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the public access token was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "An arbitrary title for each token determined by the developer, used for reference purposes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the storefront access token was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StorefrontAccessTokenConnection", "description": "An auto-generated type for paginating through multiple StorefrontAccessTokens.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StorefrontAccessTokenEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in StorefrontAccessTokenEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StorefrontAccessToken", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StorefrontAccessTokenCreatePayload", "description": "Return type for `storefrontAccessTokenCreate` mutation.", "fields": [ { "name": "shop", "description": "The user's shop.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Shop", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "storefrontAccessToken", "description": "The storefront access token.", "args": [], "type": { "kind": "OBJECT", "name": "StorefrontAccessToken", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StorefrontAccessTokenDeleteInput", "description": "The input fields to delete a storefront access token.", "fields": null, "inputFields": [ { "name": "id", "description": "The ID of the storefront access token to delete.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StorefrontAccessTokenDeletePayload", "description": "Return type for `storefrontAccessTokenDelete` mutation.", "fields": [ { "name": "deletedStorefrontAccessTokenId", "description": "The ID of the deleted storefront access token.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StorefrontAccessTokenEdge", "description": "An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of StorefrontAccessTokenEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StorefrontAccessToken", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "StorefrontAccessTokenInput", "description": "The input fields for a storefront access token.", "fields": null, "inputFields": [ { "name": "title", "description": "A title for the storefront access token.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "StorefrontID", "description": "Represents a unique identifier in the Storefront API. A `StorefrontID` value can be used wherever an ID is expected in the Storefront API.\n\nExample value: `\"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw\"`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "String", "description": "Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StringConnection", "description": "An auto-generated type for paginating through a list of Strings.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "StringEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StringEdge", "description": "An auto-generated type which holds one String and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of StringEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionAppliedCodeDiscount", "description": "Represents an applied code discount.", "fields": [ { "name": "id", "description": "The unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "redeemCode", "description": "The redeem code of the discount that applies on the subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rejectionReason", "description": "The reason that the discount on the subscription draft is rejected.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionDiscountRejectionReason", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionAtomicLineInput", "description": "The input fields for mapping a subscription line to a discount.", "fields": null, "inputFields": [ { "name": "line", "description": "The new subscription line.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionLineInput", "ofType": null } }, "defaultValue": null }, { "name": "discounts", "description": "The discount to be added to the subscription line.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionAtomicManualDiscountInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionAtomicManualDiscountInput", "description": "The input fields for mapping a subscription line to a discount.", "fields": null, "inputFields": [ { "name": "title", "description": "The title associated with the subscription discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "Percentage or fixed amount value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountValueInput", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The maximum number of times the subscription discount will be applied on orders.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "description": "A record of an execution of the subscription billing process. Billing attempts use\nidempotency keys to avoid duplicate order creation. A successful billing attempt\nwill create an order.\n", "fields": [ { "name": "completedAt", "description": "The date and time when the billing attempt was completed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the billing attempt was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorCode", "description": "A code corresponding to a payment error during processing.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionBillingAttemptErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorMessage", "description": "A message describing a payment error during processing.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "idempotencyKey", "description": "A unique key generated by the client to avoid duplicate payments.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nextActionUrl", "description": "The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.\n", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The result of this billing attempt if completed successfully.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originTime", "description": "The date and time used to calculate fulfillment intervals for a billing attempt that\nsuccessfully completed after the current anchor date. To prevent fulfillment from being\npushed to the next anchor date, this field can override the billing attempt date.\n", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ready", "description": "Whether the billing attempt is still processing.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionContract", "description": "The subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingAttemptConnection", "description": "An auto-generated type for paginating through multiple SubscriptionBillingAttempts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttemptEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionBillingAttemptEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingAttemptCreatePayload", "description": "Return type for `subscriptionBillingAttemptCreate` mutation.", "fields": [ { "name": "subscriptionBillingAttempt", "description": "The subscription billing attempt.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "BillingAttemptUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingAttemptEdge", "description": "An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionBillingAttemptEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttempt", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingAttemptErrorCode", "description": "The possible error codes associated with making billing attempts. The error codes supplement the\n`error_message` to provide consistent results and help with dunning management.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PAYMENT_METHOD_NOT_FOUND", "description": "Payment method was not found.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_PROVIDER_IS_NOT_ENABLED", "description": "Payment provider is not enabled.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_PAYMENT_METHOD", "description": "Payment method is invalid. Please update or create a new payment method.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "UNEXPECTED_ERROR", "description": "There was an unexpected error during the billing attempt.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED_PAYMENT_METHOD", "description": "Payment method is expired.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_METHOD_DECLINED", "description": "Payment method was declined by processor.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTHENTICATION_ERROR", "description": "There was an error during the authentication.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "TEST_MODE", "description": "Gateway is in test mode and attempted to bill a live payment method.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "BUYER_CANCELED_PAYMENT_METHOD", "description": "Payment method was canceled by buyer.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_NOT_FOUND", "description": "Customer was not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_INVALID", "description": "Customer is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_SHIPPING_ADDRESS", "description": "The shipping address is either missing or invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CUSTOMER_BILLING_AGREEMENT", "description": "The billing agreement ID or the transaction ID for the customer's payment method is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVOICE_ALREADY_PAID", "description": "A payment has already been made for this invoice.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG", "description": "Payment method cannot be used with the current payment gateway test mode configuration.", "isDeprecated": false, "deprecationReason": null }, { "name": "AMOUNT_TOO_SMALL", "description": "The amount is too small.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ALLOCATIONS_NOT_FOUND", "description": "No inventory location found or enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "TRANSIENT_ERROR", "description": "Transient error, try again later.", "isDeprecated": false, "deprecationReason": null }, { "name": "INSUFFICIENT_FUNDS", "description": "Insufficient funds.", "isDeprecated": false, "deprecationReason": null }, { "name": "PURCHASE_TYPE_NOT_SUPPORTED", "description": "Purchase Type is not supported.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYPAL_ERROR_GENERAL", "description": "Paypal Error General.", "isDeprecated": false, "deprecationReason": null }, { "name": "CARD_NUMBER_INCORRECT", "description": "Card number was incorrect.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAUD_SUSPECTED", "description": "Fraud was suspected.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingAttemptInput", "description": "The input fields required to complete a subscription billing attempt.", "fields": null, "inputFields": [ { "name": "idempotencyKey", "description": "A unique key generated by the client to avoid duplicate payments. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "originTime", "description": "The date and time used to calculate fulfillment intervals for a billing attempt that\nsuccessfully completed after the current anchor date. To prevent fulfillment from being\npushed to the next anchor date, this field can override the billing attempt date.\n", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "billingCycleSelector", "description": "Select the specific billing cycle to be billed.\nDefault to bill the current billing cycle if not specified.\n", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleSelector", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingAttemptsSortKeys", "description": "The set of valid sort keys for the SubscriptionBillingAttempts query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "description": "A subscription billing cycle.", "fields": [ { "name": "billingAttemptExpectedDate", "description": "The date on which the billing attempt is expected to be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAttempts", "description": "The list of billing attempts associated with the billing cycle.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttemptConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cycleEndAt", "description": "The end date of the billing cycle.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cycleIndex", "description": "The index of the billing cycle.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cycleStartAt", "description": "The start date of the billing cycle.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "edited", "description": "Whether this billing cycle was edited.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "editedContract", "description": "The active edited contract for the billing cycle.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditedContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "skipped", "description": "Whether this billing cycle was skipped.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sourceContract", "description": "The subscription contract that the billing cycle belongs to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the billing cycle.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SubscriptionBillingCycleBillingCycleStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCycleBillingCycleStatus", "description": "The possible status values of a subscription billing cycle.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BILLED", "description": "The billing cycle is billed.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNBILLED", "description": "The billing cycle hasn't been billed.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleConnection", "description": "An auto-generated type for paginating through multiple SubscriptionBillingCycles.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionBillingCycleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractDraftCommitPayload", "description": "Return type for `subscriptionBillingCycleContractDraftCommit` mutation.", "fields": [ { "name": "contract", "description": "The committed Subscription Billing Cycle Edited Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditedContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractDraftConcatenatePayload", "description": "Return type for `subscriptionBillingCycleContractDraftConcatenate` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleContractEditPayload", "description": "Return type for `subscriptionBillingCycleContractEdit` mutation.", "fields": [ { "name": "draft", "description": "The draft subscription contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleEdge", "description": "An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionBillingCycleEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditDeletePayload", "description": "Return type for `subscriptionBillingCycleEditDelete` mutation.", "fields": [ { "name": "billingCycles", "description": "The list of updated billing cycles.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditedContract", "description": "Represents a subscription contract with billing cycles.", "fields": [ { "name": "app", "description": "The subscription app that the subscription contract is registered to.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appAdminUrl", "description": "The URL of the subscription contract page on the subscription app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingCycles", "description": "The billing cycles that the edited contract belongs to.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SubscriptionBillingCyclesSortKeys", "ofType": null }, "defaultValue": "CYCLE_INDEX" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the subscription contract was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The currency that's used for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of the custom attributes to be added to the generated orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer to whom the subscription contract belongs.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethod", "description": "The customer payment method that's used for the subscription contract.", "args": [ { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryMethod", "description": "The delivery method for each billing of the subscription contract.", "args": [], "type": { "kind": "UNION", "name": "SubscriptionDeliveryMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPrice", "description": "The delivery price for each billing of the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The list of subscription discounts associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `linesCount` instead." }, { "name": "lines", "description": "The list of subscription lines associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linesCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note field that will be applied to the generated orders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "A list of the subscription contract's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the subscription contract was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SubscriptionContractBase", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditsDeletePayload", "description": "Return type for `subscriptionBillingCycleEditsDelete` mutation.", "fields": [ { "name": "billingCycles", "description": "The list of updated billing cycles.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCycleErrorCode", "description": "Possible error codes that can be returned by `SubscriptionBillingCycleUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_NOT_FOUND", "description": "Can't find the billing cycle.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_CYCLE_EDITS", "description": "There's no contract or schedule edit associated with the targeted billing cycle(s).", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CYCLE_INDEX", "description": "The index selector is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_DATE", "description": "The date selector is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMPTY_BILLING_CYCLE_EDIT_SCHEDULE_INPUT", "description": "Billing cycle schedule edit input provided is empty. Must take in parameters to modify schedule.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_DATE_SET_ON_SKIPPED", "description": "Billing date cannot be set on skipped billing cycle.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUT_OF_BOUNDS", "description": "Billing date of a cycle cannot be set to a value outside of its billing date range.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_INDEX_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of index range.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_START_DATE_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of start date range.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCOMPLETE_BILLING_ATTEMPTS", "description": "Billing cycle has incomplete billing attempts in progress.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleInput", "description": "The input fields for specifying the subscription contract and selecting the associated billing cycle.\n", "fields": null, "inputFields": [ { "name": "contractId", "description": "The ID of the subscription contract associated with the billing cycle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "selector", "description": "Selects the billing cycle by date or index.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleSelector", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleScheduleEditInput", "description": "The input fields for parameters to modify the schedule of a specific billing cycle.", "fields": null, "inputFields": [ { "name": "skip", "description": "Sets the skip status for the billing cycle.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "billingDate", "description": "Sets the expected billing date for the billing cycle.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "reason", "description": "The reason for editing.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SubscriptionBillingCycleScheduleEditInputScheduleEditReason", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCycleScheduleEditInputScheduleEditReason", "description": "The input fields for possible reasons for editing the billing cycle's schedule.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BUYER_INITIATED", "description": "Buyer initiated the schedule edit.", "isDeprecated": false, "deprecationReason": null }, { "name": "MERCHANT_INITIATED", "description": "Merchant initiated the schedule edit.", "isDeprecated": false, "deprecationReason": null }, { "name": "DEV_INITIATED", "description": "Developer initiated the schedule edit.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleScheduleEditPayload", "description": "Return type for `subscriptionBillingCycleScheduleEdit` mutation.", "fields": [ { "name": "billingCycle", "description": "The updated billing cycle.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCycleSelector", "description": "The input fields to select SubscriptionBillingCycle by either date or index.", "fields": null, "inputFields": [ { "name": "index", "description": "Returns a billing cycle by index.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "date", "description": "Returns a billing cycle by date.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleSkipPayload", "description": "Return type for `subscriptionBillingCycleSkip` mutation.", "fields": [ { "name": "billingCycle", "description": "The updated billing cycle.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleSkipUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleSkipUserError", "description": "An error that occurs during the execution of `SubscriptionBillingCycleSkip`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionBillingCycleSkipUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCycleSkipUserErrorCode", "description": "Possible error codes that can be returned by `SubscriptionBillingCycleSkipUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleUnskipPayload", "description": "Return type for `subscriptionBillingCycleUnskip` mutation.", "fields": [ { "name": "billingCycle", "description": "The updated billing cycle.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleUnskipUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleUnskipUserError", "description": "An error that occurs during the execution of `SubscriptionBillingCycleUnskip`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionBillingCycleUnskipUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCycleUnskipUserErrorCode", "description": "Possible error codes that can be returned by `SubscriptionBillingCycleUnskipUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingCycleUserError", "description": "The possible errors for a subscription billing cycle.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionBillingCycleErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCyclesDateRangeSelector", "description": "The input fields to select a subset of subscription billing cycles within a date range.", "fields": null, "inputFields": [ { "name": "startDate", "description": "The start date and time for the range.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "endDate", "description": "The end date and time for the range.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingCyclesIndexRangeSelector", "description": "The input fields to select a subset of subscription billing cycles within an index range.", "fields": null, "inputFields": [ { "name": "startIndex", "description": "The start index for the range.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "endIndex", "description": "The end index for the range.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCyclesSortKeys", "description": "The set of valid sort keys for the SubscriptionBillingCycles query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CYCLE_INDEX", "description": "Sort by the `cycle_index` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionBillingCyclesTargetSelection", "description": "Select subscription billing cycles to be targeted.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALL", "description": "Target all current and upcoming subscription billing cycles.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionBillingPolicy", "description": "Represents a Subscription Billing Policy.", "fields": [ { "name": "anchors", "description": "Specific anchor dates upon which the billing interval calculations should be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanAnchor", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "intervalCount", "description": "The number of billing intervals between invoices.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maxCycles", "description": "Maximum amount of cycles after which the subscription ends.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minCycles", "description": "Minimum amount of cycles required in the subscription.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingPolicyInput", "description": "The input fields for a Subscription Billing Policy.", "fields": null, "inputFields": [ { "name": "interval", "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "defaultValue": null }, { "name": "intervalCount", "description": "The number of billing intervals between invoices.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "minCycles", "description": "Minimum amount of cycles required in the subscription.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "maxCycles", "description": "Maximum amount of cycles required in the subscription.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "anchors", "description": "Specific anchor dates upon which the billing interval calculations should be made.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContract", "description": "Represents a Subscription Contract.", "fields": [ { "name": "app", "description": "The subscription app that the subscription contract is registered to.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appAdminUrl", "description": "The URL of the subscription contract page on the subscription app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingAttempts", "description": "The list of billing attempts associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingAttemptConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingPolicy", "description": "The billing policy associated with the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time when the subscription contract was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The currency that's used for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of the custom attributes to be added to the generated orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer to whom the subscription contract belongs.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethod", "description": "The customer payment method that's used for the subscription contract.", "args": [ { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryMethod", "description": "The delivery method for each billing of the subscription contract.", "args": [], "type": { "kind": "UNION", "name": "SubscriptionDeliveryMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPolicy", "description": "The delivery policy associated with the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDeliveryPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPrice", "description": "The delivery price for each billing of the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The list of subscription discounts associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastPaymentStatus", "description": "The current status of the last payment.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionContractLastPaymentStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `linesCount` instead." }, { "name": "lines", "description": "The list of subscription lines associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linesCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "nextBillingDate", "description": "The next billing date for the subscription contract. This field is managed by the apps.\n Alternatively you can utilize our\n [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles),\n which provide auto-computed billing dates and additional functionalities.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note field that will be applied to the generated orders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "A list of the subscription contract's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originOrder", "description": "The order from which this contract originated.", "args": [], "type": { "kind": "OBJECT", "name": "Order", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "revisionId", "description": "The revision id of the contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current status of the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SubscriptionContractSubscriptionStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the subscription contract was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null }, { "kind": "INTERFACE", "name": "SubscriptionContractBase", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractActivatePayload", "description": "Return type for `subscriptionContractActivate` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionContractAtomicCreateInput", "description": "The input fields required to create a Subscription Contract.", "fields": null, "inputFields": [ { "name": "customerId", "description": "The ID of the customer to associate with the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "nextBillingDate", "description": "The next billing date for the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "currencyCode", "description": "The currency used for the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "defaultValue": null }, { "name": "contract", "description": "The attributes used as input for the Subscription Draft.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionDraftInput", "ofType": null } }, "defaultValue": null }, { "name": "lines", "description": "A list of new Subscription Lines.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionAtomicLineInput", "ofType": null } } } }, "defaultValue": null }, { "name": "discountCodes", "description": "A list of discount redeem codes to apply to the subscription contract.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractAtomicCreatePayload", "description": "Return type for `subscriptionContractAtomicCreate` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "SubscriptionContractBase", "description": "Represents subscription contract common fields.", "fields": [ { "name": "app", "description": "The subscription app that the subscription contract is registered to.", "args": [], "type": { "kind": "OBJECT", "name": "App", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "appAdminUrl", "description": "The URL of the subscription contract page on the subscription app.", "args": [], "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The currency that's used for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of the custom attributes to be added to the generated orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer to whom the subscription contract belongs.", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethod", "description": "The customer payment method that's used for the subscription contract.", "args": [ { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryMethod", "description": "The delivery method for each billing of the subscription contract.", "args": [], "type": { "kind": "UNION", "name": "SubscriptionDeliveryMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPrice", "description": "The delivery price for each billing of the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The list of subscription discounts associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `linesCount` instead." }, { "name": "lines", "description": "The list of subscription lines associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linesCount", "description": "The number of lines associated with the subscription contract.", "args": [], "type": { "kind": "OBJECT", "name": "Count", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note field that will be applied to the generated orders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": "A list of the subscription contract's orders.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the subscription contract was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionBillingCycleEditedContract", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null } ] }, { "kind": "OBJECT", "name": "SubscriptionContractCancelPayload", "description": "Return type for `subscriptionContractCancel` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractConnection", "description": "An auto-generated type for paginating through multiple SubscriptionContracts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionContractEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionContractCreateInput", "description": "The input fields required to create a Subscription Contract.", "fields": null, "inputFields": [ { "name": "customerId", "description": "The ID of the customer to associate with the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "nextBillingDate", "description": "The next billing date for the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "defaultValue": null }, { "name": "currencyCode", "description": "The currency used for the subscription contract.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "defaultValue": null }, { "name": "contract", "description": "The attributes used as input for the Subscription Draft.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionDraftInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractCreatePayload", "description": "Return type for `subscriptionContractCreate` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractEdge", "description": "An auto-generated type which holds one SubscriptionContract and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionContractEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionContractErrorCode", "description": "Possible error codes that can be returned by `SubscriptionContractUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractExpirePayload", "description": "Return type for `subscriptionContractExpire` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractFailPayload", "description": "Return type for `subscriptionContractFail` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionContractLastPaymentStatus", "description": "The possible status values of the last payment on a subscription contract.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUCCEEDED", "description": "Successful subscription billing attempt.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "Failed subscription billing attempt.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractPausePayload", "description": "Return type for `subscriptionContractPause` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionContractProductChangeInput", "description": "The input fields required to create a Subscription Contract.", "fields": null, "inputFields": [ { "name": "productVariantId", "description": "The ID of the product variant the subscription line refers to.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "currentPrice", "description": "The price of the product.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractProductChangePayload", "description": "Return type for `subscriptionContractProductChange` mutation.", "fields": [ { "name": "contract", "description": "The new Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineUpdated", "description": "The updated Subscription Line.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractSetNextBillingDatePayload", "description": "Return type for `subscriptionContractSetNextBillingDate` mutation.", "fields": [ { "name": "contract", "description": "The updated Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionContractUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionContractStatusUpdateErrorCode", "description": "Possible error codes that can be returned by `SubscriptionContractStatusUpdateUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONTRACT_TERMINATED", "description": "Subscription contract status cannot be changed once terminated.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractStatusUpdateUserError", "description": "Represents a subscription contract status update error.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionContractStatusUpdateErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionContractSubscriptionStatus", "description": "The possible status values of a subscription.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ACTIVE", "description": "The contract is active and continuing per its policies.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAUSED", "description": "The contract is temporarily paused and is expected to resume in the future.", "isDeprecated": false, "deprecationReason": null }, { "name": "CANCELLED", "description": "The contract was ended by an unplanned customer action.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXPIRED", "description": "The contract has ended per the expected circumstances. All billing and deliverycycles of the subscriptions were executed.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILED", "description": "The contract ended because billing failed and no further billing attempts are expected.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractUpdatePayload", "description": "Return type for `subscriptionContractUpdate` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionContractUserError", "description": "Represents a Subscription Contract error.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionContractErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionCyclePriceAdjustment", "description": "Represents a Subscription Line Pricing Cycle Adjustment.", "fields": [ { "name": "adjustmentType", "description": "Price adjustment type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "adjustmentValue", "description": "Price adjustment value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SellingPlanPricingPolicyAdjustmentValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "afterCycle", "description": "The number of cycles required before this pricing policy applies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "computedPrice", "description": "The computed price after the adjustments applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SubscriptionDeliveryMethod", "description": "Describes the delivery method to use to get the physical goods to the customer.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodLocalDelivery", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodPickup", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodShipping", "ofType": null } ] }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodInput", "description": "Specifies delivery method fields for a subscription draft.\nThis is an input union: one, and only one, field can be provided.\nThe field provided will determine which delivery method is to be used.\n", "fields": null, "inputFields": [ { "name": "shipping", "description": "The input fields for the shipping delivery method.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodShippingInput", "ofType": null }, "defaultValue": null }, { "name": "localDelivery", "description": "The input fields for the local delivery method.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryInput", "ofType": null }, "defaultValue": null }, { "name": "pickup", "description": "The input fields for the pickup delivery method.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodPickupInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodLocalDelivery", "description": "A subscription delivery method for local delivery.\nThe other subscription delivery methods can be found in the `SubscriptionDeliveryMethod` union type.\n", "fields": [ { "name": "address", "description": "The address to deliver to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionMailingAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "localDeliveryOption", "description": "The details of the local delivery method to use.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryInput", "description": "The input fields for a local delivery method.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", "fields": null, "inputFields": [ { "name": "address", "description": "The address to deliver to.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "localDeliveryOption", "description": "The details of the local delivery method to use.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryOptionInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryOption", "description": "The selected delivery option on a subscription contract.", "fields": [ { "name": "code", "description": "A custom reference to the delivery method for use with automations.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The details displayed to the customer to describe the local delivery option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "instructions", "description": "The delivery instructions that the customer can provide to the merchant.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "The phone number that the customer provided to the merchant.\nFormatted using E.164 standard. For example, `+16135551111`.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the local delivery option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the local delivery option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodLocalDeliveryOptionInput", "description": "The input fields for local delivery option.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the local delivery option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "presentmentTitle", "description": "The presentment title of the local delivery option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "The details displayed to the customer to describe the local delivery option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "A custom reference to the delivery method for use with automations.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "The phone number that the customer must provide to the merchant.\nFormatted using E.164 standard. For example, `+16135551111`.\n", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "instructions", "description": "The delivery instructions that the customer can provide to the merchant.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodPickup", "description": "A delivery method with a pickup option.", "fields": [ { "name": "pickupOption", "description": "The details of the pickup delivery method to use.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodPickupOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodPickupInput", "description": "The input fields for a pickup delivery method.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", "fields": null, "inputFields": [ { "name": "pickupOption", "description": "The details of the pickup method to use.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodPickupOptionInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodPickupOption", "description": "Represents the selected pickup option on a subscription contract.", "fields": [ { "name": "code", "description": "A custom reference to the delivery method for use with automations.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The details displayed to the customer to describe the pickup option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The location where the customer will pickup the merchandise.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the pickup option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the pickup option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodPickupOptionInput", "description": "The input fields for pickup option.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the pickup option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "presentmentTitle", "description": "The presentment title of the pickup option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "The details displayed to the customer to describe the pickup option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "A custom reference to the delivery method for use with automations.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "locationId", "description": "The ID of the pickup location.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodShipping", "description": "Represents a shipping delivery method: a mailing address and a shipping option.", "fields": [ { "name": "address", "description": "The address to ship to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionMailingAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingOption", "description": "The details of the shipping method to use.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodShippingOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodShippingInput", "description": "Specifies shipping delivery method fields.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", "fields": null, "inputFields": [ { "name": "address", "description": "The address to ship to.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null }, { "name": "shippingOption", "description": "The details of the shipping method to use.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodShippingOptionInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryMethodShippingOption", "description": "Represents the selected shipping option on a subscription contract.", "fields": [ { "name": "carrierService", "description": "The carrier service that's providing this shipping option.\nThis field isn't currently supported and returns null.\n", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null }, "isDeprecated": true, "deprecationReason": "This field has never been implemented." }, { "name": "code", "description": "The code of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodShippingOptionInput", "description": "The input fields for shipping option.", "fields": null, "inputFields": [ { "name": "title", "description": "The title of the shipping option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "presentmentTitle", "description": "The presentment title of the shipping option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "The description of the shipping option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "The code of the shipping option.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "carrierServiceId", "description": "The carrier service ID of the shipping option.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SubscriptionDeliveryOption", "description": "The delivery option for a subscription contract.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionLocalDeliveryOption", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionPickupOption", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionShippingOption", "ofType": null } ] }, { "kind": "UNION", "name": "SubscriptionDeliveryOptionResult", "description": "The result of the query to fetch delivery options for the subscription contract.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionDeliveryOptionResultFailure", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryOptionResultSuccess", "ofType": null } ] }, { "kind": "OBJECT", "name": "SubscriptionDeliveryOptionResultFailure", "description": "A failure to find the available delivery options for a subscription contract.", "fields": [ { "name": "message", "description": "The reason for the failure.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryOptionResultSuccess", "description": "The delivery option for a subscription contract.", "fields": [ { "name": "deliveryOptions", "description": "The available delivery options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SubscriptionDeliveryOption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDeliveryPolicy", "description": "Represents a Subscription Delivery Policy.", "fields": [ { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SellingPlanAnchor", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interval", "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "intervalCount", "description": "The number of delivery intervals between deliveries.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryPolicyInput", "description": "The input fields for a Subscription Delivery Policy.", "fields": null, "inputFields": [ { "name": "interval", "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanInterval", "ofType": null } }, "defaultValue": null }, { "name": "intervalCount", "description": "The number of billing intervals between invoices.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "anchors", "description": "The specific anchor dates upon which the delivery interval calculations should be made.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanAnchorInput", "ofType": null } } }, "defaultValue": "[]" } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SubscriptionDiscount", "description": "Subscription draft discount types.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionAppliedCodeDiscount", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null } ] }, { "kind": "OBJECT", "name": "SubscriptionDiscountAllocation", "description": "Represents what a particular discount reduces from a line price.", "fields": [ { "name": "amount", "description": "Allocation amount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discount", "description": "Discount that created the allocation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SubscriptionDiscount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountConnection", "description": "An auto-generated type for paginating through multiple SubscriptionDiscounts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionDiscountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SubscriptionDiscount", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountEdge", "description": "An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionDiscountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SubscriptionDiscount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountEntitledLines", "description": "Represents the subscription lines the discount applies on.", "fields": [ { "name": "all", "description": "Specify whether the subscription discount will apply on all subscription lines.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lines", "description": "The list of subscription lines associated with the subscription discount.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountFixedAmountValue", "description": "The value of the discount and how it will be applied.", "fields": [ { "name": "amount", "description": "The fixed amount value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "appliesOnEachItem", "description": "Whether the amount is applied per item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountPercentageValue", "description": "The percentage value of the discount.", "fields": [ { "name": "percentage", "description": "The percentage value of the discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionDiscountRejectionReason", "description": "The reason a discount on a subscription draft was rejected.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "Discount code is not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_ENTITLED_LINE_ITEMS", "description": "Discount does not apply to any of the given line items.", "isDeprecated": false, "deprecationReason": null }, { "name": "QUANTITY_NOT_IN_RANGE", "description": "Quantity of items does not qualify for the discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "PURCHASE_NOT_IN_RANGE", "description": "Purchase amount of items does not qualify for the discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_NOT_ELIGIBLE", "description": "Given customer does not qualify for the discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "USAGE_LIMIT_REACHED", "description": "Discount usage limit has been reached.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_USAGE_LIMIT_REACHED", "description": "Customer usage limit has been reached.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENTLY_INACTIVE", "description": "Discount is inactive.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_ENTITLED_SHIPPING_LINES", "description": "No applicable shipping lines.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCOMPATIBLE_PURCHASE_TYPE", "description": "Purchase type does not qualify for the discount.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERNAL_ERROR", "description": "Internal error during discount code validation.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "UNION", "name": "SubscriptionDiscountValue", "description": "The value of the discount and how it will be applied.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionDiscountFixedAmountValue", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionDiscountPercentageValue", "ofType": null } ] }, { "kind": "OBJECT", "name": "SubscriptionDraft", "description": "Represents a Subscription Draft.", "fields": [ { "name": "billingCycle", "description": "The billing cycle that the subscription contract will be associated with.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionBillingCycle", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "billingPolicy", "description": "The billing policy for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "concatenatedBillingCycles", "description": "The billing cycles of the contracts that will be concatenated to the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "SubscriptionBillingCyclesSortKeys", "ofType": null }, "defaultValue": "CYCLE_INDEX" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionBillingCycleConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "currencyCode", "description": "The currency used for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CurrencyCode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "A list of the custom attributes to be added to the generated orders.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer to whom the subscription contract belongs.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerPaymentMethod", "description": "The customer payment method used for the subscription contract.", "args": [ { "name": "showRevoked", "description": "Whether to show the customer's revoked payment method.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "OBJECT", "name": "CustomerPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryMethod", "description": "The delivery method for each billing of the subscription contract.", "args": [], "type": { "kind": "UNION", "name": "SubscriptionDeliveryMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryOptions", "description": "The available delivery options for a given delivery address. Returns `null` for pending requests.\n", "args": [ { "name": "deliveryAddress", "description": "The address to deliver the subscription contract to.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "UNION", "name": "SubscriptionDeliveryOptionResult", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPolicy", "description": "The delivery policy for the subscription contract.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDeliveryPolicy", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deliveryPrice", "description": "The delivery price for each billing the subscription contract.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The list of subscription discounts which will be associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountsAdded", "description": "The list of subscription discounts to be added to the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountsRemoved", "description": "The list of subscription discounts to be removed from the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountsUpdated", "description": "The list of subscription discounts to be updated on the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lines", "description": "The list of subscription lines which will be associated with the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linesAdded", "description": "The list of subscription lines to be added to the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "linesRemoved", "description": "The list of subscription lines to be removed from the subscription contract.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nextBillingDate", "description": "The next billing date for the subscription contract.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "note", "description": "The note field that will be applied to the generated orders.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalContract", "description": "The original subscription contract.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shippingOptions", "description": "Available Shipping Options for a given delivery address. Returns NULL for pending requests.\n", "args": [ { "name": "deliveryAddress", "description": "The address to delivery the subscription contract to.", "type": { "kind": "INPUT_OBJECT", "name": "MailingAddressInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "UNION", "name": "SubscriptionShippingOptionResult", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `deliveryOptions` instead." }, { "name": "status", "description": "The current status of the subscription contract.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionContractSubscriptionStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftCommitPayload", "description": "Return type for `subscriptionDraftCommit` mutation.", "fields": [ { "name": "contract", "description": "The updated Subscription Contract object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionContract", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftDiscountAddPayload", "description": "Return type for `subscriptionDraftDiscountAdd` mutation.", "fields": [ { "name": "discountAdded", "description": "The added Subscription Discount.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftDiscountCodeApplyPayload", "description": "Return type for `subscriptionDraftDiscountCodeApply` mutation.", "fields": [ { "name": "appliedDiscount", "description": "The added subscription discount.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionAppliedCodeDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The subscription contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftDiscountRemovePayload", "description": "Return type for `subscriptionDraftDiscountRemove` mutation.", "fields": [ { "name": "discountRemoved", "description": "The removed subscription draft discount.", "args": [], "type": { "kind": "UNION", "name": "SubscriptionDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The subscription contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftDiscountUpdatePayload", "description": "Return type for `subscriptionDraftDiscountUpdate` mutation.", "fields": [ { "name": "discountUpdated", "description": "The updated Subscription Discount.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionDraftErrorCode", "description": "Possible error codes that can be returned by `SubscriptionDraftUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ALREADY_REMOVED", "description": "This line has already been removed.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENCE", "description": "Input value is not present.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMMITTED", "description": "Subscription draft has been already committed.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_IN_RANGE", "description": "Value is not in range.", "isDeprecated": false, "deprecationReason": null }, { "name": "NOT_AN_INTEGER", "description": "The value is not an integer.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES", "description": "The maximum number of cycles must be greater than the minimum.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_MUST_BE_MULTIPLE_OF_BILLING", "description": "The delivery policy interval must be a multiple of the billing policy interval.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_BILLING_DATE", "description": "Next billing date is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_NOTE_LENGTH", "description": "Note length is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LINES", "description": "Must have at least one line.", "isDeprecated": false, "deprecationReason": null }, { "name": "NO_ENTITLED_LINES", "description": "Discount must have at least one entitled line.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_DOES_NOT_EXIST", "description": "The customer doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_MISMATCH", "description": "The payment method customer must be the same as the contract customer.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_METHOD_REQUIRED", "description": "The delivery method can't be blank if any lines require shipping.", "isDeprecated": false, "deprecationReason": null }, { "name": "MISSING_LOCAL_DELIVERY_OPTIONS", "description": "The local delivery options must be set for local delivery.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_DISCOUNTS_UNIQUE_AFTER_CYCLE", "description": "The after cycle attribute must be unique between cycle discounts.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ADJUSTMENT_TYPE", "description": "The adjustment value must the same type as the adjustment type.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_ADJUSTMENT_VALUE", "description": "The adjustment value must be either fixed_value or percentage.", "isDeprecated": false, "deprecationReason": null }, { "name": "STALE_CONTRACT", "description": "Another operation updated the contract concurrently as the commit was in progress.", "isDeprecated": false, "deprecationReason": null }, { "name": "CURRENCY_NOT_ENABLED", "description": "Currency is not enabled.", "isDeprecated": false, "deprecationReason": null }, { "name": "HAS_FUTURE_EDITS", "description": "Cannot update a subscription contract with a current or upcoming billing cycle contract edit.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_CYCLE_PRESENT", "description": "Cannot commit a billing cycle contract draft with this mutation. Please use SubscriptionBillingCycleContractDraftCommit.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_CYCLE_ABSENT", "description": "Cannot commit a contract draft with this mutation. Please use SubscriptionDraftCommit.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_CYCLE_CONTRACT_DRAFT_DELIVERY_POLICY_INVALID", "description": "Delivery policy cannot be updated for billing cycle contract drafts.", "isDeprecated": false, "deprecationReason": null }, { "name": "BILLING_CYCLE_CONTRACT_DRAFT_BILLING_POLICY_INVALID", "description": "Billing policy cannot be updated for billing cycle contract drafts.", "isDeprecated": false, "deprecationReason": null }, { "name": "CONCATENATION_BILLING_CYCLE_CONTRACT_DRAFT_REQUIRED", "description": "Contract draft must be a billing cycle contract draft for contract concatenation.", "isDeprecated": false, "deprecationReason": null }, { "name": "DUPLICATE_CONCATENATED_CONTRACTS", "description": "Concatenated contracts cannot contain duplicate subscription contracts.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_INDEX_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of index range.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_START_DATE_OUT_OF_RANGE", "description": "Billing cycle selector cannot select billing cycle outside of start date range.", "isDeprecated": false, "deprecationReason": null }, { "name": "CYCLE_SELECTOR_VALIDATE_ONE_OF", "description": "Billing cycle selector requires exactly one of index or date to be provided.", "isDeprecated": false, "deprecationReason": null }, { "name": "EXCEEDED_MAX_CONCATENATED_CONTRACTS", "description": "Maximum number of concatenated contracts on a billing cycle contract draft exceeded.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_REDACTED", "description": "Customer is scheduled for redaction or has been redacted.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN", "description": "The input value should be greater than the minimum allowed value.", "isDeprecated": false, "deprecationReason": null }, { "name": "GREATER_THAN_OR_EQUAL_TO", "description": "The input value should be greater than or equal to the minimum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN", "description": "The input value should be less than the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "LESS_THAN_OR_EQUAL_TO", "description": "The input value should be less than or equal to the maximum value allowed.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftFreeShippingDiscountAddPayload", "description": "Return type for `subscriptionDraftFreeShippingDiscountAdd` mutation.", "fields": [ { "name": "discountAdded", "description": "The added subscription free shipping discount.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The subscription contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftFreeShippingDiscountUpdatePayload", "description": "Return type for `subscriptionDraftFreeShippingDiscountUpdate` mutation.", "fields": [ { "name": "discountUpdated", "description": "The updated Subscription Discount.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionDraftInput", "description": "The input fields required to create a Subscription Draft.", "fields": null, "inputFields": [ { "name": "status", "description": "The current status of the subscription contract.", "type": { "kind": "ENUM", "name": "SubscriptionContractSubscriptionStatus", "ofType": null }, "defaultValue": null }, { "name": "paymentMethodId", "description": "The ID of the payment method to be used for the subscription contract.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "nextBillingDate", "description": "The next billing date for the subscription contract.", "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "defaultValue": null }, { "name": "billingPolicy", "description": "The billing policy for the subscription contract.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionBillingPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "deliveryPolicy", "description": "The delivery policy for the subscription contract.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryPolicyInput", "ofType": null }, "defaultValue": null }, { "name": "deliveryPrice", "description": "The shipping price for each renewal the subscription contract.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "deliveryMethod", "description": "The delivery method for the subscription contract.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionDeliveryMethodInput", "ofType": null }, "defaultValue": null }, { "name": "note", "description": "The note field that will be applied to the generated orders.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "customAttributes", "description": "A list of the custom attributes added to the subscription contract.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftLineAddPayload", "description": "Return type for `subscriptionDraftLineAdd` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineAdded", "description": "The added Subscription Line.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftLineRemovePayload", "description": "Return type for `subscriptionDraftLineRemove` mutation.", "fields": [ { "name": "discountsUpdated", "description": "The list of updated subscription discounts impacted by the removed line.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineRemoved", "description": "The removed Subscription Line.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftLineUpdatePayload", "description": "Return type for `subscriptionDraftLineUpdate` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Contract draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineUpdated", "description": "The updated Subscription Line.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftUpdatePayload", "description": "Return type for `subscriptionDraftUpdate` mutation.", "fields": [ { "name": "draft", "description": "The Subscription Draft object.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionDraft", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionDraftUserError", "description": "Represents a Subscription Draft error.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionDraftErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionFreeShippingDiscountInput", "description": "The input fields for a subscription free shipping discount on a contract.", "fields": null, "inputFields": [ { "name": "title", "description": "The title associated with the subscription free shipping discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The maximum number of times the subscription free shipping discount will be applied on orders.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionLine", "description": "Represents a Subscription Line.", "fields": [ { "name": "currentPrice", "description": "The price per unit for the subscription line in the contract's currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributes", "description": "List of custom attributes associated to the line item.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountAllocations", "description": "Discount allocations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountAllocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineDiscountedPrice", "description": "Total line price including all discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pricingPolicy", "description": "Describe the price changes of the line over time.", "args": [], "type": { "kind": "OBJECT", "name": "SubscriptionPricingPolicy", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productId", "description": "The product ID associated with the subscription line.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the unit selected for the subscription line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiresShipping", "description": "Whether physical shipping is required for the variant.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanId", "description": "The selling plan ID associated to the line.\n\nIndicates which selling plan was used to create this\ncontract line initially. The selling plan ID is also used to\nfind the associated delivery profile.\n\nThe subscription contract, subscription line, or selling plan might have\nchanged. As a result, the selling plan's attributes might not\nmatch the information on the contract.\n", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sellingPlanName", "description": "The selling plan name associated to the line. This name describes\nthe order line items created from this subscription line\nfor both merchants and customers.\n\nThe value can be different from the selling plan's name, because both\nthe selling plan's name and the subscription line's selling_plan_name\nattribute can be updated independently.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "Variant SKU number of the item associated with the subscription line.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxable", "description": "Whether the variant is taxable.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "Product title of the item associated with the subscription line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantId", "description": "The product variant ID associated with the subscription line.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantImage", "description": "The image associated with the line item's variant or product.", "args": [], "type": { "kind": "OBJECT", "name": "Image", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variantTitle", "description": "Product variant title of the item associated with the subscription line.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionLineConnection", "description": "An auto-generated type for paginating through multiple SubscriptionLines.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLineEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionLineEdge", "description": "An auto-generated type which holds one SubscriptionLine and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionLineEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionLine", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionLineInput", "description": "The input fields required to add a new subscription line to a contract.", "fields": null, "inputFields": [ { "name": "productVariantId", "description": "The ID of the product variant the subscription line refers to.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "currentPrice", "description": "The price of the product.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "defaultValue": null }, { "name": "customAttributes", "description": "The custom attributes for this subscription line.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null }, { "name": "sellingPlanId", "description": "The selling plan for the subscription line.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "sellingPlanName", "description": "The selling plan name for the subscription line.\n\nDefaults to using the selling plan's current name when not specified.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pricingPolicy", "description": "Describes expected price changes of the subscription line over time.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionPricingPolicyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionLineUpdateInput", "description": "The input fields required to update a subscription line on a contract.", "fields": null, "inputFields": [ { "name": "productVariantId", "description": "The ID of the product variant the subscription line refers to.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "The quantity of the product.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "sellingPlanId", "description": "The selling plan for the subscription line.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "sellingPlanName", "description": "The selling plan name for the subscription line.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "currentPrice", "description": "The price of the product.", "type": { "kind": "SCALAR", "name": "Decimal", "ofType": null }, "defaultValue": null }, { "name": "customAttributes", "description": "The custom attributes for this subscription line.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } }, "defaultValue": null }, { "name": "pricingPolicy", "description": "Describes expected price changes of the subscription line over time.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionPricingPolicyInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionLocalDeliveryOption", "description": "A local delivery option for a subscription contract.", "fields": [ { "name": "code", "description": "The code of the local delivery option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the local delivery option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneRequired", "description": "Whether a phone number is required for the local delivery option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the local delivery option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the local delivery option.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the local delivery option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionMailingAddress", "description": "Represents a Mailing Address on a Subscription.", "fields": [ { "name": "address1", "description": "The first line of the address. Typically the street address or PO Box number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "address2", "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": "The name of the city, district, village, or town.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The name of the customer's company or organization.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The name of the country.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countryCode", "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", "args": [], "type": { "kind": "ENUM", "name": "CountryCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstName", "description": "The first name of the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastName", "description": "The last name of the customer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The full name of the customer, based on firstName and lastName.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": "A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "province", "description": "The region of the address, such as the province, state, or district.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "provinceCode", "description": "The two-letter code for the region.\n\nFor example, ON.\n", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "zip", "description": "The zip or postal code of the address.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "description": "Custom subscription discount.", "fields": [ { "name": "entitledLines", "description": "Entitled line items used to apply the subscription discount on.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionDiscountEntitledLines", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recurringCycleLimit", "description": "The maximum number of times the subscription discount will be applied on orders.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rejectionReason", "description": "The reason that the discount on the subscription draft is rejected.", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionDiscountRejectionReason", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "targetType", "description": "Type of line the discount applies on.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountTargetType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title associated with the subscription discount.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The type of the subscription discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "DiscountType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "usageCount", "description": "The number of times the discount was applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the subscription discount.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "SubscriptionDiscountValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionManualDiscountConnection", "description": "An auto-generated type for paginating through multiple SubscriptionManualDiscounts.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscountEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in SubscriptionManualDiscountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionManualDiscountEdge", "description": "An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of SubscriptionManualDiscountEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionManualDiscount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountEntitledLinesInput", "description": "The input fields for the subscription lines the discount applies on.", "fields": null, "inputFields": [ { "name": "all", "description": "Specify whether the subscription discount will apply on all subscription lines.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "lines", "description": "The ID of the lines to add to or remove from the subscription discount.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountLinesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountFixedAmountInput", "description": "The input fields for the fixed amount value of the discount and distribution on the lines.", "fields": null, "inputFields": [ { "name": "amount", "description": "Fixed amount value.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "appliesOnEachItem", "description": "Whether the amount is intended per line item or once per subscription.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountInput", "description": "The input fields for a subscription discount on a contract.", "fields": null, "inputFields": [ { "name": "title", "description": "The title associated with the subscription discount.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "value", "description": "Percentage or fixed amount value of the discount.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountValueInput", "ofType": null }, "defaultValue": null }, { "name": "recurringCycleLimit", "description": "The maximum number of times the subscription discount will be applied on orders.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "entitledLines", "description": "Entitled line items used to apply the subscription discount on.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountEntitledLinesInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountLinesInput", "description": "The input fields for line items that the discount refers to.", "fields": null, "inputFields": [ { "name": "add", "description": "The ID of the lines to add to the subscription discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "remove", "description": "The ID of the lines to remove from the subscription discount.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountValueInput", "description": "The input fields for the discount value and its distribution.", "fields": null, "inputFields": [ { "name": "percentage", "description": "The percentage value of the discount. Value must be between 0 - 100.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "fixedAmount", "description": "Fixed amount input in the currency defined by the subscription.", "type": { "kind": "INPUT_OBJECT", "name": "SubscriptionManualDiscountFixedAmountInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionPickupOption", "description": "A pickup option to deliver a subscription contract.", "fields": [ { "name": "code", "description": "The code of the pickup option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the pickup option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "location", "description": "The pickup location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Location", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneRequired", "description": "Whether a phone number is required for the pickup option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pickupTime", "description": "The estimated amount of time it takes for the pickup to be ready. For example, \"Usually ready in 24 hours\".).", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the pickup option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the pickup option.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the pickup option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionPricingPolicy", "description": "Represents a Subscription Line Pricing Policy.", "fields": [ { "name": "basePrice", "description": "The base price per unit for the subscription line in the contract's currency.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cycleDiscounts", "description": "The adjustments per cycle for the subscription line.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionCyclePriceAdjustment", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionPricingPolicyCycleDiscountsInput", "description": "The input fields for an array containing all pricing changes for each billing cycle.", "fields": null, "inputFields": [ { "name": "afterCycle", "description": "The cycle after which the pricing policy applies.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "adjustmentType", "description": "The price adjustment type.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SellingPlanPricingPolicyAdjustmentType", "ofType": null } }, "defaultValue": null }, { "name": "adjustmentValue", "description": "The price adjustment value.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SellingPlanPricingPolicyValueInput", "ofType": null } }, "defaultValue": null }, { "name": "computedPrice", "description": "The computed price after the adjustments are applied.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SubscriptionPricingPolicyInput", "description": "The input fields for expected price changes of the subscription line over time.", "fields": null, "inputFields": [ { "name": "basePrice", "description": "The base price per unit for the subscription line in the contract's currency.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "defaultValue": null }, { "name": "cycleDiscounts", "description": "An array containing all pricing changes for each billing cycle.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SubscriptionPricingPolicyCycleDiscountsInput", "ofType": null } } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionShippingOption", "description": "A shipping option to deliver a subscription contract.", "fields": [ { "name": "carrierService", "description": "The carrier service that's providing this shipping option.\nThis field isn't currently supported and returns null.\n", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryCarrierService", "ofType": null }, "isDeprecated": true, "deprecationReason": "This field has never been implemented." }, { "name": "code", "description": "The code of the shipping option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phoneRequired", "description": "If a phone number is required for the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "presentmentTitle", "description": "The presentment title of the shipping option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the shipping option.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The title of the shipping option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "SubscriptionShippingOptionResult", "description": "The result of the query to fetch shipping options for the subscription contract.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SubscriptionShippingOptionResultFailure", "ofType": null }, { "kind": "OBJECT", "name": "SubscriptionShippingOptionResultSuccess", "ofType": null } ] }, { "kind": "OBJECT", "name": "SubscriptionShippingOptionResultFailure", "description": "Failure determining available shipping options for delivery of a subscription contract.", "fields": [ { "name": "message", "description": "Failure reason.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscriptionShippingOptionResultSuccess", "description": "A shipping option for delivery of a subscription contract.", "fields": [ { "name": "shippingOptions", "description": "Available shipping options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SubscriptionShippingOption", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SuggestedOrderTransaction", "description": "A suggested transaction. Suggested transaction are usually used in the context of refunds\nand exchanges.\n", "fields": [ { "name": "accountNumber", "description": "The masked account number associated with the payment method.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "amount", "description": "The amount of the transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountSet` instead." }, { "name": "amountSet", "description": "The amount and currency of the suggested order transaction in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "formattedGateway", "description": "The human-readable payment gateway name suggested to process the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gateway", "description": "The suggested payment gateway used to process the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "kind", "description": "Specifies the kind of the suggested order transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SuggestedOrderTransactionKind", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumRefundable", "description": "Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.", "args": [], "type": { "kind": "SCALAR", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `maximumRefundableSet` instead." }, { "name": "maximumRefundableSet", "description": "Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.", "args": [], "type": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "parentTransaction", "description": "The associated parent transaction, for example the authorization of a capture.", "args": [], "type": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentDetails", "description": "The associated payment details related to the transaction.", "args": [], "type": { "kind": "UNION", "name": "PaymentDetails", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SuggestedOrderTransactionKind", "description": "Specifies the kind of the suggested order transaction.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUGGESTED_REFUND", "description": "A suggested refund transaction for an order.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "SuggestedRefund", "description": "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.", "fields": [ { "name": "amount", "description": "The total monetary value to be refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `amountSet` instead." }, { "name": "amountSet", "description": "The total monetary value to be refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedSubtotalSet", "description": "The sum of all the discounted prices of the line items being refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumRefundable", "description": "The total monetary value available to refund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `maximumRefundableSet` instead." }, { "name": "maximumRefundableSet", "description": "The total monetary value available to refund in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundDuties", "description": "A list of duties to be refunded from the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundDuty", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundLineItems", "description": "A list of line items to be refunded, along with restock instructions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundLineItem", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping", "description": "The shipping costs to be refunded from the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingRefund", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The sum of all the prices of the line items being refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `subtotalSet` instead." }, { "name": "subtotalSet", "description": "The sum of all the prices of the line items being refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suggestedTransactions", "description": "A list of suggested order transactions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SuggestedOrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCartDiscountAmountSet", "description": "The total cart discount amount that was applied to all line items in this refund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDutiesSet", "description": "The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxSet", "description": "The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxes", "description": "The sum of the taxes being refunded from the order. The value must be positive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `totalTaxSet` instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SuggestedReturnRefund", "description": "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.", "fields": [ { "name": "amount", "description": "The total monetary value to be refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discountedSubtotal", "description": "The sum of all the discounted prices of the line items being refunded.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximumRefundable", "description": "The total monetary value available to refund in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "refundDuties", "description": "A list of duties to be refunded from the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "RefundDuty", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping", "description": "The shipping costs to be refunded from the order.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingRefund", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The sum of all the prices of the line items being refunded in shop and presentment currencies.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suggestedTransactions", "description": "A list of suggested order transactions.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SuggestedOrderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalCartDiscountAmount", "description": "The total cart discount amount that was applied to all line items in this refund.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDuties", "description": "The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTax", "description": "The sum of the taxes being refunded in shop and presentment currencies. The value must be positive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TableData", "description": "The result in a tabular format with schema information and formatted and unformatted row data.", "fields": [ { "name": "columns", "description": "The data table columns.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TableDataColumn", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rowData", "description": "The formatted data values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "unformattedData", "description": "The unformatted data values.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "JSON", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TableDataColumn", "description": "A nested array representation of the data. An index in an array represents a row number.", "fields": [ { "name": "comparedTo", "description": "For comparison columns, indicates the column to compare to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "dataType", "description": "The data type of the column value.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "displayName", "description": "The display name of the column in the data model.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the column in the data model.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TableResponse", "description": "The default table response structure for a ShopifyQL query.", "fields": [ { "name": "parseErrors", "description": "A list of parse errors, if parsing fails.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ParseError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tableData", "description": "The result in a tabular format with schema and row data.", "args": [], "type": { "kind": "OBJECT", "name": "TableData", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShopifyqlResponse", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TagsAddPayload", "description": "Return type for `tagsAdd` mutation.", "fields": [ { "name": "node", "description": "The object that was updated.", "args": [], "type": { "kind": "INTERFACE", "name": "Node", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TagsRemovePayload", "description": "Return type for `tagsRemove` mutation.", "fields": [ { "name": "node", "description": "The object that was updated.", "args": [], "type": { "kind": "INTERFACE", "name": "Node", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxAppConfiguration", "description": "Tax app configuration of a merchant.", "fields": [ { "name": "state", "description": "State of the tax app configuration.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "TaxPartnerState", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxAppConfigurePayload", "description": "Return type for `taxAppConfigure` mutation.", "fields": [ { "name": "taxAppConfiguration", "description": "The updated tax app configuration.", "args": [], "type": { "kind": "OBJECT", "name": "TaxAppConfiguration", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxAppConfigureUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxAppConfigureUserError", "description": "An error that occurs during the execution of `TaxAppConfigure`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "TaxAppConfigureUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "TaxAppConfigureUserErrorCode", "description": "Possible error codes that can be returned by `TaxAppConfigureUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TAX_PARTNER_NOT_FOUND", "description": "Unable to find the tax partner record.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_PARTNER_STATE_UPDATE_FAILED", "description": "Unable to update tax partner state.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_PARTNER_ALREADY_ACTIVE", "description": "Unable to update already active tax partner.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "TaxExemption", "description": "Available customer tax exemptions.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CA_STATUS_CARD_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_BC_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_MB_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_DIPLOMAT_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_BC_COMMERCIAL_FISHERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_MB_COMMERCIAL_FISHERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_NS_COMMERCIAL_FISHERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_PE_COMMERCIAL_FISHERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_COMMERCIAL_FISHERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_BC_SUB_CONTRACTOR_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_SUB_CONTRACTOR_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_BC_CONTRACTOR_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_CONTRACTOR_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_ON_PURCHASE_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_MB_FARMER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_NS_FARMER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia.", "isDeprecated": false, "deprecationReason": null }, { "name": "CA_SK_FARMER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan.", "isDeprecated": false, "deprecationReason": null }, { "name": "EU_REVERSE_CHARGE_EXEMPTION_RULE", "description": "This customer is exempt from VAT for purchases within the EU that is shipping from outside of customer's country.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_AL_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alabama.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_AK_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alaska.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_AZ_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arizona.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_AR_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arkansas.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_CA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in California.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_CO_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Colorado.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_CT_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Connecticut.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_DE_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Delaware.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_FL_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Florida.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_GA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Georgia.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_HI_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Hawaii.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_ID_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Idaho.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_IL_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Illinois.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_IN_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Indiana.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_IA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Iowa.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_KS_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kansas.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_KY_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kentucky.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_LA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Louisiana.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_ME_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maine.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MD_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maryland.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Massachusetts.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MI_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Michigan.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MN_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Minnesota.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MS_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Mississippi.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MO_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Missouri.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_MT_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Montana.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NE_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nebraska.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NV_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nevada.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NH_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Hampshire.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NJ_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Jersey.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NM_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Mexico.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NY_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New York.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_NC_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Carolina.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_ND_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Dakota.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_OH_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Ohio.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_OK_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oklahoma.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_OR_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oregon.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_PA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Pennsylvania.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_RI_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Rhode Island.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_SC_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Carolina.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_SD_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Dakota.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_TN_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Tennessee.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_TX_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Texas.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_UT_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Utah.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_VT_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Vermont.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_VA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Virginia.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_WA_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_WV_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in West Virginia.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_WI_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wisconsin.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_WY_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wyoming.", "isDeprecated": false, "deprecationReason": null }, { "name": "US_DC_RESELLER_EXEMPTION", "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington DC.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxLine", "description": "Represents a single tax applied to the associated line item.", "fields": [ { "name": "channelLiable", "description": "Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The amount of tax, in shop currency, after discounts and before returns.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Money", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `priceSet` instead." }, { "name": "priceSet", "description": "The amount of tax, in shop and presentment currencies, after discounts and before returns.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rate", "description": "The proportion of the line item price that the tax represents as a decimal.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ratePercentage", "description": "The proportion of the line item price that the tax represents as a percentage.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The name of the tax.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "TaxPartnerState", "description": "State of the tax app configuration.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "App is not configured.", "isDeprecated": false, "deprecationReason": null }, { "name": "READY", "description": "App is configured, but not used for tax calculations.", "isDeprecated": false, "deprecationReason": null }, { "name": "ACTIVE", "description": "App is configured and to be used for tax calculations.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Taxonomy", "description": "The Taxonomy resource lets you access the categories, attributes and values of a taxonomy tree.", "fields": [ { "name": "categories", "description": "Returns the categories of the product taxonomy based on the arguments provided.\nIf a `search` argument is provided, then all categories that match the search query globally are returned.\nIf a `children_of` argument is provided, then all children of the specified category are returned.\nIf a `siblings_of` argument is provided, then all siblings of the specified category are returned.\nIf a `decendents_of` argument is provided, then all descendents of the specified category are returned.\nIf no arguments are provided, then all the top-level categories of the taxonomy are returned.\n", "args": [ { "name": "search", "description": "Searches the product taxonomy for matching categories.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "childrenOf", "description": "The ID of the category associated with the child categories to return.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "siblingsOf", "description": "The ID of the category associated with the sibling categories to return.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "descendantsOf", "description": "The ID of the category associated with the descendant categories to return.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategoryConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyAttribute", "description": "A Shopify product taxonomy attribute.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyCategory", "description": "The details of a specific product category within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt).", "fields": [ { "name": "ancestorIds", "description": "The IDs of the category's ancestor categories.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attributes", "description": "The attributes of the taxonomy category.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategoryAttributeConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "childrenIds", "description": "The IDs of the category's child categories.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fullName", "description": "The full name of the taxonomy category. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The globally-unique ID of the TaxonomyCategory.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isArchived", "description": "Whether the category is archived. The default value is `false`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isLeaf", "description": "Whether the category is a leaf category. A leaf category doesn't have any subcategories beneath it. For example, in Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Treadmills, Dog Treadmills is a leaf category. The value is `true` when there are no `childrenIds` specified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRoot", "description": "Whether the category is a root category. A root category is at the top level of the category hierarchy and doesn't have a parent category. For example, Animals & Pet Supplies. The value is `true` when there's no `parentId` specified.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "level", "description": "The level of the category in the taxonomy tree. Levels indicate the depth of the category from the root. For example, in Animals & Pet Supplies > Pet Supplies > Dog Supplies, Animals & Pet Supplies is at level 1, Animals & Pet Supplies > Pet Supplies is at level 2, and Animals & Pet Supplies > Pet Supplies > Dog Supplies is at level 3.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the taxonomy category. For example, Dog Beds.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "parentId", "description": "The ID of the category's parent category.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "TaxonomyCategoryAttribute", "description": "A product taxonomy attribute interface.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "TaxonomyAttribute", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyChoiceListAttribute", "ofType": null }, { "kind": "OBJECT", "name": "TaxonomyMeasurementAttribute", "ofType": null } ] }, { "kind": "OBJECT", "name": "TaxonomyCategoryAttributeConnection", "description": "An auto-generated type for paginating through multiple TaxonomyCategoryAttributes.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategoryAttributeEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in TaxonomyCategoryAttributeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "TaxonomyCategoryAttribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyCategoryAttributeEdge", "description": "An auto-generated type which holds one TaxonomyCategoryAttribute and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of TaxonomyCategoryAttributeEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "TaxonomyCategoryAttribute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyCategoryConnection", "description": "An auto-generated type for paginating through multiple TaxonomyCategories.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategoryEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in TaxonomyCategoryEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategory", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyCategoryEdge", "description": "An auto-generated type which holds one TaxonomyCategory and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of TaxonomyCategoryEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyCategory", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyChoiceListAttribute", "description": "A Shopify product taxonomy choice list attribute.", "fields": [ { "name": "id", "description": "The unique ID of the TaxonomyAttribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product taxonomy attribute. For example, Color.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": "A list of values on the choice list attribute.", "args": [ { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyValueConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyMeasurementAttribute", "description": "A Shopify product taxonomy measurement attribute.", "fields": [ { "name": "id", "description": "The unique ID of the TaxonomyAttribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product taxonomy attribute. For example, Color.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "The product taxonomy attribute options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyValue", "description": "Represents a Shopify product taxonomy value.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the product taxonomy value. For example, Red.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyValueConnection", "description": "An auto-generated type for paginating through multiple TaxonomyValues.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyValueEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in TaxonomyValueEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxonomyValueEdge", "description": "An auto-generated type which holds one TaxonomyValue and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of TaxonomyValueEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxonomyValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TenderTransaction", "description": "A TenderTransaction represents a transaction with financial impact on a shop's balance sheet. A tender transaction always\nrepresents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions\nfor reconciling a shop's cash flow. A TenderTransaction is immutable once created.\n", "fields": [ { "name": "amount", "description": "The amount and currency of the tender transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paymentMethod", "description": "Information about the payment method used for the transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "processedAt", "description": "Date and time when the transaction was processed.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remoteReference", "description": "The remote gateway reference associated with the tender transaction.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "test", "description": "Whether the transaction is a test transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "transactionDetails", "description": "Information about the payment instrument used for the transaction.", "args": [], "type": { "kind": "UNION", "name": "TenderTransactionDetails", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "user", "description": "The staff member who performed the transaction.", "args": [], "type": { "kind": "OBJECT", "name": "StaffMember", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TenderTransactionConnection", "description": "An auto-generated type for paginating through multiple TenderTransactions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TenderTransactionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in TenderTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TenderTransaction", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TenderTransactionCreditCardDetails", "description": "Information about the credit card used for this transaction.", "fields": [ { "name": "creditCardCompany", "description": "The name of the company that issued the customer's credit card. Example: `Visa`.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "creditCardNumber", "description": "The customer's credit card number, with all digits except the last 4 redacted. Example: `•••• •••• •••• 1234`", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "TenderTransactionDetails", "description": "Information about the payment instrument used for this transaction.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "TenderTransactionCreditCardDetails", "ofType": null } ] }, { "kind": "OBJECT", "name": "TenderTransactionEdge", "description": "An auto-generated type which holds one TenderTransaction and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of TenderTransactionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TenderTransaction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TipSale", "description": "A sale associated with a tip.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineItem", "description": "The line item for the associated sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "LineItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TransactionFee", "description": "Transaction fee related to an order transaction.", "fields": [ { "name": "amount", "description": "Amount of the fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "flatFee", "description": "Flat rate charge for a transaction.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "flatFeeName", "description": "Name of the credit card flat fee.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rate", "description": "Percentage charge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Decimal", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rateName", "description": "Name of the credit card rate.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxAmount", "description": "Tax amount charged on the fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyV2", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "Name of the type of fee.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TransactionVoidPayload", "description": "Return type for `transactionVoid` mutation.", "fields": [ { "name": "transaction", "description": "The created void transaction.", "args": [], "type": { "kind": "OBJECT", "name": "OrderTransaction", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TransactionVoidUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TransactionVoidUserError", "description": "An error that occurs during the execution of `TransactionVoid`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "TransactionVoidUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "TransactionVoidUserErrorCode", "description": "Possible error codes that can be returned by `TransactionVoidUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TRANSACTION_NOT_FOUND", "description": "Transaction does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTH_NOT_SUCCESSFUL", "description": "Transaction must be a successful authorization.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUTH_NOT_VOIDABLE", "description": "Transaction must be voidable.", "isDeprecated": false, "deprecationReason": null }, { "name": "GENERIC_ERROR", "description": "A generic error occurred while attempting to void the transaction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslatableContent", "description": "Translatable content of a resource's field.", "fields": [ { "name": "digest", "description": "Hash digest representation of the content value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "key", "description": "The resource field that's being translated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "Locale of the content.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "Type of the translatable content.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "LocalizableContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Content value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslatableResource", "description": "A resource that has translatable fields.", "fields": [ { "name": "resourceId", "description": "GID of the resource.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translatableContent", "description": "Translatable content.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableContent", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "translations", "description": "Translatable content translations.", "args": [ { "name": "locale", "description": "Filters translations by locale.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "outdated", "description": "Filters by outdated translations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "marketId", "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslatableResourceConnection", "description": "An auto-generated type for paginating through multiple TranslatableResources.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableResourceEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in TranslatableResourceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableResource", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslatableResourceEdge", "description": "An auto-generated type which holds one TranslatableResource and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of TranslatableResourceEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslatableResource", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "TranslatableResourceType", "description": "Specifies the type of resources that are translatable.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "COLLECTION", "description": "A product collection. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELIVERY_METHOD_DEFINITION", "description": "The delivery method definition. For example, \"Standard\", or \"Expedited\". Translatable fields: `name`.", "isDeprecated": false, "deprecationReason": null }, { "name": "EMAIL_TEMPLATE", "description": "An email template. Translatable fields: `title`, `body_html`.", "isDeprecated": false, "deprecationReason": null }, { "name": "FILTER", "description": "A filter. Translatable fields: `label`.", "isDeprecated": false, "deprecationReason": null }, { "name": "LINK", "description": "A link to direct users. Translatable fields: `title`.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAFIELD", "description": "A Metafield. Translatable fields: `value`.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECT", "description": "A Metaobject. Translatable fields are determined by the Metaobject type.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_ARTICLE", "description": "An online store article. Translatable fields: `title`, `body_html`, `summary_html`, `handle`, `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_BLOG", "description": "An online store blog. Translatable fields: `title`, `handle`, `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_MENU", "description": "A category of links. Translatable fields: `title`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_PAGE", "description": "An online store page. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "ONLINE_STORE_THEME", "description": "An online store theme. Translatable fields: `dynamic keys based on theme data`.", "isDeprecated": false, "deprecationReason": null }, { "name": "PACKING_SLIP_TEMPLATE", "description": "A packing slip template. Translatable fields: `body`.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_GATEWAY", "description": "A payment gateway. Translatable fields: `name`, `message`, `before_payment_instructions`.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT", "description": "An online store product. Translatable fields: `title`, `body_html`, `handle`, `product_type`, `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_OPTION", "description": "An online store custom product property name. For example, \"Size\", \"Color\", or \"Material\".\n Translatable fields: `name`.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_OPTION_VALUE", "description": "The product option value names. For example, \"Red\", \"Blue\", and \"Green\" for a \"Color\" option. Translatable fields: `name`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN", "description": "A selling plan. Translatable fields:`name`, `option1`, `option2`, `option3`, `description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_GROUP", "description": "A selling plan group. Translatable fields: `name`, `option1`, `option2`, `option3`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP", "description": "A shop. Translatable fields: `meta_title`, `meta_description`.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_POLICY", "description": "A shop policy. Translatable fields: `body`.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "Translation", "description": "Translation of a field of a resource.", "fields": [ { "name": "key", "description": "On the resource that this translation belongs to, the reference to the value being translated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "ISO code of the translation locale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "market", "description": "The market that the translation is specific to. Null value means the translation is available in all markets.", "args": [], "type": { "kind": "OBJECT", "name": "Market", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "outdated", "description": "Whether the original content has changed since this translation was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the translation was updated.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Translation value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "TranslationErrorCode", "description": "Possible error codes that can be returned by `TranslationUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID", "description": "The input value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_NOT_FOUND", "description": "Resource does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_NOT_TRANSLATABLE", "description": "Resource is not translatable.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_MANY_KEYS_FOR_RESOURCE", "description": "Too many translation keys for the resource.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_KEY_FOR_MODEL", "description": "Translation key is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "FAILS_RESOURCE_VALIDATION", "description": "Translation value is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TRANSLATABLE_CONTENT", "description": "Translatable content is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_MARKET_LOCALIZABLE_CONTENT", "description": "Market localizable content is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LOCALE_FOR_SHOP", "description": "Locale is invalid for the shop.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_CODE", "description": "Locale language code is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_FORMAT", "description": "Locale code format is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_CUSTOM_CONTENT_NOT_ALLOWED", "description": "The shop isn't allowed to operate on market custom content.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_DOES_NOT_EXIST", "description": "The market corresponding to the `marketId` argument doesn't exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKET_LOCALE_CREATION_FAILED", "description": "The market override locale creation failed.", "isDeprecated": false, "deprecationReason": null }, { "name": "RESOURCE_NOT_MARKET_CUSTOMIZABLE", "description": "The specified resource can't be customized for a market.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_LOCALE_FOR_MARKET", "description": "The locale is missing on the market corresponding to the `marketId` argument.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE_FOR_HANDLE_TRANSLATION", "description": "The handle is already taken for this resource.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "TranslationInput", "description": "The input fields and values for creating or updating a translation.", "fields": null, "inputFields": [ { "name": "locale", "description": "ISO code of the locale being translated into. Only locales returned in `shopLocales` are valid.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "On the resource that this translation belongs to, the reference to the value being translated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The value of the translation.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "translatableContentDigest", "description": "Hash digest representation of the content being translated.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "marketId", "description": "The ID of the market that the translation is specific to. Not specifying this field means that the translation will be available in all markets.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslationUserError", "description": "Represents an error that happens during the execution of a translation mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "TranslationErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslationsRegisterPayload", "description": "Return type for `translationsRegister` mutation.", "fields": [ { "name": "translations", "description": "The translations that were created or updated.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TranslationsRemovePayload", "description": "Return type for `translationsRemove` mutation.", "fields": [ { "name": "translations", "description": "The translations that were deleted.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Translation", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "TranslationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TypedAttribute", "description": "Represents a typed custom attribute.", "fields": [ { "name": "key", "description": "Key or name of the attribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Value of the attribute.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "URL", "description": "Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\n\nFor example, `\"https://johns-apparel.myshopify.com\"` is a valid URL. It includes a scheme (`https`) and a host\n(`johns-apparel.myshopify.com`).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "UTMInput", "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign.\n", "fields": null, "inputFields": [ { "name": "campaign", "description": "The name of the UTM campaign.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "source", "description": "The name of the website or application where the referral link exists.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "medium", "description": "The UTM campaign medium.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UTMParameters", "description": "Represents a set of UTM parameters.", "fields": [ { "name": "campaign", "description": "The name of a marketing campaign.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "content", "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "medium", "description": "The medium of a marketing campaign, such as a banner or email newsletter.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "source", "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "term", "description": "Paid search terms used by a marketing campaign.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UnitSystem", "description": "Systems of weights and measures.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "IMPERIAL_SYSTEM", "description": "Imperial system of weights and measures.", "isDeprecated": false, "deprecationReason": null }, { "name": "METRIC_SYSTEM", "description": "Metric system of weights and measures.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UnknownSale", "description": "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.", "fields": [ { "name": "actionType", "description": "The type of order action that the sale represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleActionType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lineType", "description": "The line type assocated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "SaleLineType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The number of units either ordered or intended to be returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "All individual taxes associated with the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SaleTax", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalAmount", "description": "The total sale amount after taxes and discounts.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountAfterTaxes", "description": "The total discounts allocated to the sale after taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalDiscountAmountBeforeTaxes", "description": "The total discounts allocated to the sale before taxes.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "totalTaxAmount", "description": "The total amount of taxes for the sale.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MoneyBag", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Sale", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "UnsignedInt64", "description": "An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits.\n\nExample value: `\"50\"`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "UpdateMediaInput", "description": "The input fields required to update a media object.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the media to update.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "previewImageSource", "description": "The source from which to update the media preview image. May be an external URL or staged upload URL.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "alt", "description": "The alt text associated to the media.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirect", "description": "The URL redirect for the online store.", "fields": [ { "name": "id", "description": "The ID of the URL redirect.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "path", "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "target", "description": "The target location where the user will be redirected to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteAllPayload", "description": "Return type for `urlRedirectBulkDeleteAll` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the redirects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteByIdsPayload", "description": "Return type for `urlRedirectBulkDeleteByIds` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the redirects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteByIdsUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteByIdsUserError", "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteByIds`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "UrlRedirectBulkDeleteByIdsUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectBulkDeleteByIdsUserErrorCode", "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteByIdsUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "IDS_EMPTY", "description": "You must pass one or more [`URLRedirect`](\n https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect\n ) object IDs.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySavedSearchPayload", "description": "Return type for `urlRedirectBulkDeleteBySavedSearch` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the redirects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySavedSearchUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySavedSearchUserError", "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteBySavedSearch`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "UrlRedirectBulkDeleteBySavedSearchUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectBulkDeleteBySavedSearchUserErrorCode", "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteBySavedSearchUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SAVED_SEARCH_NOT_FOUND", "description": "Saved search not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_SAVED_SEARCH_QUERY", "description": "The saved search's query cannot match all entries or be empty.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySearchPayload", "description": "Return type for `urlRedirectBulkDeleteBySearch` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job removing the redirects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySearchUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectBulkDeleteBySearchUserError", "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteBySearch`.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "UrlRedirectBulkDeleteBySearchUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectBulkDeleteBySearchUserErrorCode", "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteBySearchUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INVALID_SEARCH_ARGUMENT", "description": "Invalid search string.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectConnection", "description": "An auto-generated type for paginating through multiple UrlRedirects.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in UrlRedirectEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectCreatePayload", "description": "Return type for `urlRedirectCreate` mutation.", "fields": [ { "name": "urlRedirect", "description": "The created redirect.", "args": [], "type": { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectDeletePayload", "description": "Return type for `urlRedirectDelete` mutation.", "fields": [ { "name": "deletedUrlRedirectId", "description": "The ID of the deleted redirect.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectEdge", "description": "An auto-generated type which holds one UrlRedirect and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of UrlRedirectEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectErrorCode", "description": "Possible error codes that can be returned by `UrlRedirectUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "DOES_NOT_EXIST", "description": "Redirect does not exist.", "isDeprecated": false, "deprecationReason": null }, { "name": "CREATE_FAILED", "description": "Redirect could not be created.", "isDeprecated": false, "deprecationReason": null }, { "name": "UPDATE_FAILED", "description": "Redirect could not be updated.", "isDeprecated": false, "deprecationReason": null }, { "name": "DELETE_FAILED", "description": "Redirect could not be deleted.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectImport", "description": "A request to import a [`URLRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object\ninto the Online Store channel. Apps can use this to query the state of an `UrlRedirectImport` request.\n\nFor more information, see [`url-redirect`](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect)s.\n", "fields": [ { "name": "count", "description": "The number of rows in the file.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdCount", "description": "The number of redirects created from the import.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "failedCount", "description": "The number of redirects that failed to be imported.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "finished", "description": "Whether the import is finished.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "finishedAt", "description": "The date and time when the import finished.", "args": [], "type": { "kind": "SCALAR", "name": "DateTime", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID of the `UrlRedirectImport` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "previewRedirects", "description": "A list of up to three previews of the URL redirects to be imported.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectImportPreview", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedCount", "description": "The number of redirects updated during the import.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectImportCreatePayload", "description": "Return type for `urlRedirectImportCreate` mutation.", "fields": [ { "name": "urlRedirectImport", "description": "The created `URLRedirectImport` object.", "args": [], "type": { "kind": "OBJECT", "name": "UrlRedirectImport", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectImportUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectImportErrorCode", "description": "Possible error codes that can be returned by `UrlRedirectImportUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FILE_DOES_NOT_EXIST", "description": "CSV file does not exist at given URL.", "isDeprecated": true, "deprecationReason": "This error code is never returned" }, { "name": "NOT_FOUND", "description": "URL redirect import not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "ALREADY_IMPORTED", "description": "The import has already completed.", "isDeprecated": false, "deprecationReason": null }, { "name": "IN_PROGRESS", "description": "The import is already in progress.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectImportPreview", "description": "A preview of a URL redirect import row.", "fields": [ { "name": "path", "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "target", "description": "The target location where the user will be redirected to.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectImportSubmitPayload", "description": "Return type for `urlRedirectImportSubmit` mutation.", "fields": [ { "name": "job", "description": "The asynchronous job importing the redirects.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectImportUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectImportUserError", "description": "Represents an error that happens during execution of a redirect import mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "UrlRedirectImportErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "UrlRedirectInput", "description": "The input fields to create or update a URL redirect.", "fields": null, "inputFields": [ { "name": "path", "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "target", "description": "The target location where the user will be redirected to.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRedirectSortKeys", "description": "The set of valid sort keys for the UrlRedirect query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null }, { "name": "PATH", "description": "Sort by the `path` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectUpdatePayload", "description": "Return type for `urlRedirectUpdate` mutation.", "fields": [ { "name": "urlRedirect", "description": "Returns the updated URL redirect.", "args": [], "type": { "kind": "OBJECT", "name": "UrlRedirect", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRedirectUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRedirectUserError", "description": "Represents an error that happens during execution of a redirect mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "UrlRedirectErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UserError", "description": "Represents an error in the input of a mutation.", "fields": [ { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "UtcOffset", "description": "Time between UTC time and a location's observed time, in the format `\"+HH:MM\"` or `\"-HH:MM\"`.\n\nExample value: `\"-07:00\"`.\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Validation", "description": "A checkout server side validation installed on the shop.", "fields": [ { "name": "blockOnFailure", "description": "Whether the validation should block on failures other than expected violations.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Whether the validation is enabled on the merchant checkout.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "errorHistory", "description": "The error history on the most recent version of the validation function.", "args": [], "type": { "kind": "OBJECT", "name": "FunctionsErrorHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "Global ID for the validation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafield", "description": "Returns a metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "key", "description": "The key for the metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Metafield", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldDefinitions", "description": "List of metafield definitions.", "args": [ { "name": "namespace", "description": "Filter metafield definitions by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pinnedStatus", "description": "Filter by the definition's pinned status.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionPinnedStatus", "ofType": null }, "defaultValue": "ANY" }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "sortKey", "description": "Sort the underlying list by the given key.", "type": { "kind": "ENUM", "name": "MetafieldDefinitionSortKeys", "ofType": null }, "defaultValue": "ID" }, { "name": "query", "description": "Apply one or multiple filters to the query.\n| name | description | acceptable_values | default_value | example_use |\n| ---- | ---- | ---- | ---- | ---- |\n| created_at |\n| key |\n| namespace |\n| owner_type |\n| type |\n| updated_at |\nRefer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.\n", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldDefinitionConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafields", "description": "List of metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "keys", "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MetafieldConnection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafield", "description": "Returns a private metafield by namespace and key that belongs to the resource.", "args": [ { "name": "namespace", "description": "The namespace for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "key", "description": "The key for the private metafield.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PrivateMetafield", "ofType": null }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "privateMetafields", "description": "List of private metafields that belong to the resource.", "args": [ { "name": "namespace", "description": "Filter the private metafields by namespace.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "first", "description": "Returns up to the first `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "after", "description": "Returns the elements that come after the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "last", "description": "Returns up to the last `n` elements from the list.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "before", "description": "Returns the elements that come before the specified cursor.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "reverse", "description": "Reverse the order of the underlying list.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PrivateMetafieldConnection", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "shopifyFunction", "description": "The Shopify Function implementing the validation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ShopifyFunction", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The merchant-facing validation name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "HasMetafieldDefinitions", "ofType": null }, { "kind": "INTERFACE", "name": "HasMetafields", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationConnection", "description": "An auto-generated type for paginating through multiple Validations.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ValidationEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in ValidationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Validation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ValidationCreateInput", "description": "The input fields required to install a validation.", "fields": null, "inputFields": [ { "name": "functionId", "description": "The function ID representing the extension to install.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "enable", "description": "Whether the validation should be live on the merchant checkout.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "blockOnFailure", "description": "Whether the validation should block on failures other than expected violations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "metafields", "description": "Additional metafields to associate to the validation.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" }, { "name": "title", "description": "The title of the validation.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationCreatePayload", "description": "Return type for `validationCreate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ValidationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validation", "description": "The created validation.", "args": [], "type": { "kind": "OBJECT", "name": "Validation", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationDeletePayload", "description": "Return type for `validationDelete` mutation.", "fields": [ { "name": "deletedId", "description": "Returns the deleted validation ID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ValidationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationEdge", "description": "An auto-generated type which holds one Validation and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of ValidationEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Validation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ValidationSortKeys", "description": "The set of valid sort keys for the Validation query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ValidationUpdateInput", "description": "The input fields required to update a validation.", "fields": null, "inputFields": [ { "name": "enable", "description": "Whether the validation should be live on the merchant checkout.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "blockOnFailure", "description": "Whether the validation should block on failures other than expected violations.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" }, { "name": "metafields", "description": "Additional metafields to associate to the validation.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "MetafieldInput", "ofType": null } } }, "defaultValue": "[]" }, { "name": "title", "description": "The title of the validation.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationUpdatePayload", "description": "Return type for `validationUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ValidationUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "validation", "description": "The updated validation.", "args": [], "type": { "kind": "OBJECT", "name": "Validation", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ValidationUserError", "description": "An error that occurs during the execution of a validation mutation.", "fields": [ { "name": "code", "description": "The error code.", "args": [], "type": { "kind": "ENUM", "name": "ValidationUserErrorCode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "field", "description": "The path to the input field that caused the error.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "The error message.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "DisplayableError", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ValidationUserErrorCode", "description": "Possible error codes that can be returned by `ValidationUserError`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_FOUND", "description": "Validation not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_NOT_FOUND", "description": "Function not found.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", "description": "Shop must be on a Shopify Plus plan to activate functions from a custom app.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_DOES_NOT_IMPLEMENT", "description": "Function does not implement the required interface for this cart & checkout validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLIC_APP_NOT_ALLOWED", "description": "Only unlisted apps can be used for this cart & checkout validation.", "isDeprecated": false, "deprecationReason": null }, { "name": "FUNCTION_PENDING_DELETION", "description": "Function is pending deletion.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_TYPE", "description": "The type is invalid.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVALID_VALUE", "description": "The value is invalid for the metafield type or for the definition options.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_NOT_AUTHORIZED", "description": "ApiPermission metafields can only be created or updated by the app owner.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNSTRUCTURED_RESERVED_NAMESPACE", "description": "Unstructured reserved namespace.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISALLOWED_OWNER_TYPE", "description": "Owner type can't be used in this mutation.", "isDeprecated": false, "deprecationReason": null }, { "name": "INCLUSION", "description": "The input value isn't included in the list.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAKEN", "description": "The input value is already taken.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRESENT", "description": "The input value needs to be blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "BLANK", "description": "The input value is blank.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_LONG", "description": "The input value is too long.", "isDeprecated": false, "deprecationReason": null }, { "name": "TOO_SHORT", "description": "The input value is too short.", "isDeprecated": false, "deprecationReason": null }, { "name": "CAPABILITY_VIOLATION", "description": "The metafield violates a capability restriction.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "VariantOptionValueInput", "description": "The input fields required to create or modify a product variant's option value.", "fields": null, "inputFields": [ { "name": "id", "description": "Specifies the product option value by ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Specifies the product option value by name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "optionId", "description": "Specifies the product option by ID.", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "optionName", "description": "Specifies the product option by name.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VaultCreditCard", "description": "Represents a credit card payment instrument.", "fields": [ { "name": "billingAddress", "description": "The billing address of the card.", "args": [], "type": { "kind": "OBJECT", "name": "CustomerCreditCardBillingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "brand", "description": "The brand for the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expired", "description": "Whether the card has been expired.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryMonth", "description": "The expiry month of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiryYear", "description": "The expiry year of the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastDigits", "description": "The last four digits for the card.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The name of the card holder.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VaultPaypalBillingAgreement", "description": "Represents a paypal billing agreement payment instrument.", "fields": [ { "name": "inactive", "description": "Whether the paypal billing agreement is inactive.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The paypal account name.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "paypalAccountEmail", "description": "The paypal account email address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Vector3", "description": "Representation of 3d vectors and points. It can represent\neither the coordinates of a point in space, a direction, or\nsize. Presented as an object with three floating-point values.\n", "fields": [ { "name": "x", "description": "The x coordinate of Vector3.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "y", "description": "The y coordinate of Vector3.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "z", "description": "The z coordinate of Vector3.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Video", "description": "Represents a Shopify hosted video.\n", "fields": [ { "name": "alt", "description": "A word or phrase to share the nature or contents of a media.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createdAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "duration", "description": "The video's duration in milliseconds. This value is `null` unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileErrors", "description": "Any errors that have occurred on the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "FileError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fileStatus", "description": "The status of the file.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "FileStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "filename", "description": "The video's filename.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaContentType", "description": "The media content type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaContentType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaErrors", "description": "Any errors which have occurred on the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mediaWarnings", "description": "The warnings attached to the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaWarning", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "originalSource", "description": "The video's original source. This value is `null` unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", "args": [], "type": { "kind": "OBJECT", "name": "VideoSource", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "preview", "description": "The preview image for the media.", "args": [], "type": { "kind": "OBJECT", "name": "MediaPreviewImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sources", "description": "The video's sources. This value is empty unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "VideoSource", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Current status of the media.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "MediaStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "File", "ofType": null }, { "kind": "INTERFACE", "name": "Media", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VideoSource", "description": "Represents a source for a Shopify hosted video.\n\nTypes of sources include the original video, lower resolution versions of the original video,\nand an m3u8 playlist file.\n\nOnly [videos](https://shopify.dev/api/admin-graphql/latest/objects/video) with a status field\nof [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready) have sources.\n", "fields": [ { "name": "fileSize", "description": "The video source's file size in bytes.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": "The video source's file format extension.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "height", "description": "The video source's height.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mimeType", "description": "The video source's MIME type.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The video source's URL.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "width", "description": "The video source's width.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "VisualizationType", "description": "A type of visualization.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "LINE", "description": "Line Chart.", "isDeprecated": false, "deprecationReason": null }, { "name": "BAR", "description": "Bar Chart.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "WebPixel", "description": "A web pixel settings.", "fields": [ { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "settings", "description": "The settings JSON object for the web pixel.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "JSON", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebPixelCreatePayload", "description": "Return type for `webPixelCreate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsWebPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixel", "description": "The created web pixel settings.", "args": [], "type": { "kind": "OBJECT", "name": "WebPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebPixelDeletePayload", "description": "Return type for `webPixelDelete` mutation.", "fields": [ { "name": "deletedWebPixelId", "description": "The ID of the web pixel settings that was deleted.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsWebPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WebPixelInput", "description": "The input fields to use to update a web pixel.", "fields": null, "inputFields": [ { "name": "settings", "description": "The web pixel settings in JSON format.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "JSON", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebPixelUpdatePayload", "description": "Return type for `webPixelUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ErrorsWebPixelUserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webPixel", "description": "The updated web pixel settings.", "args": [], "type": { "kind": "OBJECT", "name": "WebPixel", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookEventBridgeEndpoint", "description": "An Amazon EventBridge partner event source to which webhook subscriptions publish events.", "fields": [ { "name": "arn", "description": "The ARN of this EventBridge partner event source.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ARN", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookHttpEndpoint", "description": "An HTTPS endpoint to which webhook subscriptions send POST requests.", "fields": [ { "name": "callbackUrl", "description": "The URL to which the webhooks events are sent.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookPubSubEndpoint", "description": "A Google Cloud Pub/Sub topic to which webhook subscriptions publish events.", "fields": [ { "name": "pubSubProject", "description": "The Google Cloud Pub/Sub project ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pubSubTopic", "description": "The Google Cloud Pub/Sub topic ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscription", "description": "A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API.\nIt describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic.\nWhen an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination.\nLearn more about the [webhooks system](https://shopify.dev/apps/webhooks).\n", "fields": [ { "name": "apiVersion", "description": "The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ApiVersion", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "callbackUrl", "description": "The destination URI to which the webhook subscription will send a message when an event occurs.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "URL", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `endpoint` instead." }, { "name": "createdAt", "description": "The date and time when the webhook subscription was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "endpoint", "description": "The endpoint to which the webhook subscription will send events.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "UNION", "name": "WebhookSubscriptionEndpoint", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": "The format in which the webhook subscription should send the data.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "A globally-unique ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "includeFields", "description": "An optional array of top-level resource fields that should be serialized and sent in the webhook message. If null, then all fields will be sent.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "legacyResourceId", "description": "The ID of the corresponding resource in the REST Admin API.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "UnsignedInt64", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "metafieldNamespaces", "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "privateMetafieldNamespaces", "description": "The list of namespaces for private metafields that should be included in the webhook subscription.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } } }, "isDeprecated": true, "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" }, { "name": "subTopic", "description": "An additional constraint to refine the type of event that triggers the webhook. Only supported on certain topics. See our guide to [sub-topics](https://shopify.dev/docs/apps/webhooks/sub-topics) for more.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "topic", "description": "The type of event that triggers the webhook. The topic determines when the webhook subscription sends a webhook, as well as what class of data object that webhook contains.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updatedAt", "description": "The date and time when the webhook subscription was updated.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "DateTime", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LegacyInteroperability", "ofType": null }, { "kind": "INTERFACE", "name": "Node", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscriptionConnection", "description": "An auto-generated type for paginating through multiple WebhookSubscriptions.\n", "fields": [ { "name": "edges", "description": "A list of edges.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "WebhookSubscriptionEdge", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nodes", "description": "A list of the nodes contained in WebhookSubscriptionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pageInfo", "description": "Information to aid in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscriptionCreatePayload", "description": "Return type for `webhookSubscriptionCreate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was created.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscriptionDeletePayload", "description": "Return type for `webhookSubscriptionDelete` mutation.", "fields": [ { "name": "deletedWebhookSubscriptionId", "description": "The ID of the deleted webhook subscription.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscriptionEdge", "description": "An auto-generated type which holds one WebhookSubscription and a cursor during pagination.\n", "fields": [ { "name": "cursor", "description": "A cursor for use in pagination.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "node", "description": "The item at the end of WebhookSubscriptionEdge.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "UNION", "name": "WebhookSubscriptionEndpoint", "description": "An endpoint to which webhook subscriptions send webhooks events.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "WebhookEventBridgeEndpoint", "ofType": null }, { "kind": "OBJECT", "name": "WebhookHttpEndpoint", "ofType": null }, { "kind": "OBJECT", "name": "WebhookPubSubEndpoint", "ofType": null } ] }, { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "description": "The supported formats for webhook subscriptions.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "JSON", "description": null, "isDeprecated": false, "deprecationReason": null }, { "name": "XML", "description": null, "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WebhookSubscriptionInput", "description": "The input fields for a webhook subscription.\n", "fields": null, "inputFields": [ { "name": "callbackUrl", "description": "URL where the webhook subscription should send the POST request when the event occurs.", "type": { "kind": "SCALAR", "name": "URL", "ofType": null }, "defaultValue": null }, { "name": "format", "description": "The format in which the webhook subscription should send the data.", "type": { "kind": "ENUM", "name": "WebhookSubscriptionFormat", "ofType": null }, "defaultValue": null }, { "name": "includeFields", "description": "The list of fields to be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "metafieldNamespaces", "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "WebhookSubscriptionSortKeys", "description": "The set of valid sort keys for the WebhookSubscription query.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CREATED_AT", "description": "Sort by the `created_at` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "ID", "description": "Sort by the `id` value.", "isDeprecated": false, "deprecationReason": null }, { "name": "RELEVANCE", "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "ENUM", "name": "WebhookSubscriptionTopic", "description": "The supported topics for webhook subscriptions. You can use webhook subscriptions to receive\nnotifications about particular events in a shop.\n\nYou create mandatory webhooks either via the\n[Partner Dashboard](https://shopify.dev/apps/webhooks/configuration/mandatory-webhooks#subscribe-to-privacy-webhooks)\nor by updating the\n[app configuration TOML](https://shopify.dev/apps/tools/cli/configuration#app-configuration-file-example).\n", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "APP_UNINSTALLED", "description": "The webhook topic for `app/uninstalled` events. Occurs whenever a shop has uninstalled the app.", "isDeprecated": false, "deprecationReason": null }, { "name": "CARTS_CREATE", "description": "The webhook topic for `carts/create` events. Occurs when a cart is created in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are created in a custom storefront. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CARTS_UPDATE", "description": "The webhook topic for `carts/update` events. Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHANNELS_DELETE", "description": "The webhook topic for `channels/delete` events. Occurs whenever a channel is deleted. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHECKOUTS_CREATE", "description": "The webhook topic for `checkouts/create` events. Occurs whenever a checkout is created. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHECKOUTS_DELETE", "description": "The webhook topic for `checkouts/delete` events. Occurs whenever a checkout is deleted. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CHECKOUTS_UPDATE", "description": "The webhook topic for `checkouts/update` events. Occurs whenever a checkout is updated. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PAYMENT_METHODS_CREATE", "description": "The webhook topic for `customer_payment_methods/create` events. Occurs whenever a customer payment method is created. Requires the `read_customer_payment_methods` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PAYMENT_METHODS_UPDATE", "description": "The webhook topic for `customer_payment_methods/update` events. Occurs whenever a customer payment method is updated. Requires the `read_customer_payment_methods` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_PAYMENT_METHODS_REVOKE", "description": "The webhook topic for `customer_payment_methods/revoke` events. Occurs whenever a customer payment method is revoked. Requires the `read_customer_payment_methods` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_LISTINGS_ADD", "description": "The webhook topic for `collection_listings/add` events. Occurs whenever a collection listing is added. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_LISTINGS_REMOVE", "description": "The webhook topic for `collection_listings/remove` events. Occurs whenever a collection listing is removed. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_LISTINGS_UPDATE", "description": "The webhook topic for `collection_listings/update` events. Occurs whenever a collection listing is updated. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_PUBLICATIONS_CREATE", "description": "The webhook topic for `collection_publications/create` events. Occurs whenever a collection publication listing is created. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_PUBLICATIONS_DELETE", "description": "The webhook topic for `collection_publications/delete` events. Occurs whenever a collection publication listing is deleted. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTION_PUBLICATIONS_UPDATE", "description": "The webhook topic for `collection_publications/update` events. Occurs whenever a collection publication listing is updated. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTIONS_CREATE", "description": "The webhook topic for `collections/create` events. Occurs whenever a collection is created. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTIONS_DELETE", "description": "The webhook topic for `collections/delete` events. Occurs whenever a collection is deleted. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COLLECTIONS_UPDATE", "description": "The webhook topic for `collections/update` events. Occurs whenever a collection is updated, including whenever products are added or removed from the collection. Occurs once if multiple products are added or removed from a collection at the same time. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_GROUPS_CREATE", "description": "The webhook topic for `customer_groups/create` events. Occurs whenever a customer saved search is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_GROUPS_DELETE", "description": "The webhook topic for `customer_groups/delete` events. Occurs whenever a customer saved search is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_GROUPS_UPDATE", "description": "The webhook topic for `customer_groups/update` events. Occurs whenever a customer saved search is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_CREATE", "description": "The webhook topic for `customers/create` events. Occurs whenever a customer is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_DELETE", "description": "The webhook topic for `customers/delete` events. Occurs whenever a customer is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_DISABLE", "description": "The webhook topic for `customers/disable` events. Occurs whenever a customer account is disabled. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_ENABLE", "description": "The webhook topic for `customers/enable` events. Occurs whenever a customer account is enabled. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_UPDATE", "description": "The webhook topic for `customers/update` events. Occurs whenever a customer is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_MARKETING_CONSENT_UPDATE", "description": "The webhook topic for `customers_marketing_consent/update` events. Occurs whenever a customer's SMS marketing consent is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_TAGS_ADDED", "description": "The webhook topic for `customer.tags_added` events. Triggers when tags are added to a customer. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMER_TAGS_REMOVED", "description": "The webhook topic for `customer.tags_removed` events. Triggers when tags are removed from a customer. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE", "description": "The webhook topic for `customers_email_marketing_consent/update` events. Occurs whenever a customer's email marketing consent is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISPUTES_CREATE", "description": "The webhook topic for `disputes/create` events. Occurs whenever a dispute is created. Requires the `read_shopify_payments_disputes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISPUTES_UPDATE", "description": "The webhook topic for `disputes/update` events. Occurs whenever a dispute is updated. Requires the `read_shopify_payments_disputes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT_ORDERS_CREATE", "description": "The webhook topic for `draft_orders/create` events. Occurs whenever a draft order is created. Requires the `read_draft_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT_ORDERS_DELETE", "description": "The webhook topic for `draft_orders/delete` events. Occurs whenever a draft order is deleted. Requires the `read_draft_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DRAFT_ORDERS_UPDATE", "description": "The webhook topic for `draft_orders/update` events. Occurs whenever a draft order is updated. Requires the `read_draft_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_EVENTS_CREATE", "description": "The webhook topic for `fulfillment_events/create` events. Occurs whenever a fulfillment event is created. Requires the `read_fulfillments` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_EVENTS_DELETE", "description": "The webhook topic for `fulfillment_events/delete` events. Occurs whenever a fulfillment event is deleted. Requires the `read_fulfillments` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENTS_CREATE", "description": "The webhook topic for `fulfillments/create` events. Occurs whenever a fulfillment is created. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENTS_UPDATE", "description": "The webhook topic for `fulfillments/update` events. Occurs whenever a fulfillment is updated. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ATTRIBUTED_SESSIONS_FIRST", "description": "The webhook topic for `attributed_sessions/first` events. Occurs whenever an order with a \"first\" attributed session is attributed. Requires the `read_marketing_events` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "ATTRIBUTED_SESSIONS_LAST", "description": "The webhook topic for `attributed_sessions/last` events. Occurs whenever an order with a \"last\" attributed session is attributed. Requires the `read_marketing_events` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDER_TRANSACTIONS_CREATE", "description": "The webhook topic for `order_transactions/create` events. Occurs when a order transaction is created or when it's status is updated. Only occurs for transactions with a status of success, failure or error. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_CANCELLED", "description": "The webhook topic for `orders/cancelled` events. Occurs whenever an order is cancelled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_CREATE", "description": "The webhook topic for `orders/create` events. Occurs whenever an order is created. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_DELETE", "description": "The webhook topic for `orders/delete` events. Occurs whenever an order is deleted. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_EDITED", "description": "The webhook topic for `orders/edited` events. Occurs whenever an order is edited. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_FULFILLED", "description": "The webhook topic for `orders/fulfilled` events. Occurs whenever an order is fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_PAID", "description": "The webhook topic for `orders/paid` events. Occurs whenever an order is paid. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_PARTIALLY_FULFILLED", "description": "The webhook topic for `orders/partially_fulfilled` events. Occurs whenever an order is partially fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_UPDATED", "description": "The webhook topic for `orders/updated` events. Occurs whenever an order is updated. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_MOVED", "description": "The webhook topic for `fulfillment_orders/moved` events. Occurs whenever the location which is assigned to fulfill one or more fulfillment order line items is changed.\n\n* `original_fulfillment_order` - The final state of the original fulfillment order.\n* `moved_fulfillment_order` - The fulfillment order which now contains the re-assigned line items.\n* `source_location` - The original location which was assigned to fulfill the line items (available as of the `2023-04` API version).\n* `destination_location_id` - The ID of the location which is now responsible for fulfilling the line items.\n\n**Note:** The [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation)\nof the `original_fulfillment_order` might be changed by the move operation.\nIf you need to determine the originally assigned location, then you should refer to the `source_location`.\n\n[Learn more about moving line items](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentOrderMove).\n Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_HOLD_RELEASED", "description": "The webhook topic for `fulfillment_orders/hold_released` events. Occurs whenever a fulfillment order hold is released. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_SCHEDULED_FULFILLMENT_ORDER_READY", "description": "The webhook topic for `fulfillment_orders/scheduled_fulfillment_order_ready` events. Occurs whenever a fulfillment order which was scheduled becomes due. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_ORDER_ROUTING_COMPLETE", "description": "The webhook topic for `fulfillment_orders/order_routing_complete` events. Occurs when an order has finished being routed and it's fulfillment orders assigned to a fulfillment service's location. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_CANCELLED", "description": "The webhook topic for `fulfillment_orders/cancelled` events. Occurs when a fulfillment order is cancelled. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_FULFILLMENT_SERVICE_FAILED_TO_COMPLETE", "description": "The webhook topic for `fulfillment_orders/fulfillment_service_failed_to_complete` events. Occurs when a fulfillment service intends to close an in_progress fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED", "description": "The webhook topic for `fulfillment_orders/fulfillment_request_rejected` events. Occurs when a 3PL rejects a fulfillment request that was sent by a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_SUBMITTED", "description": "The webhook topic for `fulfillment_orders/cancellation_request_submitted` events. Occurs when a merchant requests a fulfillment request to be cancelled after that request was approved by a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_ACCEPTED", "description": "The webhook topic for `fulfillment_orders/cancellation_request_accepted` events. Occurs when a 3PL accepts a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED", "description": "The webhook topic for `fulfillment_orders/cancellation_request_rejected` events. Occurs when a 3PL rejects a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED", "description": "The webhook topic for `fulfillment_orders/fulfillment_request_submitted` events. Occurs when a merchant submits a fulfillment request to a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTED", "description": "The webhook topic for `fulfillment_orders/fulfillment_request_accepted` events. Occurs when a fulfillment service accepts a request to fulfill a fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_LOCAL_DELIVERY", "description": "The webhook topic for `fulfillment_orders/line_items_prepared_for_local_delivery` events. Occurs whenever a fulfillment order's line items are prepared for local delivery. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_PLACED_ON_HOLD", "description": "The webhook topic for `fulfillment_orders/placed_on_hold` events. Occurs when a fulfillment order is placed on hold. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_MERGED", "description": "The webhook topic for `fulfillment_orders/merged` events. Occurs when multiple fulfillment orders are merged into a single fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_SPLIT", "description": "The webhook topic for `fulfillment_orders/split` events. Occurs when a fulfillment order is split into multiple fulfillment orders. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_LISTINGS_ADD", "description": "The webhook topic for `product_listings/add` events. Occurs whenever an active product is listed on a channel. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_LISTINGS_REMOVE", "description": "The webhook topic for `product_listings/remove` events. Occurs whenever a product listing is removed from the channel. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_LISTINGS_UPDATE", "description": "The webhook topic for `product_listings/update` events. Occurs whenever a product publication is updated. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED_PRODUCT_LISTINGS_ADD", "description": "The webhook topic for `scheduled_product_listings/add` events. Occurs whenever a product is scheduled to be published. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED_PRODUCT_LISTINGS_UPDATE", "description": "The webhook topic for `scheduled_product_listings/update` events. Occurs whenever a product's scheduled availability date changes. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEDULED_PRODUCT_LISTINGS_REMOVE", "description": "The webhook topic for `scheduled_product_listings/remove` events. Occurs whenever a product is no longer scheduled to be published. Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_PUBLICATIONS_CREATE", "description": "The webhook topic for `product_publications/create` events. Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_PUBLICATIONS_DELETE", "description": "The webhook topic for `product_publications/delete` events. Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_PUBLICATIONS_UPDATE", "description": "The webhook topic for `product_publications/update` events. Occurs whenever a product publication is updated. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTS_CREATE", "description": "The webhook topic for `products/create` events. Occurs whenever a product is created. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTS_DELETE", "description": "The webhook topic for `products/delete` events. Occurs whenever a product is deleted. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCTS_UPDATE", "description": "The webhook topic for `products/update` events. Occurs whenever a product is updated, or whenever a product is ordered, or whenever a variant is added, removed, or updated. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "REFUNDS_CREATE", "description": "The webhook topic for `refunds/create` events. Occurs whenever a new refund is created without errors on an order, independent from the movement of money. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "SEGMENTS_CREATE", "description": "The webhook topic for `segments/create` events. Occurs whenever a segment is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SEGMENTS_DELETE", "description": "The webhook topic for `segments/delete` events. Occurs whenever a segment is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SEGMENTS_UPDATE", "description": "The webhook topic for `segments/update` events. Occurs whenever a segment is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ADDRESSES_CREATE", "description": "The webhook topic for `shipping_addresses/create` events. Occurs whenever a shipping address is created. Requires the `read_shipping` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHIPPING_ADDRESSES_UPDATE", "description": "The webhook topic for `shipping_addresses/update` events. Occurs whenever a shipping address is updated. Requires the `read_shipping` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SHOP_UPDATE", "description": "The webhook topic for `shop/update` events. Occurs whenever a shop is updated.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_PARTNERS_UPDATE", "description": "The webhook topic for `tax_partners/update` events. Occurs whenever a tax partner is created or updated. Requires the `read_taxes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_SERVICES_CREATE", "description": "The webhook topic for `tax_services/create` events. Occurs whenever a tax service is created. Requires the `read_taxes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "TAX_SERVICES_UPDATE", "description": "The webhook topic for `tax_services/update` events. Occurs whenver a tax service is updated. Requires the `read_taxes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "THEMES_CREATE", "description": "The webhook topic for `themes/create` events. Occurs whenever a theme is created. Does not occur when theme files are created. Requires the `read_themes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "THEMES_DELETE", "description": "The webhook topic for `themes/delete` events. Occurs whenever a theme is deleted. Does not occur when theme files are deleted. Requires the `read_themes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "THEMES_PUBLISH", "description": "The webhook topic for `themes/publish` events. Occurs whenever a theme with the main or mobile (deprecated) role is published. Requires the `read_themes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "THEMES_UPDATE", "description": "The webhook topic for `themes/update` events. Occurs whenever a theme is updated. Does not occur when theme files are updated. Requires the `read_themes` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANTS_IN_STOCK", "description": "The webhook topic for `variants/in_stock` events. Occurs whenever a variant becomes in stock. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIANTS_OUT_OF_STOCK", "description": "The webhook topic for `variants/out_of_stock` events. Occurs whenever a variant becomes out of stock. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_LEVELS_CONNECT", "description": "The webhook topic for `inventory_levels/connect` events. Occurs whenever an inventory level is connected. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_LEVELS_UPDATE", "description": "The webhook topic for `inventory_levels/update` events. Occurs whenever an inventory level is updated. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_LEVELS_DISCONNECT", "description": "The webhook topic for `inventory_levels/disconnect` events. Occurs whenever an inventory level is disconnected. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ITEMS_CREATE", "description": "The webhook topic for `inventory_items/create` events. Occurs whenever an inventory item is created. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ITEMS_UPDATE", "description": "The webhook topic for `inventory_items/update` events. Occurs whenever an inventory item is updated. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "INVENTORY_ITEMS_DELETE", "description": "The webhook topic for `inventory_items/delete` events. Occurs whenever an inventory item is deleted. Requires the `read_inventory` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS_ACTIVATE", "description": "The webhook topic for `locations/activate` events. Occurs whenever a deactivated location is re-activated. Requires the `read_locations` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS_DEACTIVATE", "description": "The webhook topic for `locations/deactivate` events. Occurs whenever a location is deactivated. Requires the `read_locations` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS_CREATE", "description": "The webhook topic for `locations/create` events. Occurs whenever a location is created. Requires the `read_locations` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS_UPDATE", "description": "The webhook topic for `locations/update` events. Occurs whenever a location is updated. Requires the `read_locations` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCATIONS_DELETE", "description": "The webhook topic for `locations/delete` events. Occurs whenever a location is deleted. Requires the `read_locations` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "TENDER_TRANSACTIONS_CREATE", "description": "The webhook topic for `tender_transactions/create` events. Occurs when a tender transaction is created. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_PURCHASES_ONE_TIME_UPDATE", "description": "The webhook topic for `app_purchases_one_time/update` events. Occurs whenever a one-time app charge is updated.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT", "description": "The webhook topic for `app_subscriptions/approaching_capped_amount` events. Occurs when the balance used on an app subscription crosses 90% of the capped amount.", "isDeprecated": false, "deprecationReason": null }, { "name": "APP_SUBSCRIPTIONS_UPDATE", "description": "The webhook topic for `app_subscriptions/update` events. Occurs whenever an app subscription is updated.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCALES_CREATE", "description": "The webhook topic for `locales/create` events. Occurs whenever a shop locale is created Requires the `read_locales` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "LOCALES_UPDATE", "description": "The webhook topic for `locales/update` events. Occurs whenever a shop locale is updated, such as published or unpublished Requires the `read_locales` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOMAINS_CREATE", "description": "The webhook topic for `domains/create` events. Occurs whenever a domain is created.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOMAINS_UPDATE", "description": "The webhook topic for `domains/update` events. Occurs whenever a domain is updated.", "isDeprecated": false, "deprecationReason": null }, { "name": "DOMAINS_DESTROY", "description": "The webhook topic for `domains/destroy` events. Occurs whenever a domain is destroyed.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_CREATE", "description": "The webhook topic for `subscription_contracts/create` events. Occurs whenever a subscription contract is created. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_UPDATE", "description": "The webhook topic for `subscription_contracts/update` events. Occurs whenever a subscription contract is updated. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_CREATE", "description": "The webhook topic for `subscription_billing_cycle_edits/create` events. Occurs whenever a subscription contract billing cycle is edited. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_UPDATE", "description": "The webhook topic for `subscription_billing_cycle_edits/update` events. Occurs whenever a subscription contract billing cycle edit is updated. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_DELETE", "description": "The webhook topic for `subscription_billing_cycle_edits/delete` events. Occurs whenever a subscription contract billing cycle edit is deleted. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROFILES_CREATE", "description": "The webhook topic for `profiles/create` events. Occurs whenever a delivery profile is created Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROFILES_UPDATE", "description": "The webhook topic for `profiles/update` events. Occurs whenever a delivery profile is updated Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", "isDeprecated": false, "deprecationReason": null }, { "name": "PROFILES_DELETE", "description": "The webhook topic for `profiles/delete` events. Occurs whenever a delivery profile is deleted Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS", "description": "The webhook topic for `subscription_billing_attempts/success` events. Occurs whenever a subscription billing attempt succeeds. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE", "description": "The webhook topic for `subscription_billing_attempts/failure` events. Occurs whenever a subscription billing attempt fails. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_ATTEMPTS_CHALLENGED", "description": "The webhook topic for `subscription_billing_attempts/challenged` events. Occurs when the financial instutition challenges the subscripttion billing attempt charge as per 3D Secure. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_CANCEL", "description": "The webhook topic for `returns/cancel` events. Occurs whenever a return is canceled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_CLOSE", "description": "The webhook topic for `returns/close` events. Occurs whenever a return is closed. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_REOPEN", "description": "The webhook topic for `returns/reopen` events. Occurs whenever a closed return is reopened. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_REQUEST", "description": "The webhook topic for `returns/request` events. Occurs whenever a return is requested. This means `Return.status` is `REQUESTED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_APPROVE", "description": "The webhook topic for `returns/approve` events. Occurs whenever a return is approved. This means `Return.status` is `OPEN`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_UPDATE", "description": "The webhook topic for `returns/update` events. Occurs whenever a return is updated. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "RETURNS_DECLINE", "description": "The webhook topic for `returns/decline` events. Occurs whenever a return is declined. This means `Return.status` is `DECLINED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "REVERSE_DELIVERIES_ATTACH_DELIVERABLE", "description": "The webhook topic for `reverse_deliveries/attach_deliverable` events. Occurs whenever a deliverable is attached to a reverse delivery.\nThis occurs when a reverse delivery is created or updated with delivery metadata.\nMetadata includes the delivery method, label, and tracking information associated with a reverse delivery.\n Requires at least one of the following scopes: read_returns, read_marketplace_returns.", "isDeprecated": false, "deprecationReason": null }, { "name": "REVERSE_FULFILLMENT_ORDERS_DISPOSE", "description": "The webhook topic for `reverse_fulfillment_orders/dispose` events. Occurs whenever a disposition is made on a reverse fulfillment order.\nThis includes dispositions made on reverse deliveries that are associated with the reverse fulfillment order.\n Requires at least one of the following scopes: read_returns, read_marketplace_returns.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_TERMS_CREATE", "description": "The webhook topic for `payment_terms/create` events. Occurs whenever payment terms are created. Requires the `read_payment_terms` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_TERMS_DELETE", "description": "The webhook topic for `payment_terms/delete` events. Occurs whenever payment terms are deleted. Requires the `read_payment_terms` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_TERMS_UPDATE", "description": "The webhook topic for `payment_terms/update` events. Occurs whenever payment terms are updated. Requires the `read_payment_terms` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PAYMENT_SCHEDULES_DUE", "description": "The webhook topic for `payment_schedules/due` events. Occurs whenever payment schedules are due. Requires the `read_payment_terms` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_GROUPS_CREATE", "description": "The webhook topic for `selling_plan_groups/create` events. Notifies when a SellingPlanGroup is created. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_GROUPS_UPDATE", "description": "The webhook topic for `selling_plan_groups/update` events. Notifies when a SellingPlanGroup is updated. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SELLING_PLAN_GROUPS_DELETE", "description": "The webhook topic for `selling_plan_groups/delete` events. Notifies when a SellingPlanGroup is deleted. Requires the `read_products` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "BULK_OPERATIONS_FINISH", "description": "The webhook topic for `bulk_operations/finish` events. Notifies when a Bulk Operation finishes.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_FEEDS_CREATE", "description": "The webhook topic for `product_feeds/create` events. Triggers when product feed is created Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_FEEDS_UPDATE", "description": "The webhook topic for `product_feeds/update` events. Triggers when product feed is updated Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_FEEDS_INCREMENTAL_SYNC", "description": "The webhook topic for `product_feeds/incremental_sync` events. Occurs whenever a product publication is created, updated or removed for a product feed Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "PRODUCT_FEEDS_FULL_SYNC", "description": "The webhook topic for `product_feeds/full_sync` events. Triggers when a full sync for a product feed is performed Requires the `read_product_listings` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETS_CREATE", "description": "The webhook topic for `markets/create` events. Occurs when a new market is created. Requires the `read_markets` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETS_UPDATE", "description": "The webhook topic for `markets/update` events. Occurs when a market is updated. Requires the `read_markets` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "MARKETS_DELETE", "description": "The webhook topic for `markets/delete` events. Occurs when a market is deleted. Requires the `read_markets` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_RISK_ASSESSMENT_CHANGED", "description": "The webhook topic for `orders/risk_assessment_changed` events. Triggers when a new risk assessment is available on the order.\nThis can be the first or a subsequent risk assessment.\nNew risk assessments can be provided until the order is marked as fulfilled.\nIncludes the risk level, risk facts and the provider. Does not include the risk recommendation for the order.\nThe order and shop are identified in the headers.\n Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "ORDERS_SHOPIFY_PROTECT_ELIGIBILITY_CHANGED", "description": "The webhook topic for `orders/shopify_protect_eligibility_changed` events. Occurs whenever Shopify Protect's eligibility for an order is changed. Requires the `read_orders` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_RESCHEDULED", "description": "The webhook topic for `fulfillment_orders/rescheduled` events. Triggers when a fulfillment order is rescheduled.\n\nFulfillment orders may be merged if they have the same `fulfillAt` datetime.\nIf the fulfillment order is merged then the resulting fulfillment order will be indicated in the webhook body.\nOtherwise it will be the original fulfillment order with an updated `fulfill_at` datetime.\n Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "PUBLICATIONS_DELETE", "description": "The webhook topic for `publications/delete` events. Occurs whenever a publication is deleted. Requires the `read_publications` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "AUDIT_EVENTS_ADMIN_API_ACTIVITY", "description": "The webhook topic for `audit_events/admin_api_activity` events. Triggers for each auditable Admin API request. This topic is limited to one active subscription per Plus store and requires the use of Google Cloud Pub/Sub or AWS EventBridge. Requires the `read_audit_events` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_PICKUP", "description": "The webhook topic for `fulfillment_orders/line_items_prepared_for_pickup` events. Triggers when one or more of the line items for a fulfillment order are prepared for pickup Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANIES_CREATE", "description": "The webhook topic for `companies/create` events. Occurs whenever a company is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANIES_UPDATE", "description": "The webhook topic for `companies/update` events. Occurs whenever a company is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANIES_DELETE", "description": "The webhook topic for `companies/delete` events. Occurs whenever a company is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATIONS_CREATE", "description": "The webhook topic for `company_locations/create` events. Occurs whenever a company location is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATIONS_UPDATE", "description": "The webhook topic for `company_locations/update` events. Occurs whenever a company location is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_LOCATIONS_DELETE", "description": "The webhook topic for `company_locations/delete` events. Occurs whenever a company location is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACTS_CREATE", "description": "The webhook topic for `company_contacts/create` events. Occurs whenever a company contact is created. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACTS_UPDATE", "description": "The webhook topic for `company_contacts/update` events. Occurs whenever a company contact is updated. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACTS_DELETE", "description": "The webhook topic for `company_contacts/delete` events. Occurs whenever a company contact is deleted. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOMERS_MERGE", "description": "The webhook topic for `customers/merge` events. Triggers when two customers are merged Requires the `read_customer_merge` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACT_ROLES_ASSIGN", "description": "The webhook topic for `company_contact_roles/assign` events. Occurs whenever a role is assigned to a contact at a location. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "COMPANY_CONTACT_ROLES_REVOKE", "description": "The webhook topic for `company_contact_roles/revoke` events. Occurs whenever a role is revoked from a contact at a location. Requires the `read_customers` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_ACTIVATE", "description": "The webhook topic for `subscription_contracts/activate` events. Occurs when a subscription contract is activated. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_PAUSE", "description": "The webhook topic for `subscription_contracts/pause` events. Occurs when a subscription contract is paused. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_CANCEL", "description": "The webhook topic for `subscription_contracts/cancel` events. Occurs when a subscription contract is canceled. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_FAIL", "description": "The webhook topic for `subscription_contracts/fail` events. Occurs when a subscription contract is failed. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_CONTRACTS_EXPIRE", "description": "The webhook topic for `subscription_contracts/expire` events. Occurs when a subscription contract expires. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_CYCLES_SKIP", "description": "The webhook topic for `subscription_billing_cycles/skip` events. Occurs whenever a subscription contract billing cycle is skipped. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION_BILLING_CYCLES_UNSKIP", "description": "The webhook topic for `subscription_billing_cycles/unskip` events. Occurs whenever a subscription contract billing cycle is unskipped. Requires the `read_own_subscription_contracts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECTS_CREATE", "description": "The webhook topic for `metaobjects/create` events. Occurs when a metaobject is created. Requires the `read_metaobjects` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECTS_UPDATE", "description": "The webhook topic for `metaobjects/update` events. Occurs when a metaobject is updated. Requires the `read_metaobjects` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "METAOBJECTS_DELETE", "description": "The webhook topic for `metaobjects/delete` events. Occurs when a metaobject is deleted. Requires the `read_metaobjects` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNTS_CREATE", "description": "The webhook topic for `discounts/create` events. Occurs whenever a discount is created. Requires the `read_discounts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNTS_UPDATE", "description": "The webhook topic for `discounts/update` events. Occurs whenever a discount is updated. Requires the `read_discounts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNTS_DELETE", "description": "The webhook topic for `discounts/delete` events. Occurs whenever a discount is deleted. Requires the `read_discounts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNTS_REDEEMCODE_ADDED", "description": "The webhook topic for `discounts/redeemcode_added` events. Occurs whenever a redeem code is added to a code discount. Requires the `read_discounts` scope.", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCOUNTS_REDEEMCODE_REMOVED", "description": "The webhook topic for `discounts/redeemcode_removed` events. Occurs whenever a redeem code on a code discount is deleted. Requires the `read_discounts` scope.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "WebhookSubscriptionUpdatePayload", "description": "Return type for `webhookSubscriptionUpdate` mutation.", "fields": [ { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "webhookSubscription", "description": "The webhook subscription that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "WebhookSubscription", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Weight", "description": "A weight, which includes a numeric value and a unit of measurement.", "fields": [ { "name": "unit", "description": "The unit of measurement for `value`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WeightUnit", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The weight value using the unit system specified with `unit`.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WeightInput", "description": "The input fields for the weight unit and value inputs.\n", "fields": null, "inputFields": [ { "name": "value", "description": "The weight value using the unit system specified with `weight_unit`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "unit", "description": "Unit of measurement for `value`.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WeightUnit", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "WeightUnit", "description": "Units of measurement for weight.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "KILOGRAMS", "description": "1 kilogram equals 1000 grams.", "isDeprecated": false, "deprecationReason": null }, { "name": "GRAMS", "description": "Metric system unit of mass.", "isDeprecated": false, "deprecationReason": null }, { "name": "POUNDS", "description": "1 pound equals 16 ounces.", "isDeprecated": false, "deprecationReason": null }, { "name": "OUNCES", "description": "Imperial system unit of mass.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "__Directive", "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", "fields": [ { "name": "args", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isRepeatable", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "__DirectiveLocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "onField", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `locations`." }, { "name": "onFragment", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `locations`." }, { "name": "onOperation", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `locations`." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "__DirectiveLocation", "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "QUERY", "description": "Location adjacent to a query operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUTATION", "description": "Location adjacent to a mutation operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION", "description": "Location adjacent to a subscription operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIELD", "description": "Location adjacent to a field.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAGMENT_DEFINITION", "description": "Location adjacent to a fragment definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAGMENT_SPREAD", "description": "Location adjacent to a fragment spread.", "isDeprecated": false, "deprecationReason": null }, { "name": "INLINE_FRAGMENT", "description": "Location adjacent to an inline fragment.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEMA", "description": "Location adjacent to a schema definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCALAR", "description": "Location adjacent to a scalar definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT", "description": "Location adjacent to an object type definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIELD_DEFINITION", "description": "Location adjacent to a field definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ARGUMENT_DEFINITION", "description": "Location adjacent to an argument definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERFACE", "description": "Location adjacent to an interface definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNION", "description": "Location adjacent to a union definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM", "description": "Location adjacent to an enum definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM_VALUE", "description": "Location adjacent to an enum value definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_OBJECT", "description": "Location adjacent to an input object type definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_FIELD_DEFINITION", "description": "Location adjacent to an input object field definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIABLE_DEFINITION", "description": "Location adjacent to a variable definition.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "__EnumValue", "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", "fields": [ { "name": "deprecationReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDeprecated", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPrivatelyDocumented", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Field", "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", "fields": [ { "name": "accessRestricted", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "accessRestrictedReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "args", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deprecationReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDeprecated", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPrivatelyDocumented", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isProtected", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "protectedContent", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "protectedSubject", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiredAccess", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__InputValue", "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", "fields": [ { "name": "defaultValue", "description": "A GraphQL-formatted string representing the default value for this input value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deprecationReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gidTypes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDeprecated", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Schema", "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", "fields": [ { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "directives", "description": "A list of all directives supported by this server.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Directive", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mutationType", "description": "If this server supports mutation, the type that mutation operations will be rooted at.", "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryType", "description": "The type that query operations will be rooted at.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionType", "description": "If this server support subscription, the type that subscription operations will be rooted at.", "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "types", "description": "A list of all types supported by this server.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Type", "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", "fields": [ { "name": "accessRestricted", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "accessRestrictedReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "componentName", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enumValues", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__EnumValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fields", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Field", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inputFields", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interfaces", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isOneOf", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isPrivatelyDocumented", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isProtected", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "kind", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "__TypeKind", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "ofType", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "possibleTypes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "protectedSubject", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requiredAccess", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "specifiedByURL", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "__TypeKind", "description": "An enum describing what kind of type a given `__Type` is.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SCALAR", "description": "Indicates this type is a scalar.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT", "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERFACE", "description": "Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNION", "description": "Indicates this type is a union. `possibleTypes` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM", "description": "Indicates this type is an enum. `enumValues` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_OBJECT", "description": "Indicates this type is an input object. `inputFields` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST", "description": "Indicates this type is a list. `ofType` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_NULL", "description": "Indicates this type is a non-null. `ofType` is a valid field.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "deliveryProfileCreatePayload", "description": "Return type for `deliveryProfileCreate` mutation.", "fields": [ { "name": "profile", "description": "The delivery profile that was created.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "deliveryProfileRemovePayload", "description": "Return type for `deliveryProfileRemove` mutation.", "fields": [ { "name": "job", "description": "The delivery profile deletion job triggered by the mutation.", "args": [], "type": { "kind": "OBJECT", "name": "Job", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "deliveryProfileUpdatePayload", "description": "Return type for `deliveryProfileUpdate` mutation.", "fields": [ { "name": "profile", "description": "The delivery profile that was updated.", "args": [], "type": { "kind": "OBJECT", "name": "DeliveryProfile", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "userErrors", "description": "The list of errors that occurred from executing the mutation.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "UserError", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null } ], "directives": [ { "name": "include", "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", "locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"], "args": [ { "name": "if", "description": "Included when true.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ] }, { "name": "skip", "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", "locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"], "args": [ { "name": "if", "description": "Skipped when true.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ] }, { "name": "deprecated", "description": "Marks an element of a GraphQL schema as no longer supported.", "locations": [ "FIELD_DEFINITION", "ENUM_VALUE", "ARGUMENT_DEFINITION", "INPUT_FIELD_DEFINITION" ], "args": [ { "name": "reason", "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in [Markdown](https://daringfireball.net/projects/markdown/).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"No longer supported\"" } ] }, { "name": "oneOf", "description": "Requires that exactly one field must be supplied and that field must not be `null`.", "locations": ["INPUT_OBJECT"], "args": [] }, { "name": "specifiedBy", "description": "Exposes a URL that specifies the behavior of this scalar.", "locations": ["SCALAR"], "args": [ { "name": "url", "description": "The URL that specifies the behavior of this scalar.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ] }, { "name": "accessRestricted", "description": "Marks an element of a GraphQL schema as having restricted access.", "locations": ["FIELD_DEFINITION", "OBJECT"], "args": [ { "name": "reason", "description": "Explains the reason around this restriction", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "null" } ] } ] } }, "extensions": { "cost": { "requestedQueryCost": 71, "actualQueryCost": 71, "throttleStatus": { "maximumAvailable": 2000, "currentlyAvailable": 1929, "restoreRate": 100 } } } }