2022-01 release notes

You can now retrieve a bounding box from a 3D model. A bounding box is the smallest volume that can contain a 3D model.

New field

• boundingBox field was added to Model3d object

New types

• Model3dBoundingBox object was added
• Vector3 object was added

The authorization access error descriptions have been improved to provide more context and better represent the scopes required to execute a mutation. For example, previous error descriptions only expressed that you were denied access to a mutation. As of the 2022-01 API version, the error descriptions include the access scopes required.

The following fields on the Image object have been deprecated:

• originalSrc

• src

• transformedSrc

The deprecated fields are replaced with a single url field that you should use instead.

New fields

• url field was added to Image object

New types

• ImageTransformInput input object was added

As of API version 2022-01, new error codes have been added to the BulkMutationErrorCode enum to better represent the different types of errors that can occur during the execution of a bulk mutation.

New error codes

• BULK_MUTATION_USER_ERROR_CODE was added to enum BulkMutationErrorCode
• OPERATION_IN_PROGRESS was added to enum BulkMutationErrorCode
• INVALID_MUTATION was added to enum BulkMutationErrorCode
• INVALID_STAGED_UPLOAD_FILE was added to enum BulkMutationErrorCode
• NO_SUCH_FILE was added to enum BulkMutationErrorCode
• INTERNAL_FILE_SERVER_ERROR was added to enum BulkMutationErrorCode

As of API version 2022-01, a new error code has been added to the FileErrorCode and MediaErrorCode enums to communicate file creation failures when processing Model3D files on the backend.

New error codes

• MODEL3D_PROCESSING_FAILURE was added to enum FileErrorCode
• MODEL3D_PROCESSING_FAILURE was added to enum MediaErrorCode

You can now display warnings for media. For example, if 3D model dimensions might be incorrect, then a warning will be displayed on the product page.

New field

• MediaWarning field was added to ExternalVideo, MediaImage, Model3d, and Video objects

New types

• MediaWarning object was added
• MediaWarningCode enum was added

As of the 2022-01 API version release, you can use the GraphQL Admin API to apply metafield definitions to the Order, Customer, and Collection objects.

In the 2021-07 API version release, the value_type field on the Metafield object was deprecated. As of the 2022-01 API version release, the value_type field has been removed. You should use the type field instead of the value_type field to access or set the type of a Metafield object. For more information, refer to Managing metafields.

New types

• HasMetafieldDefinitions interface has been added to Order, Customer, and Collection objects

Removed fields

• valueType field was removed from Metafield object
• valueType field was removed from MetafieldInput input object

You can now query the total sellable quantity of a product variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.

New field

• sellableOnlineQuantity field was added to ProductVariant object

As of the 2022-01 API version release, you can use the OrderInvoiceSend mutation to send an email invoice for an order.

New mutation

• OrderInvoiceSend mutation was added

As of API version 2022-01, you can specify private metafield namespaces for webhook subscriptions.

New fields

• private_metafield_namespaces field was added to the WebhookSubscription object
• private_metafield_namespaces field was added to the WebhookSubscriptionInput input object

You can now query the GraphQL Admin API to retrieve a classification of product types. This includes all of the standard and custom product types associated with a product.

New types

• ProductTaxonomyNode object was added
• StandardProductType object was added
• StandardProductTypeInput input object was added

New fields

• standardizedProductType was added to Product object
• standardizedProductType was added and ProductInput input object
• customProductType was added to Product object
• customProductType was added to ProductInput input object

You can now query the GraphQL Admin API for products that merchants have scheduled to publish to your sales channel. You can also use new webhooks for scheduled product publishing notifications. Use these webhooks to enable channel app workflows such as product drops and timed sales.

New field

• resourcePublicationOnCurrentPublication field was added to Product object

New values

• SCHEDULED_PRODUCT_LISTINGS_ADD value was added to enum WebhookSubscriptionTopic

• SCHEDULED_PRODUCT_LISTINGS_REMOVE value was added to enum WebhookSubscriptionTopic

• SCHEDULED_PRODUCT_LISTINGS_UPDATE value was added to enum WebhookSubscriptionTopic

When you create a subscription draft, you can now add a note to apply to generated orders. For example, the note can be a personalized message to the customer.

New field

• note field was added to SubscriptionContract object

As of API version 2022-01, you can retrieve translatable resources by their IDs.

New connection

• translatableResourcesByIds connection was added to the QueryRoot object

The following fields on the Image object have been deprecated:

• originalSrc

• src

• transformedSrc

The deprecated fields are replaced with a single url field that you should use instead.

New fields

• url field was added to Image object

New types

• ImageTransformInput input object was added

You can now use the Storefront API to retrieve the featured image for a product without having to request the first image in a set.

New field

• featuredImage field was added to Product object

You can now use the Storefront API to filter products in a collection. This functionality lets you build a desired customer experience on a storefront, such as the ability to narrow down the search results that you display to customers.

New types

• Filter object was added
• FilterValue object was added
• VariantOptionFilter input object was added
• ProductFilter input object was added
• PriceRangeFilter input object was added
• MetafieldFilter input object was added
• FilterType enum was added

New field

• filters field was added to Product object

You can now use the Storefront API to retrieve the resource that a metafield refers to. This functionality provides parity with the reference field on the GraphQL Admin API's MetafieldReference object.

In the 2021-07 API version release, the value_type field on the Metafield object was deprecated. As of the 2022-01 API version release, the value_type field has been removed. You should use the type field instead of the value_type field to access or set the type of a Metafield object. For more information, refer to Managing metafields.

New field

• reference field was added to MetafieldReference object

Removed fields

• valueType field was removed from Metafield object

You can now use the Storefront API to retrieve the barcode (for example, ISBN, UPC, or GTIN) associated with a product variant.

New field

• barcode field was added to ProductVariant object

In the 2021-01 API version release, several fields on the Storefront API were marked as deprecated. As of API version 2022-01, the following fields and arguments have been removed:

• customer field on Checkout object
• available, presentmentPrices, and presentmentCurrencies fields on the ProductVariant object
• presentmentPriceRanges field on the Product object
• url field on the Article, Blog, and Page objects
• description field on the ScriptDiscountApplication object
• currencyCode, shopifyPaymentsAccountId, productByHandle, collectionByHandle, blogs, articles, collections, products, productTypes, and productTags fields on the Shop object
• maxWidth, maxHeight, crop, and scale arguments on the Image object

You can now use the Storefront API to retrieve policy associated with a store, such as a subscription policy.

New type

• ShopPolicyWithDefault object was added

New fields

• subscriptionPolicy field was added to Shop object

In the 2021-07 API version release, the value_type property on the Metafield resource was deprecated. As of the 2022-01 API version release, the value_type property has been removed.

You should use the type field instead of the value_type field to access or set the type of a Metafield object. For more information, refer to Managing metafields.

Removed properties

• value_type property was removed from Metafield resource

The validation for formatting the resource feedback message field has been simplified.

If the feedback state is requires_action, then you can send a string message that communicates the action to be taken by the merchant. The string must be a single message up to 100 characters long and must end with a period.

For more information, refer to ResourceFeedback.

Sales channels can now use webhooks for notifications of scheduled product publishing. Use these webhooks to enable channel app workflows such as product drops and timed sales.

New topics

• scheduled_product_listings/add topic was added to Webhook resource

• scheduled_product_listings/remove topic was added to Webhook resource

• scheduled_product_listings/update topic was added to Webhook resource