| Release date | Date version is no longer supported |
|---|---|
| October 1, 2020 | October 1, 2021 |
We've deprecated the type filter parameter on CodeDiscountQuery. Use discount_type instead. For more information about deprecated fields, refer to QueryRoot.
We've deprecated the following fields in the GraphQL Admin API:
restocked field in the Refund object. Use RefundLineItem.restockType instead.refundType field in the RefundLineItem object. Use RefundLineItem.restockType instead.We've added new fields, mutations, arguments, and types to extend and enhance what you can do with discounts. You can now use the GraphQL Admin API to do the following:
Learn how to manage discounts using the GraphQL Admin API.
New fields
discountRedeemCodeSavedSearches field was added to type QueryRootasyncUsageCount field was added to type DiscountAutomaticBasicasyncUsageCount field was added to type DiscountAutomaticBxgyhasTimelineComment field was added to type DiscountCodeBasicshareableUrls field was added to type DiscountCodeBasictotalSales field was added to type DiscountCodeBasicasyncUsageCount field was added to type DiscountRedeemCodeid field was added to type DiscountRedeemCodetargetItemImage field was added to type DiscountShareableUrltargetType field was added to type DiscountShareableUrltitle field was added to type DiscountShareableUrlurl field was added to type DiscountShareableUrlhasTimelineComment field was added to type DiscountCodeBxgyshareableUrls field was added to type DiscountCodeBxgytotalSales field was added to type DiscountCodeBxgyhasTimelineComment field was added to type DiscountCodeFreeShippingmaximumShippingPrice field was added to type DiscountCodeFreeShippingshareableUrls field was added to type DiscountCodeFreeShippingtotalSales field was added to type DiscountCodeFreeShippingNew mutations
discountCodeBulkActivate was addeddiscountCodeBulkDeactivate was addeddiscountCodeBulkDelete was addeddiscountCodeRedeemCodeBulkDelete was addedNew arguments
after argument was added to field discountRedeemCodeSavedSearches in type QueryRootbefore argument was added to field discountRedeemCodeSavedSearches in type QueryRootfirst argument was added to field discountRedeemCodeSavedSearches in type QueryRootlast argument was added to field discountRedeemCodeSavedSearches in type QueryRootquery argument was added to field discountRedeemCodeSavedSearches in type QueryRootreverse argument was added to field discountRedeemCodeSavedSearches in type QueryRootsortKey argument was added to field discountRedeemCodeSavedSearches in type QueryRootids argument was added to mutation discountCodeBulkActivatesavedSearchId argument was added to mutation discountCodeBulkActivatesearch argument was added to mutation discountCodeBulkActivateids argument was added to mutation discountCodeBulkDeactivatesavedSearchId argument was added to mutation discountCodeBulkDeactivatesearch argument was added to mutation discountCodeBulkDeactivateids argument was added to mutation discountCodeBulkDeletesavedSearchId argument was added to mutation discountCodeBulkDeletesearch argument was added to mutation discountCodeBulkDeletediscountId argument was added to mutation discountCodeRedeemCodeBulkDeleteids argument was added to mutation discountCodeRedeemCodeBulkDeletesavedSearchId argument was added to mutation discountCodeRedeemCodeBulkDeletesearch argument was added to mutation discountCodeRedeemCodeBulkDeletequery argument was added to field codes in type DiscountCodeBasicsavedSearchId argument was added to field codes in type DiscountCodeBasicsortKey argument was added to field codes in type DiscountCodeBasicquery argument was added to field codes in type DiscountCodeBxgysavedSearchId argument was added to field codes in type DiscountCodeBxgysortKey argument was added to field codes in type DiscountCodeBxgyquery argument was added to field codes in type DiscountCodeFreeShippingsavedSearchId argument was added to field codes in type DiscountCodeFreeShippingsortKey argument was added to field codes in type DiscountCodeFreeShippingNew and updated types
DiscountShareableUrl type was addedDiscountCodeBulkActivatePayload type was addedDiscountCodeBulkDeactivatePayload type was addedDiscountShareableUrlTargetType type was addedDiscountCodeBulkDeletePayload type was addedDiscountCodeRedeemCodeBulkDeletePayload type was addedDISCOUNT_CODE was added to enum ResourceTypeDISCOUNT_REDEEM_CODE was added to enum SearchResultTypeCOLLECTION was added to enum DiscountShareableUrlTargetTypeHOME was added to enum DiscountShareableUrlTargetTypePRODUCT was added to enum DiscountShareableUrlTargetTypeINCLUSION was added to enum DiscountErrorCodejob field was added to type DiscountCodeBulkActivatePayloaduserErrors field was added to type DiscountCodeBulkActivatePayloadjob field was added to type DiscountCodeBulkDeactivatePayloaduserErrors field was added to type DiscountCodeBulkDeactivatePayloadjob field was added to type DiscountCodeBulkDeletePayloaduserErrors field was added to type DiscountCodeBulkDeletePayloadjob field was added to type DiscountCodeRedeemCodeBulkDeletePayloaduserErrors field was added to type DiscountCodeRedeemCodeBulkDeletePayloadmaximumShippingPrice field was added to type DiscountCodeFreeShippingInputWe 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 was added to object OrdercurrentSubtotalLineItemsQuantity was added to object OrdercurrentSubtotalPriceSet was added to object OrdercurrentTaxLines was added to object OrdercurrentTotalDiscountsSet was added to object OrdercurrentTotalPriceSet was added to object OrdercurrentTotalTaxSet was added to object OrdercurrentTotalWeight was added to object OrderApps can now edit orders they created. Previously, apps could only edit orders created through a Shopify channel (for example, POS, online store, or draft orders).
To determine if your app can edit an order on Shopify, you can query the merchantEditable field on the Order object. If the return value of this field is true, your app can edit the order.
We also added a new merchantEditableErrors field to the Order object. If your app can't edit an order, then you can use this field to determine the reason why.
You can now query the order that is associated to a refund.
New field
order field was added to object RefundYou can now query a list of line items that contain shipping costs on existing orders.
New connection
shippingLines was added to object OrderYou can now add discounts while editing orders. The following are use cases for adding discounts during order editing:
To learn how to use the GraphQL Admin API to add discounts during order editing, refer to our Edit existing orders.
New mutations
OrderEditAddLineItemDiscount was addedOrderEditRemoveLineItemDiscount was addedUpdated mutation
allowDuplicates argument was added to OrderEditAddVariantNew types
OrderEditRemoveLineItemDiscountPayload was addedCalculatedDiscountApplication object was addedCalculatedDiscountAllocation object was addedOrderStagedChangeAddLineItemDiscount object was addedOrderEditDiscountInput input object was addedDiscountApplicationLevel enum was addedNew field
CalculatedDiscountAllocation field was added to object type CalculatedLineItemNew connection
CalculatedDiscountApplication was added to object type CalculatedOrderYou can now query the delivery method on fulfillment orders. A fulfillment order delivery method can help you figure out how the line items represented by the fulfillment order should be delivered, or if they need to be picked up in-store.
New and updated types
DeliveryMethod type was addedDeliveryMethodType type was addeddeliveryMethod field was added to type FulfillmentOrderid field was added to type DeliveryMethodmethodType field was added to type DeliveryMethodLOCAL enum value was added to type DeliveryMethodTypeNONE enum value was added to type DeliveryMethodTypePICK_UP enum value was added to type DeliveryMethodTypeRETAIL enum value was added to type DeliveryMethodTypeSHIPPING enum value was added to type DeliveryMethodTypeUse the GraphQL Admin API to identify, filter, and manage products based on their current product status.
Each product can have one of the following statuses:
draft: The product isn't ready to sell and is unavailable to customers on sales channels and apps.active: The product is ready to sell and can be made available to customers on the online store, sales channels, and apps. By default, existing products are set to active.archived: The product is no longer being sold and isn't available to customers on sales channels and apps.To learn how to use product statuses, refer to the ProductStatus enum.
New and updated mutations
ProductChangeStatus mutation was addednewStatus argument was added to mutation ProductDuplicateNew fields
status field was added to object Productstatus field was added to input object ProductInputNew and updated types
ResourcePublicationV2 object was addedProductStatus enum was addedResourcePublicationsV2 connection was added to type PublishableYou can now use the GraphQL Admin API to add a media image to a product variant. To learn how to add a media image to a product variant, refer to our Manage variant media with the GraphQL Admin API tutorial.
New and updated mutations
ProductVariantAppendMediaInput input object was addedProductVariantDetachMediaInput input object was addedmediaSrc input field was added to ProductVariantInputNew and updated types
ProductVariantAppendMediaInput input object was addedProductVariantDetachMediaInput input object was addedmediaSrc input field was added to ProductVariantInputmedia connection was added to object type ProductVariantNew error codes
BLANK was added to enum MediaUserErrorMEDIA_DOES_NOT_EXIST_ON_PRODUCT was added to enum MediaUserErrorTOO_MANY_MEDIA_PER_INPUT_PAIR was added to enum MediaUserErrorMAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED was added to enum MediaUserErrorINVALID_MEDIA_TYPE was added to enum MediaUserErrorPRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES was added to enum MediaUserErrorPRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT was added to enum MediaUserErrorNON_READY_MEDIA was added to enum MediaUserErrorPRODUCT_VARIANT_ALREADY_HAS_MEDIA was added to enum MediaUserErrorMEDIA_IS_NOT_ATTACHED_TO_VARIANT was added to enum MediaUserErrorUse the GraphQL Admin API to update the text content of legal policies associated with a shop. Policies are specified by policy type.
New mutation
ShopPolicyUpdate was addedNew types
ShopPolicy object type was addedShopPolicyInput input object was addedShopPolicyType enum was addedShopPolicyUserError was addedNew field
shopPolicies was added to object shopUse the GraphQL Admin API to query the price range of a product (the lowest and highest priced variants).
New and updated types
ProductPriceRangeV2 type was addedpriceRangeV2 field was added to type ProductUse the GraphQL Admin API to query if a shop is eligible to enable international domains.
New field
internationalDomains was added to type ShopFeaturesUse the GraphQL Admin API to create a new marketing activity.
New mutation
marketingActivityCreate was addedWe'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.
New error codes
VIDEO_METADATA_READING_ERROR was added to enum MediaErrorCodeVIDEO_INVALID_FILETYPE_ERROR was added to enum MediaErrorCodeVIDEO_MIN_WIDTH_ERROR was added to enum MediaErrorCodeVIDEO_MAX_WIDTH_ERROR was added to enum MediaErrorCodeVIDEO_MIN_HEIGHT_ERROR was added to enum MediaErrorCodeVIDEO_MAX_HEIGHT_ERROR was added to enum MediaErrorCodeVIDEO_MIN_DURATION_ERROR was added to enum MediaErrorCodeVIDEO_MAX_DURATION_ERROR was added to enum MediaErrorCodeMODEL3D_THUMBNAIL_GENERATION_ERROR was added to enum MediaErrorCodeMODEL3D_GLB_TO_USDZ_CONVERSION_ERROR1 was added to enum MediaErrorCodeMODEL3D_GLB_OUTPUT_CREATION_ERROR was added to enum MediaErrorCodeUNSUPPORTED_IMAGE_FILE_TYPE was added to enum MediaErrorCodeINVALID_IMAGE_FILE_SIZE was added to enum MediaErrorCodeNew field
mimeType was added to object MediaImage
You can now use the GraphQL Admin API to query a customer's activity on a shop's online store.
New type
CustomerJourneySummary was addedYou can now subscribe to delivery profiles event webhooks.
New topics
PROFILES_CREATE value was added to enum WebhookSubscriptionTopicPROFILES_UPDATE value was added to enum WebhookSubscriptionTopicPROFILES_DELETE value was added to enum WebhookSubscriptionTopicYou can now query a shop's shipping policy using the shippingPolicy field.
New field
shippingPolicy was added to object ShopWe've deprecated the include-risk-analysis header that includes order risks and risk analysis objects in the Order payload.
The existence of this deprecated header was not previously documented. The REST Admin API and GraphQL Admin API are not affected by this change.
If you request the header using an API version earlier than 2020-10, then the header will still be returned.
Use the Product resource to identify, filter, and manage products based on their current product status.
Each product can have one of the following statuses:
draft: The product isn't ready to sell and is unavailable to customers on sales channels and apps.active: The product is ready to sell and can be made available to customers on the online store, sales channels, and apps. By default, existing products are set to active.archived: The product is no longer being sold and isn't available to customers on sales channels and apps.To learn how to use product statuses, refer to the Product resource.
New property
status property added to Product resource
New query parameter
status parameter added to Product resource
Use the Refund resource to add refund duties to your request body. This capability provides parity with the GraphQL Admin API.
The refund_duties object includes two fields: duty_id and refund_type. You can specify how you want the duty refunded by setting one of the following values on refund_type:
FULL: Refunds all the duties associated with a duty ID.PROPORTIONAL: Refunds duties in proportion to the line item quantity that you want to refund.We've added better reporting and feedback for batch discount code creation jobs. The new logs property specifies when no discount codes were created because the provided data was invalid.
New property
logs was added to DiscountCode batch endpointYou can now subscribe to delivery profiles event webhooks.
New topics
profiles/create topic was added to webhook resourceprofiles/update topic was added to webhook resourceprofiles/delete topic was added to webhook resource