2019-07 release notes

The 2019-07 release focuses on improving performance by removing page-based pagination and introducing a more efficient way to paginate through resources using cursor-based pagination. Cursor-based pagination has been implemented across various endpoints, and more are expected to support cursor-paged pagination in upcoming versions.

The GraphQL Admin API is growing in 2019-07. Among some of the GraphQL API changes is the introduction of delivery profiles, which now gives developers the ability to set per-product and per-location shipping rules. Support for billing and automatic discounting is also now available in GraphQL. Metafields can now be accessed and published to the Storefront API in 2019-07.

What’s new in 2019-07

• Storefront API was added to our admin versioning scheme

• Page-based pagination has been replaced by cursor-based pagination across multiple REST endpoints

• Delivery profiles was added to allow you to set per-product and per-location shipping rules

• Added GraphQL support for billing

• Improved sorting of metafields

• Improved interoperability for consuming webhook data with the addition GraphQL Admin API IDs

• Metafields were made available through Storefront API

• New discount types added in GraphQL

  Below are all the changes introduced to the REST Admin API, the GraphQL Admin API, and the Storefront API in 2019-07.

Anchor to Breaking changesBreaking changes

These changes require special attention as failure to migrate can result in broken requests in the future.

Anchor to PaginationPagination

Page-based pagination has been removed, and has been replaced with cursor-based pagination on many endpoints.

To migrate, see our guide on cursor-based pagination.

Anchor to Featured field removed from CollectFeatured field removed from Collect

The featured field was removed from the collect endpoint.

To migrate, update the URL of all your requests to the collect endpoint to API version 2019-07 or later.

Anchor to GraphQL Admin ID added to webhooksGraphQL Admin ID added to webhooks

Added the admin_graphql_api_id property to webhook payloads for many resources.

Anchor to Developer previewDeveloper preview

There is no developer preview for the API changes in version 2019-07. Use a development store for your development environments.

To use the new API features, call the 2019-07 version of the API.

Anchor to REST Admin API changesREST Admin API changes

Anchor to [object Object]Abandoned checkouts

• Added new route /admin/api/2019-07/abandoned_checkouts.json to access the Abandoned checkouts API.

Anchor to ArticleSavedSearchArticleSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/article_saved_searches.json.

Anchor to BalanceTransactionSavedSearchBalanceTransactionSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/balance_transaction_saved_searches.json.

Anchor to BlogSavedSearchBlogSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/blog_saved_searches.json.

Anchor to [object Object]Checkout

• Removed the X-Shopify-Checkout-Version header support from GET /admin/checkouts.json.

Anchor to CheckoutSavedSearchCheckoutSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/checkout_saved_searches.json.

Anchor to [object Object]Collect

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/collects.json.
• Removed the featured property.

Anchor to [object Object]CollectionListing

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/collection_listings.json.
• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/collection_listings/#{collection_listing_id}/product_ids.json.

Anchor to CollectionsCollections

• Requests that pass a value for title will match only if the value is the same as the complete title. Partial matches aren't supported.
• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/collections.json.

Anchor to CollectionSavedSearchCollectionSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/collection_saved_searches.json.

Anchor to CommentSavedSearchCommentSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/comment_saved_searches.json.

Anchor to [object Object]Country

• Removed the ability to update a province's code.

Anchor to [object Object]Customer

• Added tax_exemptions property.

Anchor to CustomerSavedSearchCustomerSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/customer_saved_searches.json.

Anchor to DiscountCodeSavedSearchDiscountCodeSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/discount_code_saved_searches.json.

Anchor to DraftOrderSavedSearchDraftOrderSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/draft_order_saved_searches.json.

Anchor to [object Object]Event

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/events.json.

Anchor to FileSavedSearchFileSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/file_saved_searches.json.

Anchor to GiftCardSavedSearchGiftCardSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/gift_card_saved_searches.json.

Anchor to InventoryTransferSavedSearchInventoryTransferSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/inventory_transfer_saved_searches.json.

Anchor to [object Object]Metafield

• By default, metafields are now sorted by ID instead of namespace and key.
• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/metafields.json.

Anchor to OrderSavedSearchOrderSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/order_saved_searches.json.

Anchor to PageSavedSearchPageSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/page_saved_searches.json.

Anchor to PriceRuleSavedSearchPriceRuleSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/price_rule_saved_searches.json.

