| Release date | Date version is no longer supported |
|---|---|
| July 1, 2021 | July 1, 2022 |
As of API version 2021-07, the uploadedImages connection on the GraphQL Admin Shop object type has been deprecated. The connection previously represented all images that were uploaded to a shop.
You can use the uploadedImagesbyIds field instead to retrieve a list of images by ID that have been uploaded to the shop.
Prior to API version 2021-07, a selling plan group could exist without any selling plans. Apps could create a selling plan group with selling plans, and subsequently delete all selling plans in the group. This was problematic because empty selling plan groups could result in undesirable behavior on the product page and a broken cart experience.
As of API version 2021-07, we've added a validation to the sellingPlanGroupUpdate mutation that prevents the presence of empty selling plan groups.
Apps update the pricing policies associated with a selling plan using the sellingPlanGroupUpdate mutation. Prior to API version 2021-07, two key behaviors existed:
sellingPlanGroupUpdate mutation.As of API version 2021-07, apps must explicitly provide the end state of all pricing policies in the sellingPlanGroupUpdate mutation's input. For example, if you have a selling plan with an existing fixed pricing policy, and you want to add a recurring pricing policy, then you need to supply both the existing and new pricing policy in the mutation's input.
To delete all pricing policies from a selling plan, you need to supply an empty array of pricing policies (pricingPolicies: []) in the sellingPlanGroupUpdate mutation's input.
As of API version 2021-07, the value_type field on the Metafield object has been deprecated.
You should use the type field instead of the value_type field to access or set the type of a Metafield object. For more information about this transition, refer to this changelog entry.
You can set the type field of the Metafield object using any of the new values introduced below.
New fields
type field was added to object MetafieldNew values
single_line_text_field value was added to object Metafieldmulti_line_text_field value was added to object Metafieldpage_reference value was added to object Metafieldproduct_reference value was added to object Metafieldvariant_reference value was added to object Metafieldfile_reference value was added to object Metafieldnumber_integer value was added to object Metafieldnumber_decimal value was added to object Metafielddate value was added to object Metafielddate_time value was added to object Metafieldurl value was added to object Metafieldjson value was added to object Metafieldboolean value was added to object Metafieldcolor value was added to object Metafieldweight value was added to object Metafieldvolume value was added to object Metafielddimension value was added to object Metafieldurl value was added to object MetafieldAs of API version 2021-07, you can use the GraphQL Admin API to query whether the duties and international taxes associated with an order were charged at checkout.
New fields
international_duties field was added to object FulfillmentOrderNew types
FulfillmentOrderInternationalDuties object was addedAs of API version 2021-07, you can use the estimatedTaxes field on the Order object to determine whether taxes on an order are estimated.
The field returns false when taxes on an order are finalized and aren't subject to any changes.
New field
estimatedTaxes field was added to Order objectAs of API version 2021-07, you can use the customerPaymentMethodRemoteCreate mutation to associate a Shopify customer ID with an Authorize.net customer profile ID and payment method ID.
For more information on configuring payment gateways to work with subscriptions, refer to Migrating existing subscription contracts to Shopify.
New types
customerPaymentMethodRemoteCreate mutation was addedCustomerPaymentMethodRemoteUserError was addedAs of API version 2021-07, you can use the GraphQL Admin API to create, update, and delete generic files and images using the Files API. This functionality allows merchants to reuse files for different apps.
New mutations
FileCreate mutation was addedFileDelete mutation was addedFileUpdate mutation was addedNew types
FileError object was addedGenericFile object was addedFileCreateInput input object was addedFileUpdateInput input object was addedFile interface was addedFileContentType enum was addedFileErrorCode enum was addedfile_storage_limit_exceeded error code was added to enum MediaErrorCodegeneric_file_download_failure error code was added to enum MediaErrorCodegeneric_file_invalid_size error code was added to enum MediaErrorCodeinvalid_image_aspect_ratio error code was added to enum MediaErrorCodeinvalid_image_resolution error code was added to enum MediaErrorCodeNew errors
FilesUserError error was addedNew fields
FileStatus field was added to Media interfaceNew connections
file_saved_searches connection added to object QueryRootfiles connection added to object QueryRootNew values
FILE value was added to enum UploadResourceFile value was added to enum SearchResultTypeAs of API version 2021-07, you can use the GraphQL Admin API to bulk import large volumes of data asychronously. By running a bulk mutation operation, you can avoid manually running a GraphQL mutation multiple times and managing a client-side throttle.
To learn more about bulk importing data asynchronously, refer to Bulk import data with the GraphQL Admin API.
New mutation
bulkOperationRunMutation mutation was addedNew types
BulkOperationType enum was addedBulkMutationUserError type was addedcurrentBulkOperation connection was added to object QueryRootBULK_MUTATION_VARIABLES value was added to enum StagedUploadTargetGenerateUploadResourceAs of API version 2021-07, you can create, update, and delete multiple product variants at once using 3 new product variant mutations.
Previously, multiple product variants could be managed at once only through the productCreate and productUpdate mutations, which required additional input to avoid overwriting existing variants.
New mutations
productVariantsBulkCreate mutation was addedproductVariantsBulkUpdate mutation was addedproductVariantsBulkDelete mutation was addedproductVariantsBulkReorder mutation was addedNew types
ProductVariantsBulkInput input object was addedProductVariantsBulkCreateUserError was addedProductVariantsBulkUpdateUserError was addedProductVariantsBulkDeleteUserError was addedAs of API version 2021-07, you can use the GraphQL Admin API and Google Cloud Pub/Sub to manage webhook subscriptions.
New mutations
pubSubWebhookSubscriptionCreate mutation was addedpubSubWebhookSubscriptionUpdate mutation was addedNew input
pubSubWebhookSubscriptionInput was addedNew type
WebhookPubSubEndpoint object was addedPubSubWebhookSubscriptionInput was addedPubSubWebhookSubscriptionCreatePayload was addedPubSubWebhookSubscriptionUpdatePayload was addedAs of API version 2021-07, you can use the GraphQL Admin API to manage redirects on an online store.
URL redirects can be used to redirect traffic from one web page to another. For example, if you delete a product, then you can set up a URL redirect so that when customers enter the URL for that product, they are redirected to a similar product on an online store.
New mutations
UrlRedirectBulkDeleteAll mutation was addedUrlRedirectBulkDeleteByIds mutation was addedUrlRedirectBulkDeleteBySavedSearch mutation was addedUrlRedirectBulkDeleteBySearch mutation was addedUrlRedirectCreate mutation was addedUrlRedirectDelete mutation was addedUrlRedirectImportCreate mutation was addedUrlRedirectImportSubmit mutation was addedUrlRedirectUpdate mutation was addedNew types
UrlRedirect object was addedUrlRedirectImport object was addedUrlRedirectImportPreview object was addedUrlRedirectInput input object was addedUrlRedirectImportUserError type was addedUrlRedirectUserError type was addedNew fields
urlRedirect field was added to object QueryRooturlRedirectSavedSearches field was added to object QueryRooturlRedirectImport field was added to object QueryRootNew connections
urlRedirects connection was added to object QueryRootNew values
urlRedirects value was added to enum ResourceTypeurlRedirects value was added to enum ResourceExportableTypeurlRedirect value was added to enum SearchResultTypeAs of API version 2021-07, the GraphQL Admin API returns XXX in response to an unrecognized currency code. XXX is the ISO code used to denote transactions that involve no currency.
In mutations, a CurrencyCode input value of XXX is invalid. XXX can only be returned as a result and not as an input value.
This change prevents order pages from breaking if payments include a currency code that's not in the list of valid values for the CurrencyCode object.
As of API version 2021-07, you can use the channelLiable field on the TaxLine object to determine whether the channel that submitted the tax line is liable for remitting.
A value of null indicates unknown liability for the tax line.
New field
channelLiable field was added to the TaxLine objectAs of API version 2021-07, you can display whether a product is in stock and available for local pickup using the Storefront API. Customers can then pick up their online orders at a retail store, curbside, or any location that a merchant chooses.
For more information, refer to Support local pickup on storefronts.
New types
Location object was addedStoreAvailability object was addedlocations connection was added to QueryRootpreferredLocationId argument was added to InContext directiveAs of API version 2021-07, you can use the Storefront API to retrieve subscription products on a storefront. Subscription products can be accessed from the sellingPlans object.
To learn how to retrieve information about selling plans, including price adjustments and selling plan allocations, and creating a cart with a subscription line item, refer to Manage subscription products on storefronts.
New types
SellingPlanAllocation object was addedSellingPlanPriceAdjustment object was addedSellingPlanAllocationPriceAdjustment object was addedSellingPlanFixedAmountPriceAdjustment object was addedSellingPlanPercentagePriceAdjustment object was addedSellingPlanGroupOption object was addedSellingPlanGroup object was addedSellingPlan object was addedsellingPlanAllocations connection was added to ProductVariant objectrequiresSellingPlan field was added to Product objectSellingPlanPriceAdjustmentValue union was addedAs of API version 2021-07, the Storefront API can be used for checkouts during a flash sale.
The checkoutCreate mutation now accepts an optional queueToken argument, which allows apps to bypass the checkout throttle after they have completed polling.
Previously, when a checkout queue was in use, apps calling the checkoutCreate mutation received a Throttled response. There was no way for apps to bypass the queue, and the only option was to wait for the queue to disengage before retrying the request again.
The queue now engages as soon as the rate per second threshold is crossed.
New types
queueToken argument was added to CheckoutCreate mutationqueueToken return field was added to CheckoutCreate mutationTHROTTLED_DURING_CHECKOUT error was added to CheckoutUserErrorEXPIRED_QUEUE_TOKEN error was added to CheckoutUserErrorINVALID_QUEUE_TOKEN error was added to CheckoutUserErrorAs of API version 2021-07, you can use the Storefront API to retrieve a list of available countries and corresponding currencies for a store.
New types
Localization object was addedCountry object was addedCurrency object was addedThe prices that display in a storefront can vary based on the customer's location. As of API version 2021-07, you can use the Storefront API to query international prices for products and orders, and explicitly set the context of a checkout.
International pricing is determined based on the customer's shipping address and is enforced at checkout.
New types
inContext directive was addedCheckoutBuyerIdentity object was addedCheckoutBuyerIdentityInput input object was addedINVALID_COUNTRY_AND_CURRENCY error code was added to CheckoutUserErrorNew fields
buyerIdentity field was added to Checkout objectbuyerIdentity input argument was added to checkoutCreate mutationAs of API version 2021-07, the GraphQL Storefront API supports metafields on additional resources. You can retrieve metafields with the Storefront API to access additional information from different types of resources.
Previously, metafields were only supported on the Product and ProductVariant resources.
New types
The following types now also support metafields:
Article object was added to MetafieldParentResource unionBlog object was added to MetafieldParentResource unionCollection object was added to MetafieldParentResource unionCustomer object was added to MetafieldParentResource unionOrder object was added to MetafieldParentResource unionPage object was added to MetafieldParentResource unionShop object was added to MetafieldParentResource unionAs of API version 2021-07, the Storefront API returns XXX in response to an unrecognized currency code. XXX is the ISO code used to denote transactions that involve no currency.
In mutations, a CurrencyCode input value of XXX is invalid. XXX can only be returned as a result and not as an input value.
This change prevents order pages from breaking if payments include a currency code that's not in the list of valid values for the CurrencyCode object.
As of API version 2021-07, you can use new mutations to reject or resolve an open capture session.
New type
CaptureSession object was addedNew mutations
captureSessionReject mutation was addedcaptureSessionResolve mutation was addedAs of API version 2021-07, you can use new mutations to reject or resolve a void session.
New type
VoidSession object was addedNew mutations
voidSessionReject mutation was addedvoidSessionResolve mutation was addedAs of API version 2021-07, a new argument authorizationExpiresAt can be included with the paymentSessionResolve mutation.
New field
authorizationExpiresAt field was added to PaymentSession objectNew argument
authorizationExpiresAt argument was added to paymentSessionResolve mutationAs of API version 2021-07, the force_ssl field on the REST Shop resource has been removed. Previously, this field had indicated whether requests made to the REST Shop resource connected over SSL using HTTPS. All requests now use HTTPS, so force_ssl is always true.
Removed fields
force_ssl field was removed from Shop resourceforce_ssl field was removed from shop/update webhook topicforce_ssl field was removed from app/uninstalled webhook topicAs of API version 2021-07, the complete list of explicit permissions that a user with the full permission has access to is returned in the permissions property of the REST User resource.
New values
The following new values have also been added to the permissions property:
billing_charges: The user can view and export billing charges.billing_invoices_view: The user can view billing invoices.billing_payment_methods_view: The user can view billing payment methods.staff_management_activation: The user can activate or deactivate staff in the store.staff_management_create: The user can add staff to the store.staff_management_delete: The user can delete staff from the store.As of API version 2021-07, the value_type property on the Metafield resource has been deprecated.
You should use the type property instead of the value_type property to access or set the type of a Metafield resource. For more information about this transition, refer to this changelog entry.
You can set the type property of the Metafield resource using any of the new values introduced below.
New properties
type property was added to resource MetafieldNew values
single_line_text_field value was added to resource Metafieldmulti_line_text_field value was added to resource Metafieldpage_reference value was added to resource Metafieldproduct_reference value was added to resource Metafieldvariant_reference value was added to resource Metafieldfile_reference value was added to resource Metafieldnumber_integer value was added to resource Metafieldnumber_decimal value was added to resource Metafielddate value was added to resource Metafielddate_time value was added to resource Metafieldurl value was added to resource Metafieldjson value was added to resource Metafieldboolean value was added to resource Metafieldcolor value was added to resource Metafieldweight value was added to resource Metafieldvolume value was added to resource Metafielddimension value was added to resource Metafieldurl value was added to resource MetafieldAs of API version 2021-07, you can use the FulfillmentOrder resource to retrieve information about whether the duties and international taxes associated with an order were charged at checkout.
New properties
international_duties property was added to resource FulfillmentOrderAs of API version 2021-07, you can use the estimated_taxes property on the REST Order resource to determine whether taxes on an order are estimated.
The property returns false when taxes on an order are finalized and aren't subject to any changes.
New property
estimated_taxes property was added to Order resourceAs of API version 2021-07, you can use the channel_liable property on the Order and Abandoned checkouts resources to determine whether the channel that submitted the tax line is liable for remitting.
A value of null indicates unknown liability for the tax line.
New properties
channel_liable property was added to Order resourcechannel_liable property was added to Abandoned checkouts resource