| Release date | Date version is no longer supported |
|---|---|
| July 1, 2023 | July 1, 2024 |
As of 2023-07, you can use the abandonmentUpdateActivitiesDeliveryStatuses to update the delivery status of marketing activities created via Flow action extension. We're deprecating the abandonmentEmailStateUpdate mutation since it's being replaced by the new API.
fileUpdate mutation As of API version 2023-07, the new error codes FILENAME_ALREADY_EXISTS and INVALID_FILENAME have been added to the fileUpdate mutation. These error codes are returned when you attempt to update the filename (URL Handle) and the input either matches an existing filename (URL Handle) or it's invalid.
taxExempt on the Order objectAs of GraphQL Admin API 2023-07, the taxExempt field has been added to the Order object. You can use this field to determine whether an order was exempt from taxes.
Orders can be exempt from taxes if the Charge taxes option was disabled during the creation of a draft order, or if the order was created for a customer with the Collect tax option disabled.
We’ve added the taxAppConfigure mutation, which enables selected tax partners to configure the state of an existing integrated tax service. This extended control provides Partners with more flexibility and adaptability in managing tax services, ensuring a smoother, more efficient operation for their app.
As of API version 2023-07, sales records can now be of type AdditonalFeeSale, which represents a sale associated with an additional fee charge.
For more information on this new type implementation, refer to the sale interface.
As of API version 2023-07, you can now create region-specific subfolders on country-code top-level domains (ccTLDs), such as shop.ca or shop.fr. Previously, subfolders could only be created on generic top-level domains (gTLDs).
CompanyContact from a CompanyAs of API version 2023-07, you can use the companyContactRemoveFromCompany mutation to remove a company contact from a company, even if they have placed orders on behalf of the company.
As of API version 2023-07, we're providing additional webhook notifications for changes to the major entities within the B2B Customers product. These hooks enable better integration with Flow. The following webhooks are provided:
company_contact_roles/assigncompany_contact_roles/revoke`ExchangeV2` field is available behind beta flag on the Order objectAs of API version 2023-07, you can use the exchangeV2 field on the Order object to get a better exchange (an exchangeV2 object value). This helps ERP partners properly integrate optimal exchange values.
The DeliveryMethod object now has a brandedPromise field that can be used to determine if an order was branded with Shop Promise at checkout.
Additionally, the MailingAddress object now includes the timeZone field, which you can use with the DeliveryMethod's maxDeliveryDateTime field, to determine the date and time according to the time zone of the destination address.
Learn more about Shop Promise eligibility.
As of API version 2023-07, we're introducing the following breaking changes to the product feeds webhook topics:
bulk in favour of full for the product_feeds/full_sync webhook topicoccurred_at field in metadata for product_feeds notifications metadataPartners who want to continue receiving full sync notifications should start using the productFullSync mutation instead of productBulkSync.
As of API version 2023-07, you can now use the Customer Merge API to combine two separate customer profiles with certain non-blocking criteria. You can use the new mutations and queries to do the following tasks:
Additionally, you can check whether a customer can be merged with another customer using the new Customer.mergeable field. This field is also available on the CustomerSegmentMember.mergeable object.
CustomerSegmentMember objectAs of API version 2023-07, the CustomerSegmentMember object now has the attributes and connections to access the metafields associated to the customer.
acceptsMultipleValues attribute to the SegmentEventFilterParameter objectAs of API version 2023-07, the SegmentEventFilterParameter object now has the attribute acceptsMultipleValues to denote if the parameter can handle multiple values. For example, the id parameter for the products_purchased function can accept multiple values, such as products_purchased(id: (2012162031638, 1012132033639) = false.
Learn more about segment query language.
As of API version 2023-07, you can use the new functionParameterQueryName argument on segmentValueSuggestions to query for function parameter value suggestions for customer segmentation.
For example, the products_purchased filter has the function parameter id: products_purchased(id: '2012162031638') = true. To retrieve a list of possible product IDs to use for the id function parameter, provide filterQueryName: 'products_purchased', functionParameterQueryName: 'id' as arguments to the segmentValueSuggestions query.
As of API version 2023-07, Shopify's providing additional webhook subscription topics for customer tags:
CUSTOMER_TAGS_ADDEDCUSTOMER_TAGS_REMOVEDAs of API version 2023-07, we're' deprecating creating app credits through the Admin API. Both the REST resource, and the GraphQL mutation include the capability to create app credits deprecated. Going forward, you should create app credits using the appCreditCreate mutation in the Partner API.
This change enables us to implement new features for creating app credits, such as allowing Partners to issue credits to stores that have uninstalled their app.
Order and DraftOrder objectsAs of API version 2023-07, we've added a new field called poNumber to the Order and DraftOrder objects.
The OrderInput and DraftOrderInput input objects now accept a poNumber. This sets the purchase order number during orderUpdate, draftOrderUpdate, and draftOrderCreate mutations.
isMarketplace on ChannelDefinition objectAs of API version 2023-07, you can use the new field isMarketplace on the ChannelDefinition object to check if a channel definition represents a marketplace, such as shops on Facebook, Instagram, or Buy on Google.
The new isMarketplace field indicates whether any object that references ChannelDefinition is related to a marketplace channel. For example, you can determine if an order was placed on a channel that's a marketplace or if the store has available channels that are marketplaces.
type on TranslatableContent objectAs of API version 2023-07, you can use the new field type on TranslatableContent to get the type of the translatable content.
The new type field gives more information about the underlying translatable content which enables you to conditionally render UI elements, such as input fields.
Learn more about the LocalizableContentType object.
tax_partners/update webhookAs of API version 2023-07, the tax_partners/update webhook is available.
The tax_partners/update webhook is called whenever a tax partner is added or updated. Partners can use this webhook to determine when a merchant has made changes to the partner's tax app.
As of API version 2023-07, we're introducing a new capability to translate filters.
When enabled, all filter labels will be eligible for translations through the Translations API as well as the Translate and Adapt app.
duplicateResolutionMode field added to fileCreateAs of API version 2023-07, you can use the new duplicateResolutionMode field on the fileCreate mutation to control how duplicate filenames are handled.
ONLINE_STORE_POST_PURCHASE_CROSS_SELL fulfillment hold reasonAs of API version 2023-07, you can determine whether fulfillment has been placed on hold for a post-purchase with the reason ONLINE_STORE_POST_PURCHASE_CROSS_SELL.
As of API version 2023-07, you can split and merge fulfillment orders. You can split a single fulfillment order into multiple fulfillment orders by dividing the line items across multiple fulfillment orders. You can also merge fulfillment orders together into a single fulfillment order.
Learn more about the fulfillmentOrderSplit and fulfillmentOrderMerge mutations.
fileUpdateAs of API version 2023-07, you can use the fileUpdateInput input object to provide an originalSource, which is used to update the bytes of a file. Passing originalSource when updating is supported for media images and generic files.
Using this functionality makes it easy to do an in-place update of an existing file.
As of API version 2023-07, there are new mutations that enable you to alter the inventory quantities at a location. State quantities reserved and on_hand are adjustable through the API. In addition, there are queries to retrieve quantities for every state.
For more information, refer to Inventory management apps.
As of API version 2023-07, a new error code item_not_stocked_at_location has been added to the inventorySetOnHandQuantities, inventoryAdjustQuantities, and inventoryMoveQuantities mutations. This error code is returned when you attempt to change inventory quantities for an item that isn't stocked at the specified location.
metafieldsSet support for MediaImageAs of API version 2023-07, you can use the metafieldsSet mutation to set metafields on images using MediaImage GIDs.
As of API version 2023-07, we're deprecating a set of fields used for associating images with products and variants:
ProductInput: images field deprecation. Use the newly introduced media field instead.ProductVariantInput: imageId and imageSrc field deprecation. Use mediaId and mediaSrc instead.ProductVariantsBulkInput: imageSrc field deprecation. Use mediaSrc instead.PUBLIC_READ access setting for app-owned metafieldsAs of API version 2023-07, you can now apply a PUBLIC_READ access setting to your metafield definitions. If your metafield definition is PUBLIC_READ, this means the following:
This new setting builds upon the PRIVATE, MERCHANT_READ, and MERCHANT_READ_WRITE access settings that were released in January 2023.
Learn more about access controls.
total_count field from SegmentStatistics` to CustomerSegmentMemberConnectionAs of API version 2023-07, you can now use total_count on the CustomerSegmentMemberConnection endpoint, which provides the total count of a specified customer segment.
Additionally, the total_count field on SegmentStatistics object has been removed. The new total_count functionality makes it easier to know the count of members of a specified segment.
As of API version 2023-07, we're no longer automatically creating a subfolder web presence for a single-country market. To maintain existing behaviour, you can follow up creating a market with the marketWebPresenceCreate mutation. Passing in the country code of the market region as the subfolderSuffix creates the corresponding web presence.
As of API version 2023-07, we're introducing sales type UnknownSale with line type UNKNOWN that represents new types of sales that might be added in the future and don't exist on older versions.
This is a complimentary object type for the SalesLineType UNKNOWN and implements the Sale interface.
As of API version 2023-07, we've added TOTAL_ITEM_QUANTITY to OrderSortKeys so that you can sort orders by the total quantity of items.
As of API version 2023-07, you can use the quantityRulesAdd and quantityRulesDelete mutations to manage product variant minimums, maximums, and increments for B2B customers. Use the quantityRules field on the ProductVariantContextualPricing object to view the quantity rules applied for the companyLocationId input.
orders/updated webhookAs of API version 2023-07, you can now subscribe to the orders/updated webhook to be notified of any sale attribution edits to an order. When a staff attribution edit is made on POS, the orders/updated webhook fires. The payload include sa new attributed_staffs field under line_items. This new field will reflect the new attributions on the order after the edit.
A user can edit the staff attributions on multiple line items at once on POS. In this case, the webhook payload could include multiple updated line items with different attributions applied to them.
fileCreateAs of API version 2023-07, you can now specify a custom filename when using the fileCreate mutation to create files that will appear in the Shopify admin.
fileUpdateAs of API version 2023-07, we've added a new field called filename to the fileUpdate mutation. This new field allows you to update the filename of both generic files and images.
As of API version 2023-07, you can now use search and predictiveSearch queries to enable natural language search on your custom storefronts.
The search query returns the most relevant search results among product, page and article resource types. Merchants can use the Shopify Search & Discovery app to change the default value of the resource types and customize search results.
The predictiveSearch query helps you implement a predictive search dropdown interface where suggested results are displayed immediately as buyers type into the search bar.
As of API version 2023-07, you can now use the quantityAvailable field on the StoreAvailability object to determine the inventory available for a product variant at a particular local pickup location.
chargebackLiability field for onsite credit card payments apps with 3-D Secure As of API version 2023-07, you must provide the chargebackLiability field in the 3-D Secure PaymentSessionThreeDSecureAuthenticationData input object. Merchants will benefit from this information to better manage their orders.
Learn more about the Payments Apps API and 3-D Secure.
As of API version 2023-07, we're deprecating creating app credits through the Admin API. Both the REST resource and the GraphQL mutation include the capability to create app credits deprecated. Going forward, you should create app credits using the appCreditCreate mutation in the Partner API.
This change allows Shopify to implement new features for app credit creation, such as allowing Partners to issue credits to stores that have uninstalled their app.
delivery_category field on order shipping lines As of API version 2023-07, we're deprecating the order shipping line delivery_category property. The property hasn't been in use since 2020-06-12 and will no longer be present.
Order and DraftOrder objectsAs of API version 2023-07, we've added a new field called poNumber to the Order and DraftOrder resources.
applied_discounts and discount_allocations on a line item in the Checkout resourceAs of API version 2023-07, the Checkout resource includes the discount_class attribute in the line_items[n].applied_discounts and line_items[n].discount_allocations.
The discount_class identifies the type of discount applied to a line_item:
PRODUCT: Denotes a product class discount that applies to specific products only.
ORDER: Denotes an order class discount that applies across all line items.
Order resourceAs of API version 2023-07, we've added the tax_exempt field to the Order resource. You can use this field to determine whether an order was exempt from taxes.
Orders can be exempt from taxes if the Charge taxes option was disabled during the creation of a draft order, or if the order was created for a customer with the Collect tax option disabled.
ONLINE_STORE_POST_PURCHASE_CROSS_SELL fulfillment hold reasonAs of API version 2023-07, you can determine whether a fulfillment has been placed on hold for a post-purchase with the reason ONLINE_STORE_POST_PURCHASE_CROSS_SELL.
As of API version 2023-07, you can split and merge fulfillment orders. You can split a single fulfillment order into multiple fulfillment orders by dividing the line items across multiple fulfillment orders. You can also merge fulfillment orders together into a single fulfillment order.
orders/updated webhookAs of API version 2023-07, you can now subscribe to the orders/updated webhook to be notified of any sale attribution edits to an order. When a staff attribution edit is made on POS, the orders/updated webhook fires. The payload includes a new attributed_staffs field under line_items. This new field will reflect the new attributions on the order after the edit.
A user can edit the staff attributions on multiple line items at once on POS. In this case, the webhook payload could include multiple updated line items with different attributions applied to them.