Anchor to [object Object]Product

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/products.json.
• Requests that pass a value for title will match only if the value is the same as the complete title. Partial matches aren't supported.

Anchor to [object Object]ProductListing

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/product_listings.json.

Anchor to ProductSavedSearchProductSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/product_saved_searches.json.

Anchor to [object Object]ProductVariant

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/variants/search.json.

Anchor to ProductVariantSavedSearchProductVariantSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/product_variant_saved_searches.json.

Anchor to [object Object]Province

• Removed the ability to update a province's code.

Anchor to RedirectSavedSearchRedirectSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/redirect_saved_searches.json.

Anchor to [object Object]ShippingZone

• Added profile_id, location_group_id, and admin_graphql_api_id properties. Learn more.

Anchor to TransferSavedSearchTransferSavedSearch

• Removed the page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-07/transfer_saved_searches.json.

Anchor to [object Object]Webhook

• Added the admin_graphql_api_id property to webhook payloads for many resources for easier interoperability. The property returns the resource's GraphQL Admin API ID in the global ID format: gid://shopify/Order/1234.

Anchor to GraphQL Admin API changesGraphQL Admin API changes

Anchor to Schema changesSchema changes

Anchor to Changes to QueryRootChanges to QueryRoot

The following fields were added

• activatedCarrierServices
• availableCarrierServices
• automaticDiscounts
• automaticDiscountSavedSearches
• automaticDiscountNodes
• automaticDiscountNode
• automaticDiscount
• carrierService
• codeDiscountSavedSearches
• codeDiscountNodes
• codeDiscountNode
• codeDiscountNodeByCode
• deliveryProfile
• deliveryProfiles
• deliverySettings
• locationsAvailableForDeliveryProfiles
• metafieldStorefrontVisibilities
• metafieldStorefrontVisibility

Anchor to Changes to objectsChanges to objects

The following fields were added

• activeSubscriptions was added to AppInstallation

• activityListUrl was added to MarketingActivity

• allSubscriptions was added to AppInstallation

• createdAt was added to ShopifyPaymentsBankAccount

• credits was added to AppInstallation

• deliveryProfiles was added to ShopFeatures

• duplicateSkuCount was added to InventoryItem

• oneTimePurchases was added to AppInstallation

• ownerType was added to Metafield

• subscriptions was added to AppInstallation

  The following objects were added

• AppCredit

• AppPlanV2

• AppPricingDetails

• AppPurchase

• AppPurchaseOneTime

• AppRecurringPricing

• AppSubscription

• AppSubscriptionLineItem

• AppUsagePricing

• AppUsageRecord

• AutomaticDiscountApplication

• DeliveryAvailableService

• DeliveryCarrierService

• DeliveryCarrierServiceAndLocations

• DeliveryCondition

• DeliveryConditionCriteria

• DeliveryCountry

• DeliveryCountryAndZone

• DeliveryCountryCodesOrRestOfWorld

• DeliveryLocationGroup

• DeliveryLocationGroupZone

• DeliveryMethodDefinition

• DeliveryParticipant

• DeliveryParticipantService

• DeliveryProfile

• DeliveryProfileItem

• DeliveryProfileLocationGroup

• DeliveryProvince

• DeliveryRateDefinition

• DeliveryRateProvider

• DeliverySetting

• DeliveryZone

• DiscountUserError

• DiscountErrorCode

• CodeDiscountSortKeys

• DiscountCountryAll

• DiscountCountries

• DiscountShippingDestinationSelection

• DiscountCodeFreeShipping

• DiscountCodeBxgy

• DiscountCustomers

• DiscountCustomerSavedSearches

• DiscountCustomerAll

• DiscountCustomerSelection

• DiscountRedeemCode

• DiscountCodeBasic

• DiscountCode

• DiscountCodeNode

• AutomaticDiscountSortKeys

• DiscountAutomaticNode

• DiscountCustomerBuysValue

• DiscountAutomaticBxgy

• DiscountStatus

• DiscountMinimumSubtotal

• DiscountMinimumQuantity

• DiscountMinimumRequirement

• DiscountQuantity

• DiscountPercentage

• DiscountEffect

• DiscountOnQuantity

• DiscountAmount

• DiscountCustomerGetsValue

• DiscountProducts

• DiscountCollections

• AllDiscountItems

• DiscountItems

• DiscountCustomerGets

• DiscountAutomaticBasic

