2022-10 release notes
Release date | Date version is no longer supported |
---|---|
October 1, 2022 | October 1, 2023 |
What's new in 2022-10
The following features were added in version 2022-10 of Shopify's APIs.
Highlights from the GraphQL Admin API changes:
- Checkout Profiles API
- B2B API released
- Web Pixel API released
- New mutation to bulk activate or deactivate a single inventory item at multiple locations
- Support for custom content by market through the Translations API
- Location Management API released
- Full markets and multi-currency support for
DraftOrders
SellingPlan
andSellingPlanGroup
fields are now supported by the Translations API- New
references
connection onMetafields
- Metafield support for
Locations
- Duplicate and Create Inventory Reservations in
DraftOrders
- Local Delivery & Pickup for Subscriptions
Highlights from the GraphQL Storefront API changes:
- You can now use the Storefront API to attach shipping address preferences to the carts of non-logged-in customers and the fetch cart delivery groups through the new
deliveryAddressPreferences
field, which has been added to the Storefront API'sCartBuyerIdentity
andCartBuyerIdentityInput
objects - New
references
connection onMetafields
- Querying for
CheckoutProfiles
- New
deliveryAddressPreferences
field added to cart buyer identity objects
Highlights from the REST Admin API changes:
- New
merchant_of_record_app_id
field on theOrder
object - New
marketing_sms_consent_enabled_at_checkout
field on theShop
object
Breaking changes
Anchor link to section titled "Breaking changes"These changes require special attention. If your app uses these API resources, and you don’t adjust your usage of the resources according to the following instructions, then your app might break when you update to this API version.
Protected customer data requirements
Anchor link to section titled "Protected customer data requirements"As of version 2022-10, published, public apps that use GraphQL Admin API and REST Admin API resources must meet the protected customer data requirements.
The protected customer data requirements focus on data minimization, transparency, and security so that you can better support merchants' path towards compliance with privacy and data protection rules.
Deleting a reference type metafield definition
Anchor link to section titled "Deleting a reference type metafield definition"As of version 2022-10, if you delete a reference type metafield definition with the deleteAllAssociatedMetafields
argument set to false
, then REFERENCE_TYPE_DELETION_ERROR
is returned with the following error message:
Deleting a reference type metafield definition requires deletion of its associated metafields.
Deprecated Fulfillment cancel endpoint on the REST Order API
Anchor link to section titled "Deprecated Fulfillment cancel endpoint on the REST Order API"The Fulfillment
cancel
endpoint on the REST Order API is now deprecated: /orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json
. Use /fulfillment/{fulfillment_id}/cancel.json
on the Fulfillment
endpoint instead.
Deprecated title
field on ProductVariant
resource
Anchor link to section titled "Deprecated title field on ProductVariant resource"You will no longer be able to register title
translations on the ProductVariant
resource. The title
will be automatically generated using the option
translations when they are registered.
Deprecated customer-related Order
properties
Anchor link to section titled "Deprecated customer-related Order properties"The following Customer
object properties on the REST Admin API's Order
resource have been deprecated:
last_order_id
last_order_name
orders_count
total_spent
These properties will still be available in the Customer
resource.
Deprecated Order and LineItem properties
Anchor link to section titled "Deprecated Order and LineItem properties"We've introduced a breaking change to the LineItem
resource. The fulfillment_service
field is no longer supported in the REST and GraphQL Admin APIs. Fulfillment services will all be opted into SKU sharing in 2023-04. Consider using one of the following options instead:
assigned_location
property on the RESTFulfillmentOrder
resourceassigned_location
field on the GraphQLFulfillmentOrder
object
When a fulfillment service app sets permits_sku_sharing
to true
, some existing behaviour will break. When a product variant's fulfillmentService
parameter (REST and GraphQL) is set to manual
, it no longer means that the variant is stocked only at a merchant-managed location. Therefore, apps that use the fulfillmentService
parameter in this way should instead use the location
parameter on the FulfillmentOrder
resource to determine which location or fulfillment service fulfills for a given line item.
The following other line item properties on the REST Admin API's Order
resource are deprecated:
origin_location
destination_location
The following object property on the REST Admin API's Order
resource is deprecated:
total_price_usd
Subscription billing cycles
Anchor link to section titled "Subscription billing cycles"We've added subscription billing cycles to the existing Subscriptions Contract APIs so that you can make changes to an upcoming order without affecting the base subscription contract.
The following changes are included:
- Skipping future orders
- Making changes to the line items of an upcoming order, including any additions, quantity changes, or removals
- Combining the orders of one or more subscriptions contracts to save on shipping costs
Changes to MoneyV2 related fields
Anchor link to section titled "Changes to MoneyV2 related fields"The Money
scalar is being removed from the Storefront API. It was previously used for monetary fields that don't have a V2 suffix (<name>: Money
). As a result, the following changes have been made:
- Non-V2 fields now use MoneyV2
objects for their type (<name>: MoneyV2
).
- Monetary fields that do have the V2
suffix (<name>V2: MoneyV2
) are deprecated in favor of the <name>: MoneyV2
equivalent. These fields will be removed in subsequent releases.
The Money V2 changes help to improve the consistency of the GraphQL Admin API and make it clearer to use these fields.
GraphQL Admin API changes
Anchor link to section titled "GraphQL Admin API changes"The following are all the changes currently introduced in the 2022-10 version of the GraphQL Admin API.
GraphQL Storefront API changes
Anchor link to section titled "GraphQL Storefront API changes"The following are all the changes currently introduced in the 2022-10 version of the GraphQL Storefront API.
REST Admin API changes
Anchor link to section titled "REST Admin API changes"The following are all the changes currently introduced in the 2022-10 version of the REST Admin API.