Create an order copy
How to create an order copy via API
To create a new order copy, send a POST request to the /api/order_copies endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/order_copies
Arguments
type
string
Required
attributes.place_target_order
boolean
Optional
attributes.reuse_wallet
boolean
Optional, default is 'true'
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.cancel_source_order
boolean
Optional
attributes.apply_promotions
boolean
Optional, default is 'false'
attributes.skip_errors
boolean
Optional, default is 'false'
attributes.ignore_invalid_coupon
boolean
Optional, default is 'false'
relationships.source_order
object
Required
Example
The following request creates a new order copy:
curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/order_copies' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "order_copies",
    "relationships": {
      "source_order": {
        "data": {
          "type": "orders",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "order_copies",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN"
    },
    "attributes": {
      "type": "recurring_order_copies",
      "status": "in_progress",
      "started_at": "2018-01-01T12:00:00.000Z",
      "completed_at": "2018-01-01T12:00:00.000Z",
      "failed_at": "2018-01-01T12:00:00.000Z",
      "errors_log": {
        "status": [
          "cannot transition from draft to placed"
        ]
      },
      "errors_count": 2,
      "place_target_order": true,
      "reuse_wallet": true,
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "cancel_source_order": true,
      "apply_promotions": true,
      "skip_errors": true,
      "ignore_invalid_coupon": true
    },
    "relationships": {
      "source_order": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/relationships/source_order",
          "related": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/source_order"
        }
      },
      "target_order": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/relationships/target_order",
          "related": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/target_order"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/events"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/event_stores"
        }
      },
      "order_subscription": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/relationships/order_subscription",
          "related": "https://yourdomain.commercelayer.io/api/order_copies/XAyRWNUzyN/order_subscription"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}Last updated

