How Edit Order integrates with other apps

Most Shopify stores have more than one app installed and how different apps integrate can be really important. This article is all about how Edit Order integrates with other Shopify apps.

Because of the way Edit Order accomplishes edits, there should be no problems with Edit Order integrating with other apps, as long as:

  1. The app can read regular Shopify orders
  2. The app knows not to fulfill a canceled order
  3. The app understands that an order may be canceled or deleted in Shopify, and takes the appropriate actions
  4. The app does not attempt to make refunds solely because an order was canceled

Edit Order accomplishes editing needs by canceling the original order and creating a new order with all your edits intact. This way, other apps will know that the original order has been superseded by the newly edited order. (For more information, see: How Edit Order works).

Best practices for app developers integrating with Edit Order

We have the following recommendations and best practices if you’re building or have an app that needs to ensure compatibility with Edit Order.

  • Identify orders by the order’s “name” field. This field will include suffixes and prefixes as applicable in Shopify. Shopify uses this field by default for all customer-facing interactions and we recommend strongly that your app does the same
  • If you are using webhooks, make sure to listen for all of the following webhook events to make sure your system is aware of changes: 

    orders/canceled, orders/created

  • Do not attempt any refunds as a result of the orders/cancelled webhook as Edit Order already takes care of the refunds if one is due
  • If your app needs to forward refunds to a separate system for processing, we recommend listening on the refunds/create webhook and checking for any refund transactions that have been created