| Release date | Date version is no longer supported |
|---|---|
| October 1, 2019 | October 1, 2020 |
Page-based pagination has been replaced by cursor-based pagination across the remaining REST endpoints.
order and since_id. Using since_id requires ordering by id asc and the ordering is done automatically. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/checkouts.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/blogs/#{blog_id}/articles.json. blog_id is used and the blog doesn’t have any articles, then no result are returned. In previous version, blog_id tried to match the filters against all articles in a shop, if the blog with blog_id didn't have any articles. id desc. Previously they were sorted by unpublished first and then published blog post sorted by the date they were published. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/blogs.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/comments.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/custom_collections.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.
page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/customers/#{customer_id}/addresses.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/customers.json and GET /admin/api/2019-10/customers/search.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/price_rules/#{price_rule_id}/discount_codes.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/shopify_payments/disputes.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/draft_orders.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/orders/#{order_id}/fulfillments.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/gift_cards.json and GET /admin/api/2019-10/gift_cards/search.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/inventory_items.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/inventory_levels.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/locations/#{location_id}/inventory_levels.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/marketing_events.json. offset is deprecated, it returns an error if a value is passed. You can use since_id instead. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/orders.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/orders/#{order_id}/risks.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/pages.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/shopify_payments/payouts.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/product_listings/product_ids.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/product_listings/product_ids.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/products/#{product_id}/variants.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/redirects/#{redirect_id}.json. path and target will match only if the value is the same as the complete value. Partial matches aren't supported. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/orders/#{order_id}/refunds.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/reports.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/script_tags.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/smart_collections.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/tender_transactions.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/shopify_payments/balance/transactions.json. page filter, and replaced page-based pagination with cursor-based pagination for GET /admin/api/2019-10/webhooks.json. Deprecation for legacy inventory behavior is extended to all apps. To learn more, refer to Migrating to support multiple locations.
Removed fields
inventory_quantity_adjustment field was removed from Product Variantinventory_quantity field was removed from Product Variantrestock field was removed from RefundRequired fields
location_id is required when creating fulfillmentslocation_id and restock_type are required when creating refundsThe checkout payment flow now supports customer authentication with 3D Secure. To learn more, refer to Authenticating payments with 3D Secure.
next_action property for authenticating payments with 3D Secure.next_action property for authenticating payments with 3D Secure.The following changes have been made to the Webhook resource:
New properties
private_metafield_namespaces was added. It accepts an optional array of namespaces for any private metafields that should be included with each webhook. Payloads include only the private metafields that were created through the app itself.New topics
locales/create was added as part of the new translation feature for the GraphQL Admin API.locales/update was added as part of the new translation feature for the GraphQL Admin API.Delivery profiles store the advanced shipping information about the delivery methods and rates that apply to specific products. To learn more, refer to Manage delivery profiles.
Removed fields and types
activatedCarrierServices field was removed from QueryRootDeliveryCarrierServiceConnection type was removedNew types
Updated types
leaveLegacyModeProfiles input argument was added to deliveryProfileUpdatesortKey argument was added to DeliveryLocationGroupZone.methodDefinitionseligible argument was added to DeliveryLocationGroupZone.methodDefinitionsNew fields
locationsAvailableForDeliveryProfilesConnection was added to QueryRootlegacyModeBlocked was added to DeliverySettingincludeAllProvinces was added to DeliveryCountryInputNew mutations
Deprecation for legacy inventory behavior is extended to all apps. To learn more, refer to Migrating to support multiple locations.
Removed fields
restock field was removed from RefundInputinventoryQuantityAdjustment field was removed from ProductVariantInputinventoryQuantity field was removed from ProductVariantInputWith bulk operations, you can fetch data asynchronously in bulk. To learn more, refer to Performing bulk operations with GraphQL.
New types
New fields
currentBulkOperation field was added to QueryRootNew mutations
You can manage translated content for multiple languages for Shopify resources. To learn more, refer to examples for retrieving translated content.
New types
Updated types
New fields
translatableResources was added to QueryRoottranslatableResource was added to QueryRootshopLocales was added to QueryRoottranslations was added to Shoptranslations was added to ProductVarianttranslations was added to ProductOptiontranslations was added to Producttranslations was added to Collectiontranslations was added to Linktranslations was added to OnlineStorePagetranslations was added to OnlineStoreBlogtranslations was added to OnlineStoreArticleNew mutations
Private metafields are additional fields for Shopify resources. Unlike standard metafields, private metafields are visible only to the app that created them. To learn more, refer to Working with metafields using the GraphQL Admin API.
New types
New fields
privateMetafields was added to QueryRootprivateMetafield was added to QueryRootprivateMetafields was added to ProductInputprivateMetafields was added to DraftOrderInputprivateMetafields was added to CustomerInputprivateMetafields was added to CollectionInputprivateMetafields was added to ProductVariantInputprivateMetafields was added to ShopprivateMetafield was added to ShopprivateMetafields was added to DraftOrderprivateMetafield was added to DraftOrderprivateMetafields was added to OrderprivateMetafield was added to OrderprivateMetafields was added to CustomerprivateMetafield was added to CustomerprivateMetafields was added to ProductVariantprivateMetafield was added to ProductVariantprivateMetafields was added to ProductprivateMetafield was added to ProductprivateMetafields was added to CollectionprivateMetafield was added to CollectionprivateMetafields was added to HasMetafieldsprivateMetafield was added to HasMetafieldsprivateMetafields was added to ImageprivateMetafield was added to ImageNew mutations
The following missing fields that were available in the REST Admin API were added to the ShippingLine object type.
New fields
carrierIdentifier was added to ShippingLinesource was added to ShippingLinerequestedFulfillmentService was added to ShippingLinephone was added to ShippingLineid was added to ShippingLinedeliveryCategory was added to ShippingLinecode was added to ShippingLinetaxLines was added to ShippingLineUpdated types
SLL was added to CurrencyCodeTOP was added to CurrencyCodeTJS was added to CurrencyCodeDJF was added to CurrencyCodeLYD was added to CurrencyCodeIRR was added to CurrencyCodeNew fields
statusTransitionedAt was added to object type MarketingActivitytaxCode was added to object type ProductVariantThe checkout payment flow now supports customer authentication with 3D Secure. To learn more, refer to Authenticating payments with 3D Secure.
New fields
nextActionUrl was added to PaymentSLL was added to CurrencyCodeTOP was added to CurrencyCodeTJS was added to CurrencyCodeDJF was added to CurrencyCodeLYD was added to CurrencyCodeIRR was added to CurrencyCodeGNF was added to CurrencyCode| SDK | Supported Versions |
|---|---|
| Mobile Buy SDK Android | 3.6.0 |
| Mobile Buy SDK iOS | 3.6.1 |
| Unity Buy SDK | 1.2.0 |
| JS Buy SDK | 2.8.0, 2.8.1 |
| Buy Button JS | N/A |