Order copies

The order copy object and the allowed CRUD operations on the related resource endpoint

Order copies generate asynchronously a copy of a source order and all of its associated line items, line item options, payment source (if stored within the customer wallet) and addresses.

They can be used standalone to allow orders editing (no matter their state) or generated recursively as part of a manually generated order subscription, in which case they are usually automatically placed according to the specified frequency.

You can set different options, based on how you want the order copy process to be performed:

  • place_target_order — the copied order is going to be placed at the end of the process; default for order subscriptions.

  • cancel_source_order — the source order is going to be cancelled at the end of the process.

Order copies create frozen copies of the source order. That means that promotions and discounts line items are copied as is, without being recomputed. A recalculation occurs only if the target order is edited (e.g. adding or removing line items).

Data model

Check the related ER diagram and explore the flowchart that illustrates how the order copy resource relates to the other API entities.

Last updated