Placing the order

Problem
You have a pending order and you want to place it, authorizing the associated payment source.
A sample checkout last step
Solution
To place an order, send a PATCH request to the /api/orders/:id endpoint, setting the _place attribute to true. If the order is valid — i.e. it has all the required information — the associated payment source is authorized and the order status changes to placed.
Example
Request
Response
The following request places the order identified by the "NgojhKoyYN" ID:
1
curl -g -X PATCH \
2
  'https://yourdomain.commercelayer.io/api/orders/NgojhKoyYN' \
3
  -H 'Authorization: Bearer your-access-token' \
4
  -H 'Accept: application/vnd.api+json' \
5
  -H 'Content-Type: application/vnd.api+json' \
6
  -d '{
7
    "data": {
8
      "type": "orders",
9
      "id": "NgojhKoyYN",
10
      "attributes": {
11
        "_place": true
12
      }
13
    }
14
  }'
Copied!
On success, the API responds with a 200 OK status code, returning the updated order object:
1
{
2
  "data": {
3
    "id": "NgojhKoyYN",
4
    "type": "orders",
5
    "links": {
6
      "self": "https://yourdomain.commercelayer.io/api/orders/NgojhKoyYN"
7
    },
8
    "attributes": {
9
      "number": 1234,
10
      "status": "placed",
11
      "payment_status": "authorized",
12
      "fulfillment_status": "unfulfilled",
13
      "guest": true,
14
      "editable": false,
15
      "placeable": false,
16
      "customer_email": "[email protected]",
17
      "language_code": "en",
18
      "currency_code": "EUR",
19
      "tax_included": true,
20
      "tax_rate": 0.22,
21
      "freight_taxable": true,
22
      "requires_billing_info": true,
23
      "country_code": "IT",
24
      "shipping_country_code_lock": null,
25
      "coupon_code": "COUPON12-345",
26
      "gift_card_code": "GIFT1234-ABC",
27
      "gift_card_or_coupon_code": "GIFT1234-ABC",
28
      "subtotal_amount_cents": 84300,
29
      "subtotal_amount_float": 843.0,
30
      "formatted_subtotal_amount": "€843,00",
31
      "shipping_amount_cents": 1000,
32
      "shipping_amount_float": 10.0,
33
      "formatted_shipping_amount": "€10,00",
34
      "payment_method_amount_cents": 0,
35
      "payment_method_amount_float": 0.0,
36
      "formatted_payment_method_amount": "€0,00",
37
      "discount_amount_cents": -8430,
38
      "discount_amount_float": -84.30,
39
      "formatted_discount_amount": "-€84,30",
40
      "adjustment_amount_cents": 0,
41
      "adjustment_amount_float": 0.0,
42
      "formatted_adjustment_amount": "€0,00",
43
      "gift_card_amount_cents": -5000,
44
      "gift_card_amount_float": -50.0,
45
      "formatted_gift_card_amount": "-€50,00",
46
      "total_tax_amount_cents": 16860,
47
      "total_tax_amount_float": 168.60,
48
      "formatted_total_tax_amount": "€168,60",
49
      ...
50
      "other": "more order attributes",
51
      ...
52
      "total_amount_with_taxes_cents": 71870,
53
      "total_amount_with_taxes_float": 718.70,
54
      "formatted_total_amount_with_taxes": "€718,70",
55
      "fees_amount_cents": 0,
56
      "fees_amount_float": 0.0,
57
      "formatted_fees_amount": "€0,00",
58
      "skus_count": 7,
59
      "line_item_options_count": 0,
60
      "shipments_count": 0,
61
      "payment_source_details": {
62
        "type": "credit_card"
63
      },
64
      "token": "your-order-token",
65
      "cart_url": null,
66
      "return_url": null,
67
      "terms_url": null,
68
      "privacy_url": null,
69
      "checkout_url": "https://checkout.yourdomain.com/NgojhKoyYN",
70
      "placed_at": "2018-02-01T12:00:00.000Z",
71
      "approved_at": null,
72
      "cancelled_at": null,
73
      "payment_updated_at": null,
74
      "fulfillment_updated_at": null,
75
      "created_at": "2018-01-01T12:00:00.000Z",
76
      "updated_at": "2018-01-01T12:00:00.000Z",
77
      "reference": null,
78
      "metadata": {}
79
    },
80
    "relationships": {
81
      "market": {
82
        "links": {...}
83
      },
84
      "customer": {
85
        "links": {...}
86
      },
87
      "shipping_address": {
88
        "links": {...}
89
      },
90
      "billing_address": {
91
        "links": {...}
92
      },
93
      "available_payment_methods": {
94
        "links": {...}
95
      },
96
      "available_customer_payment_sources": {
97
        "links": {...}
98
      },
99
      "payment_method": {
100
        "links": {...}
101
      },
102
      "payment_source": {
103
        "links": {...}
104
      },
105
      "line_items": {
106
        "links": {...}
107
      },
108
      "shipments": {
109
        "links": {...}
110
      }
111
    },
112
    "meta": {
113
      "mode": "test"
114
    }
115
  }
116
}
Copied!
Additional notes
Asynchronous callbacks
After an order has been successfully placed, the following actions are performed asynchronously:
The customer orders count is increased
The order stock items are decremented
The status of any order shipment is set to upcoming
The status of any purchased gift cards is set to active
The usage count of any associated promotion is incremented
The usage count of any associated coupon is incremented
The usage count of any associated gift card is incremented
The status of any associated single-use gift card is set to redeemed
More to read
See our API reference if you need more information about the stock item, shipment, and gift card objects or on how to update an order.
Adding a gift card or coupon
Payments
Last modified 1mo ago
Export as PDF
Copy link
Contents