Order copies

The order copy object and its fields

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 an order subscription, in which case they are usually automatically placed according to a 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.

The order copy object

An order copy object is returned as part of the response body of each successful list, retrieve or create API call.

Field

Type

Description

type

string

order_copies

id

string

The order copy unique identifier

links.self

string

The order copy endpoint URL

attributes.status

string

The order copy status. One of 'pending' (default), 'in_progress', 'failed', or 'completed'.

attributes.started_at

datetime

Time at which the order copy was started.

attributes.completed_at

datetime

Time at which the order copy was completed.

attributes.failed_at

datetime

Time at which the order copy has failed.

attributes.place_target_order

boolean

Indicates if the target order must be placed upon copy.

attributes.cancel_source_order

boolean

Indicates if the source order must be cancelled upon copy.

attributes.reuse_wallet

boolean

Indicates if the payment source within the source order customer's wallet must be copied.

attributes.errors_log

array

Contains the order copy errors, if any.

attributes.errors_count

integer

Indicates the number of copy errors, if any.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.source_order

object

The source order to copy from.

relationships.target_order

object

The copied target order.

relationships.order_subscription

object

The associated order subscription.

meta.mode

string

The resource environment (can be one of test or live)