Developer changelog

API v2024-10 introduces the Metafield Definition Capability Framework, replacing use_as_collection_condition with smart_collection_condition for better flexibility and extensibility.

GraphQL API v2024-10 introduces ProductSetInventoryInput for setting available or on_hand quantities in ProductSet and ProductSetVariant mutations, enhancing inventory management.

GraphQL Admin API 2024-10: GiftCard endpoints open to all; new GiftCardTransaction types. Rename giftCardDisable to giftCardDeactivate. Add recipientAttributes and transaction fields.

As of the Admin API version 2024-10, the fulfillmentOrdersReleaseHolds mutation has been deprecated.

...

As of Admin GraphQL API version 2024-10, you can access QueryRoot.urlRedirectsCount field to retrieve the count of redirects.

Learn more about urlRedirectsCount on...

As of the 2024-10 version of the GraphQL Admin API, the products query filter has been expanded to allow filtering on additional attributes: publication_ids, variant_id and...

GraphQL Admin API 2024-10 adds id to FulfillmentHold and optional holdIds to fulfillmentOrderReleaseHold mutation, allowing precise hold releases by ID.

As of Admin GraphQL API version 2024-10, you can access Order.statusPageUrl field to retrieve the URL where the customer can check the order's current status.

Learn more about Order on...

From Sept 12, 2024, CustomerConsentCollectedFrom returns SHOPIFY for SMS consent in Shopify Checkout, affecting 1st party and UI extensions; other flows remain unchanged.

API v2024-10 introduces PRODUCT_CATEGORY_ID in CollectionRuleColumn for smart collections, replacing deprecated PRODUCT_TAXONOMY_NODE_ID. Update implementations for enhanced functionality.

As of 2024-10, we're deprecating fulfillmentCreateV2 and fulfillmentTrackingInfoUpdateV2. Instead, please use fulfillmentCreate and fulfillmentTrackingInfoUpdate.

Note that the...

GraphQL Admin API 2024-10 adds stockAtLegacyLocation to inventoryActivate mutation, enabling inventory activation at non-SKU-sharing locations. Ensure parameter is true for such activations.

As of 2024-10, ReverseFulfillmentOrderLineItem.fulfillmentLineItem is nullable. Older API versions will error if fulfillmentLineItem is missing.

As of Admin GraphQL API version 2024-10, use Order.lineItems instead of lineItemsMutable field to get a list of the order's line items.

Learn more about Order on...

We are retroactively adding Customer, Order, Company, and Model3d graphql types to the MetafieldReference union for...

As of 2024-10 version, we are adding productVariantsCount field to the Admin GraphQL API.

Learn more about...

The 2024-10 GraphQL Admin API release removes HAS_OPEN_TRANSFERS_ERROR and FAILED_TO_RELOCATE_OPEN_TRANSFERS from LocationDeactivateUserErrorCode. Update code to remove checks.

As of GraphQL Admin API version 2024-10, we're cleaning up the shopifyPaymentsAccount endpoint and removing several unused fields.

GraphQL API v2024-10 introduces FileSetInput for enhanced media handling in productSet. Replaces mediaIds and mediaId with files and file fields for better file management.

We are deprecating productChangeStatus mutation. Use...

GraphQL Admin API 2024-10 removes MetafieldStorefrontVisibility fields, queries, and mutations. Use MetafieldDefinition.access for enhanced flexibility and functionality.

GraphQL Admin API 2024-10 adds access argument for granular control in metafield mutations; deprecates visibleToStorefrontApi. Update your code to use access.

Admin API 2024-10 requires apps to have specific write scopes to release fulfillment holds. Insufficient access returns errors: INVALID_ACCESS in GraphQL, 422 in REST. Update scopes accordingly.

The 2024-10 update adds a category field to product create/update webhooks. Use API version 2024-10+ in your App Partner Dashboard to receive this data.

