2022-01 release notes (Release candidate)

Location specific credit card numbers for order testing
Release date Date version is no longer supported
January 1, 2022 January 1, 2023

Breaking changes

These changes require special attention. If your app uses these API resources and you don’t upgrade to a more recent API version, then your app will break.

Error codes for bulk mutations

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.

GraphQL Admin API changes

Below are all the changes currently introduced in the 2022-01 version of the GraphQL Admin API.

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

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

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

GraphQL Storefront API changes

Below are all the changes currently introduced in the 2022-01 version of the GraphQL Storefront API.

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