Edit existing orders

• Your app can makeauthenticated requeststo the GraphQL Admin API.

• Your app has thewrite_order_editsaccess scope.

• You've met Shopify'sprotected customer data requirements.

• You're editing an order that was placed in your store currency.

  Your store currency is the currency that's used in your Shopify admin to price products and display reports. You can only edit orders placed in your store currency, regardless of whether you sell in multiple currencies.

• You're editing an order that was placed after January 1, 2019. You can't edit archived orders or orders placed before January 1st, 2019.

TheorderEditBeginmutation is the first step in editing an order. TheorderEditBeginmutation creates aCalculatedOrderobject, which tracks the edits that you want to make to the order.

The following example shows how to pass the order's ID to theorderEditBeginmutation and request the ID of theCalculatedOrderobject as a return field:

After you have theCalculatedOrderobject ID, you can make the following types of edits to the order:

• Add a new variant
• Add a discount to the variant
• Remove a discount from a variant
• Add a custom line item
• Edit line item quantity

Add a new product variant to an order with theorderEditAddVariantmutation.

The following example adds a new product variant with a quantity of three to the order:

In the mutation's input, include theCalculatedOrderobject ID, the variant ID and the variant quantity. Request the ID of the added line items using theaddedLineItemsfield to verify that our variant was added correctly.

Add a fixed amount or percentage discount to a line item with theorderEditAddLineItemDiscountmutation.

In the mutation's input, include theCalculatedOrderobject ID, the line item ID, and theOrderEditAppliedDiscountInputinputs.

Remove a fixed amount or percentage discount from a line item with theorderEditRemoveLineItemDiscountmutation.

In the mutation's input, include theCalculatedOrderobject ID and thediscountApplicationId.

Add a custom line item to an order with theorderEditAddCustomItemmutation.

The following example adds a custom line item to the order for gift wrapping.

In the mutation's input, include theCalculatedOrderID, line item title, quantity, and price in theorderEditAddCustomItemfield. In the response, request the added line item’s ID, title, and quantity to verify that the custom line item was added correctly.

You can use theorderEditSetQuantity突变调整行项目数量增加n additional gift wrapping service to the order.

In the mutation's input, include the orderid,lineItemId, and the newquantityvalue that you want to set. In the response, request the ID and quantity of the line items to verify that the line item quantity was updated correctly.

When you're satisfied with your changes, you can commit them to the order with theorderEditCommitmutation. TheorderEditCommitmutation commits the changes tracked by theCalculatedOrderobject to the order.

In the mutation's input, include theCalculatedOrderobject ID, thestaffNotefield, and thenotifyCustomerfield set tofalse. IfnotifyCustomeris set totrue, then an email invoice with the updated order information is sent to the customer.

To be notified when an order is edited, subscribe your app theorders/updatedwebhook. The webhook is triggered whenever an order edit is completed.

To learn how to set up and consume webhooks, refer toWebhooks configuration overview.

• Consult themerchant documentationto learn about editing orders in the Shopify admin.
• Learn how tocreate test orders and transactionsto validate your app's behavior.
• Explore examples for querying orders, includingretrieving sales data from an order, using the GraphQL Admin API.