As of July 18, 2024, Shopify APIs support accurate refunds for orders with multiple shipping lines, detailing each refund in both GraphQL and REST APIs for improved data accuracy.

In the 2024-10 Admin GraphQL API, productDeleteAsync is removed. Use productDelete with a synchronous parameter to choose sync or async deletion, and track async status via operation ID.

In version 2024-10, the productDuplicateAsyncV2 mutation is removed. A new synchronous parameter in productDuplicate allows async duplication with operation tracking via ProductOperation.

GraphQL Admin API 2024-10 deprecates singular variant mutations in favor of bulk versions: use productVariantsBulkCreate, productVariantsBulkUpdate, and productVariantsBulkDelete instead.

As of the GraphQL Admin API version 2024-10, we're deprecating the GREATER_THAN_ZERO and INVALID_LINE_ITEM_QUANTITY error codes on the [fulfillmentOrderReleaseHold...

Added Product.restrictedForResource field to query product restrictions in CalculatedOrder, showing status and reason. Supports Managed Markets restrictions during order edits.

As of 2024-10, CartTransform create mutation supports metafields, enabling setting them at creation, reducing the need for additional calls, streamlining the process for developers.

GraphQL Admin API 2024-07 lets you set/query customer data sale/sharing opt-out status, aiding compliance with US laws like CCPA/CPRA.

As of the 2024-07 release of the GraphQL Admin API, a new error code LEDGER_DOCUMENT_INVALID will be added to the potential errors for the...

As of 2024-07, you can use the Order.transactionsCount to return the number of transactions associated with a given order.

As of 2024-07, you can use the fileUpdate mutation to connect files to products.

Learn more about working with files on...

From 2024-07, GraphQL's FulfillmentOrderLineItem will include a ProductVariant connection, simplifying product detail access for order management apps without SKU comparison.

As of GraphQL Admin API version 2024-07, you can now set available and on hand quantities for inventory via the new inventorySetQuantities graphql mutation. At the same time, the...

As of version 2024-07, SellingPlan resources now support metafields. Use sellingPlanGroupCreate and sellingPlanGroupUpdate mutations to manage metafields on selling plan objects.

GraphQL Admin API 2024-07: Product Set mutation now runs synchronously by default; variant input limit increased. Use synchronous: false for complex inputs to avoid timeouts.

As of 2024-07, the product create and update webhook payload contains information about the media on a product.

Using media GIDs allows compatibility with GraphQL Admin API mutations such as...

New APIs allow viewing/filtering of conditional metafield definitions. Use constraints, constraintSubtype, and constraintStatus for targeted metafield queries.

GraphQL Admin API 2024-07 adds return APIs: returnCreate for exchanges with fees, returnLineItemRemoveFromReturn for line removal, and returnCalculate for pre-return financials.

In the 2024-07 GraphQL Admin API, Shopify's suggestedRefund now includes exchange items and fees, affecting refund logic by considering all payable charges and outstanding amounts.

As of the 2024-07 release of the GraphQL Admin API, the location object will be gated by the read_locations scope. Attempting to [read the location...

As of GraphQL Admin API version 2024-07, you can manage combined listing using our new [CombinedListings API]...

In version 2024-07, Return.returnLineItems changes to an interface type. Update queries with inline fragments to ensure compatibility and handle diverse return item types.

GraphQL Admin API 2024-07 adds fixed bundle creation with new mutations: productBundleCreate and productBundleUpdate, enhancing product merchandising capabilities.

As of version 2024-07 of the Admin GraphQL API, we're adding 14 new LocalizationExtensionsKey values to support the collection of tax / shipping credentials in several new countries.

Learn...

The 2024-07 GraphQL Admin API checks inventory during billing. If items are out of stock, billing fails with an INSUFFICIENT_INVENTORY error, preventing overselling.

API update: Payouts GraphQL now supports query arguments for sorting/filtering. Added attributes to ShopifyPaymentsBalanceTransaction for detailed transaction insights.