2019-07 release notes

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

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.

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.

Added the admin_graphql_api_id property to webhook payloads for many resources.

To migrate, update webhook API version to API version 2019-07 or later.

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.

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

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

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

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

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

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

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

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

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

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

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

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

• Added tax_exemptions property.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.