2021-07 release notes (Release candidate)

Release date Date version is no longer supported
July 1, 2021 July 1, 2022

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.

Explicit user permissions

In previous API versions, the permissions property in the REST User resource returned either full or a specific list of permissions. The full permission represents that the user has the same permissions as the store owner, with some exceptions, such as modifying the account billing or deleting staff accounts.

As of API version 2021-07, the complete list of explicit permissions that a user with the full permission has access to is returned in the permissions property.

GraphQL Admin API changes

Below are all the changes currently introduced in the 2021-07 version of the GraphQL Admin API.

As of API version 2021-07, you can use the GraphQL Admin API to bulk import large volumes of data asychronously. By running a bulk mutation operation, you can avoid manually running a GraphQL mutation multiple times and managing a client-side throttle.

To learn more about bulk importing data asynchronously, refer to Bulk import data with the GraphQL Admin API.

New mutation

  • bulkOperationRunMutation mutation was added

New types

  • BulkOperationType enum was added
  • BulkMutationUserError type was added
  • currentBulkOperation connection was added to object QueryRoot
  • BULK_MUTATION_VARIABLES value was added to enum StagedUploadTargetGenerateUploadResource

As of API version 2021-07, you can use the GraphQL Admin API and Google Cloud Pub/Sub to manage webhook subscriptions.

To learn more about managing webhooks with Google Cloud Pub/Sub, refer to Manage webhooks with Google Cloud Pub/Sub.

New mutations

  • pubSubWebhookSubscriptionCreate mutation was added
  • pubSubWebhookSubscriptionUpdate mutation was added

New input

  • pubSubWebhookSubscriptionInput was added

New type

  • WebhookPubSubEndpoint object was added
  • PubSubWebhookSubscriptionInput was added
  • PubSubWebhookSubscriptionCreatePayload was added
  • PubSubWebhookSubscriptionUpdatePayload was added

As of API version 2021-07, you can use the GraphQL Admin API to manage redirects on an online store.

URL redirects can be used to redirect traffic from one web page to another. For example, if you delete a product, then you can set up a URL redirect so that when customers enter the URL for that product, they are redirected to a similar product on an online store.

New mutations

  • UrlRedirectBulkDeleteAll mutation was added
  • UrlRedirectBulkDeleteByIds mutation was added
  • UrlRedirectBulkDeleteBySavedSearch mutation was added
  • UrlRedirectBulkDeleteBySearch mutation was added
  • UrlRedirectCreate mutation was added
  • UrlRedirectDelete mutation was added
  • UrlRedirectImportCreate mutation was added
  • UrlRedirectImportSubmit mutation was added
  • UrlRedirectUpdate mutation was added

New types

  • UrlRedirect object was added
  • UrlRedirectImport object was added
  • UrlRedirectImportPreview object was added
  • UrlRedirectInput input object was added
  • UrlRedirectImportUserError type was added
  • UrlRedirectUserError type was added

New fields

  • urlRedirect field was added to object QueryRoot
  • urlRedirectSavedSearches field was added to object QueryRoot
  • urlRedirectImport field was added to object QueryRoot

New connections

  • urlRedirects connection was added to object QueryRoot

New values

  • urlRedirects value was added to enum ResourceType
  • urlRedirects value was added to enum ResourceExportableType
  • urlRedirect value was added to enum SearchResultType

REST Admin API changes

Below are all the changes currently introduced in the 2021-07 version of the REST Admin API.

As of API version 2021-07, the complete list of explicit permissions that a user with the full permission has access to is returned in the permissions property of the REST User resource.

New values

The following new values have also been added to the permissions property:

  • billing_charges: The user can view and export billing charges.
  • billing_invoices_view: The user can view billing invoices.
  • billing_payment_methods_view: The user can view billing payment methods.
  • staff_management_activation: The user can activate or deactivate staff in the store.
  • staff_management_create: The user can add staff to the store.
  • staff_management_delete: The user can delete staff from the store.