API - Dealing with split orders

This guide is intended for customers with custom-built third-party API integrations. It provides an additional method for handling split orders, rather than the standard approach. It's possible that an order you inject in via the API might get split into multiple orders. This can happen if there isn't enough stock or the order is allocated to be despatched from multiple warehouses for example. If this happens on order creation you get multiple order IDs back in the create order response call.

You then know you need to track or listen out for orders relating to those OrderIDs supplied.

It's also possible for the order to be split into multiple parts at a point in the future so you don't know the order is split. You can deal with this in two ways.

If an order is split at a point after creation, you can register a Webhook to split out about that split. To do this you need to populate ExtraCode5 when adding a connect action.

The URL is then called once an order is split into multiple parts.
​
You receive JSON containing the original order and the new split order with all the details you need to see how the order has been split.

If you notice all the items on the order aren't despatched or are now in multiple parts, you can call the Order/{id}/Splits API which returns any splits that have happened to that order.
​
You receive JSON containing the original order and the new split order with all the details you need to see how the order is split.