Orders
In these sections you can read about the /orders v3 API.
Differences between /orders v2 and v3
The Orders module and the /orders endpoints have undergone a substantial upgrade in version 3.
The /orders v2 endpoint is used to trigger automations, mainly to send email/SMS to customers, although other activities may be included in the triggered automation. Such automations are set up to be triggered on "order" status or "payment" status. This was not very flexible. There was also no check made against previous requests of the same order, meaning that two identical requests to this endpoint would trigger any matching automation twice.
The updated Order v3 API instead stores the orders sent to the endpoint. This expands the usefulness greatly, allowing orders to now be used in segmentation and other areas of Engage. In v3, automations for an order are triggered by the /actions endpoint, which can be called for any order whenever the integrator wants, increasing flexibility.
There are also differences in the data format, in that v3 has a stricter format than v2. This is to allow more effective extension of the functionality that uses order data, for example order segmentation.
Important
Orders v2 and Orders v3 can be used in parallel, meaning that the same order can be sent to both the /orders v2 and v3 endpoints without affecting each other.