• DiscountAutomatic

• MetafieldStorefrontVisibility

Anchor to Changes to input objectsChanges to input objects

The following fields were added

• metafields was added to CollectionInput

• metafields was added to OrderInput

• title was added to MarketingActivityUpdateInput

  The following input objects were added

• AppPlanInput

• AppRecurringPricingInput

• AppSubscriptionLineItemInput

• AppUsagePricingInput

• DeliveryCountryInput

• DeliveryLocationGroupZoneInput

• DeliveryMethodDefinitionInput

• DeliveryParticipantInput

• DeliveryParticipantServiceInput

• DeliveryPriceConditionInput

• DeliveryProfileInput

• DeliveryProfileLocationGroupInput

• DeliveryProvinceInput

• DeliveryRateDefinitionInput

• DeliverySettingInput

• DeliveryUpdateConditionInput

• DeliveryWeightConditionInput

• DiscountCodeFreeShippingInput

• DiscountCountriesInput

• DiscountEffectInput

• DiscountShippingDestinationSelectionInput

• DiscountCodeBxgyInput

• DiscountCustomersInput

• DiscountCustomerSavedSearchesInput

• DiscountCustomerSelectionInput

• DiscountCodeBasicInput

• DiscountCustomerBuysValueInput

• DiscountCustomerBuysInput

• DiscountAutomaticBxgyInput

• DiscountMinimumSubtotalInput

• DiscountMinimumQuantityInput

• DiscountMinimumRequirementInput

• DiscountOnQuantityInput

• DiscountAmountInput

• DiscountCustomerGetsValueInput

• DiscountProductsInput

• DiscountCollectionsInput

• DiscountItemsInput

• DiscountCustomerGetsInput

• DiscountAutomaticBasicInput

• MetafieldStorefrontVisibilityInput

Anchor to Changes to mutationsChanges to mutations

The following mutations were added

• appCreditCreate
• appPurchaseOneTimeCreate
• appSubscriptionCancel
• appSubscriptionCreate
• appSubscriptionLineItemUpdate
• appUsageRecordCreate
• deliveryProfileCreate
• deliveryProfileRemove
• deliveryProfileUpdate
• deliverySettingUpdate
• discountCodeFreeShippingUpdate
• discountCodeFreeShippingCreate
• discountCodeDelete
• discountCodeDeActivate
• discountCodeBxgyUpdate
• discountCodeBxgyCreate
• discountCodeBasicUpdate
• discountCodeBasicCreate
• discountCodeActivate
• discountAutomaticDelete
• discountAutomaticDeActivate
• discountAutomaticBxgyUpdate
• discountAutomaticBxgyCreate
• discountAutomaticBulkDelete
• discountAutomaticBasicUpdate
• discountAutomaticBasicCreate
• discountAutomaticActivate
• kitSkillTriggerRequest
• metafieldStorefrontVisibilityCreate
• metafieldStorefrontVisibilityDelete
• shippingPackageDelete
• shippingPackageMakeDefault
• shippingPackageUpdate

Anchor to Changes to enumsChanges to enums

The following enum values were added

• APP_PURCHASES_ONE_TIME_UPDATE was added to WebhookSubscriptionTopic

• APP_SUBSCRIPTIONS_UPDATE was added to WebhookSubscriptionTopic

• DISCOUNTS_AUTOMATIC was added to ResourceExportableType

• DISCOUNTS_AUTOMATIC was added to ResourceType

  The following enum types were added

• AppPricingInterval

• AppPurchaseStatus

• AppSubscriptionSortKeys

• AppSubscriptionStatus

• AppTransactionSortKeys

• AppUsageRecordSortKeys

• DeliveryConditionField

• DeliveryConditionOperator

• MetafieldOwnerType

• ShopTagSort

Anchor to Other changesOther changes

• Argument sort: ShopTagSort was added to Shop.orderTags field

Anchor to Storefront APIStorefront API

Version 2019-07 is the base version of the GraphQL API. This base version is a snapshot of the existing API, which means that there are no changes in this initial release. You can begin adopting API calls to this version in your apps without needing to make changes to your code base.

We strongly recommend that you update your apps to call a stable API version. Updating your apps to use the latest stable version lets you spend less time configuring your apps to be version aware, and helps you to be first to market by adopting new API changes when they are released.

Anchor to Corresponding Buy SDK versionsCorresponding Buy SDK versions