Release date | Date version is no longer supported |
---|---|
July 2, 2020 | July 2, 2021 |
Removed field
ONE
value was removed from enum DiscountApplicationAllocationMethod. ACROSS
is returned in its place as the meaning is the same for explicit discounts.
The following changes were made to the ProductVariant resource:
Removed field
images
value was removed from object type ProductVariant
Access errors in GraphQL now reference the denied resource, rather than returning a generic access denied
error. Responses now also include extensions, which consist of an error code, link to necessary documentation, and the name of the required access scope.
Learn more about access scopes in our documentation.
The localizationExtensions
field was added to the order object. For more information, refer to Manage country fields using localization extensions.
New fields
localizationExtensions
was added to object type Order
totalTipReceived
was added to object type Order
New types
LocalizationExtension
was addedLocalizationExtensionPurpose
enum was addedA new field was added to the BulkOperation resource.
New fields
rootObjectCount
was added to object type BulkOperation
A new field was added to the Customer resource.
New fields
multipassIdentifier
was added to object type Customer
A new field was added to the DraftOrder resource.
New fields
ready
was added to object type DraftOrder
You can now create annual billing subscriptions for your apps. To learn more, refer to Create an annual subscription.
New fields
interval
was added to input object type AppRecurringPricingInput
Updated types
ANNUAL
value was added to enum AppPricingInterval
You can now query a shop's localized domains and subscribe to domain event webhooks.
New fields
localization
was added to object type Domain
domains
was added to object type Shop
New types
DomainLocalization
was addedUpdated types
DOMAINS_UPDATE
value was added to enum WebhookSubscriptionTopic
DOMAINS_DESTROY
value was added to enum WebhookSubscriptionTopic
DOMAINS_CREATE
value was added to enum WebhookSubscriptionTopic
New fields
localizationExtensions
was added to object type Order
New types
LocalizationExtensionEdge
was addedLocalizationExtension
was addedHasLocalizationExtensions
was addedLocalizationExtensionPurpose
was addedLocalizationExtensionConnection
was addedThe endpoint
field of type WebhookSubscriptionEndpoint was added to the webhook subscription object. This replaces the callbackUrl
field. New create and update mutations were added to support EventBridge webhook subscriptions.
New fields
endpoint
was added to object type WebhookSubscription
New types
WebhookSubscriptionEndpoint
was addedWebhookEventBridgeEndpoint
was addedWebhookHttpEndpoint
was addedEventBridgeWebhookSubscriptionUpdatePayload
was addedEventBridgeWebhookSubscriptionInput
was addedEventBridgeWebhookSubscriptionCreatePayload
was addedARN
was addedNew mutations
EventBridgeWebhookSubscriptionCreate
was addedEventBridgeWebhookSubscriptionUpdate
was addedRemoved field
one
value was removed from allocation_method
in the Order resource. across
is returned in its place as the meaning is the same for explicit discounts.
You can now subscribe to domain event webhooks.
New topics
The following changes have been made to the Webhook resource.
domains/create
was added as part of accessing additional data on domains in the GraphQL Admin API.domains/update
was added as part of accessing additional data on domains in the GraphQL Admin API.domains/destroy
was added as part of accessing additional data on domains in the GraphQL Admin API.The Webhook
resource was updated to support EventBridge webhook subscriptions.
Updated properties
address
property was updated to accept a URI or an EventBridge event source ARN.A new error code was added to CheckoutErrorCode.
Updated types
DISCOUNT_ALREADY_APPLIED
was added to enum CheckoutErrorCode
Access errors in GraphQL now reference the denied resource, rather than returning a generic access denied
error. Responses now also include extensions, which consist of an error code, link to necessary documentation, and the name of the required access scope.
Learn more about access scopes in our documentation.