2020-10 release notes (Release candidate)

Release date Date version is no longer supported
October 1, 2020 October 1, 2021

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.

Tax field data

As of version 2020-10, you can no longer create or update any tax field data using the Country or Province resources.

GraphQL Admin API changes

Below are all the changes currently introduced in the 2020-10 version of the GraphQL Admin API.

New mutation

Create a new marketing activity using the marketingActivityCreate mutation.

You can now subscribe to delivery profiles event webhooks.

New topics

  • PROFILES_CREATE value was added to enum WebhookSubscriptionTopic
  • PROFILES_UPDATE value was added to enum WebhookSubscriptionTopic
  • PROFILES_DELETE value was added to enum WebhookSubscriptionTopic

You can now query a list of line items that contain shipping costs on existing orders.

New connection

shippingLines added on Order object type

We added new fields to the Order object that capture the current representation of order values. Previously, apps could only use fields such as totalPriceSet and totalTaxSet and had to manually subtract order values from returns and refunds.

New fields

  • currentCartDiscountAmountSet added to object Order
  • currentSubtotalLineItemsQuantity added to object Order
  • currentSubtotalPriceSet added to object Order
  • currentTaxLines added to object Order
  • currentTotalDiscountsSet added to object Order
  • currentTotalPriceSet added to object Order
  • currentTotalTaxSet added to object Order
  • currentTotalWeight added to object Order

We've added new error codes to better represent the different types of errors that can occur when creating media objects. We also added a new field to the MediaImage object type.

New error codes

  • VIDEO_METADATA_READING_ERROR was added to enum MediaErrorCode
  • VIDEO_INVALID_FILETYPE_ERROR was added to enum MediaErrorCode
  • VIDEO_MIN_WIDTH_ERROR was added to enum MediaErrorCode
  • VIDEO_MAX_WIDTH_ERROR was added to enum MediaErrorCode
  • VIDEO_MIN_HEIGHT_ERROR was added to enum MediaErrorCode
  • VIDEO_MAX_HEIGHT_ERROR was added to enum MediaErrorCode
  • VIDEO_MIN_DURATION_ERROR was added to enum MediaErrorCode
  • VIDEO_MAX_DURATION_ERROR was added to enum MediaErrorCode
  • MODEL3D_THUMBNAIL_GENERATION_ERROR was added to enum MediaErrorCode
  • MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR1 was added to enum MediaErrorCode
  • MODEL3D_GLB_OUTPUT_CREATION_ERROR was added to enum MediaErrorCode
  • UNSUPPORTED_IMAGE_FILE_TYPE was added to enum MediaErrorCode
  • INVALID_IMAGE_FILE_SIZE was added to enum MediaErrorCode
  • MEDIA_DELETE_LIMIT_EXCEEDED was added to enum MediaUserError

New field

mimeType was added to object type MediaImage

REST Admin API changes

Below are all the changes currently introduced in the 2020-10 version of the REST Admin API.

You can no longer change tax field data using the Country or Province resources.

You can now subscribe to delivery profiles event webhooks.

New topics

  • profiles/create topic was added to webhook resource
  • profiles/update topic was added to webhook resource
  • profiles/delete topic was added to webhook resource