> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/how-tos/placing-orders/checkout/placing-the-order.md). # 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](/files/vHCr46uBZxaWWjRSqXow) ## 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 {% tabs %} {% tab title="Request" %} The following request places the order identified by the "NgojhKoyYN" ID: ```javascript curl -g -X PATCH \ 'https://yourdomain.commercelayer.io/api/orders/NgojhKoyYN' \ -H 'Authorization: Bearer your-access-token' \ -H 'Accept: application/vnd.api+json' \ -H 'Content-Type: application/vnd.api+json' \ -d '{ "data": { "type": "orders", "id": "NgojhKoyYN", "attributes": { "_place": true } } }' ``` {% endtab %} {% tab title="Response" %} On success, the API responds with a `200 OK` status code, returning the updated order object: ```javascript { "data": { "id": "NgojhKoyYN", "type": "orders", "links": { "self": "https://yourdomain.commercelayer.io/api/orders/NgojhKoyYN" }, "attributes": { "number": 1234, "status": "placed", "payment_status": "authorized", "fulfillment_status": "unfulfilled", "guest": true, "editable": false, "placeable": false, "customer_email": "john@example.com", "language_code": "en", "currency_code": "EUR", "tax_included": true, "tax_rate": 0.22, "freight_taxable": true, "requires_billing_info": true, "country_code": "IT", "shipping_country_code_lock": null, "coupon_code": "COUPON12-345", "gift_card_code": "GIFT1234-ABC", "gift_card_or_coupon_code": "GIFT1234-ABC", "subtotal_amount_cents": 84300, "subtotal_amount_float": 843.0, "formatted_subtotal_amount": "€843,00", "shipping_amount_cents": 1000, "shipping_amount_float": 10.0, "formatted_shipping_amount": "€10,00", "payment_method_amount_cents": 0, "payment_method_amount_float": 0.0, "formatted_payment_method_amount": "€0,00", "discount_amount_cents": -8430, "discount_amount_float": -84.30, "formatted_discount_amount": "-€84,30", "adjustment_amount_cents": 0, "adjustment_amount_float": 0.0, "formatted_adjustment_amount": "€0,00", "gift_card_amount_cents": -5000, "gift_card_amount_float": -50.0, "formatted_gift_card_amount": "-€50,00", "total_tax_amount_cents": 16860, "total_tax_amount_float": 168.60, "formatted_total_tax_amount": "€168,60", ... "other": "more order attributes", ... "total_amount_with_taxes_cents": 71870, "total_amount_with_taxes_float": 718.70, "formatted_total_amount_with_taxes": "€718,70", "fees_amount_cents": 0, "fees_amount_float": 0.0, "formatted_fees_amount": "€0,00", "skus_count": 7, "line_item_options_count": 0, "shipments_count": 0, "payment_source_details": { "type": "credit_card" }, "token": "your-order-token", "cart_url": null, "return_url": null, "terms_url": null, "privacy_url": null, "checkout_url": "https://checkout.yourdomain.com/NgojhKoyYN", "placed_at": "2018-02-01T12:00:00.000Z", "approved_at": null, "cancelled_at": null, "payment_updated_at": null, "fulfillment_updated_at": null, "created_at": "2018-01-01T12:00:00.000Z", "updated_at": "2018-01-01T12:00:00.000Z", "reference": null, "metadata": {} }, "relationships": { "market": { "links": {...} }, "customer": { "links": {...} }, "shipping_address": { "links": {...} }, "billing_address": { "links": {...} }, "available_payment_methods": { "links": {...} }, "available_customer_payment_sources": { "links": {...} }, "payment_method": { "links": {...} }, "payment_source": { "links": {...} }, "line_items": { "links": {...} }, "shipments": { "links": {...} } }, "meta": { "mode": "test", "organization_id": "Fu5vHgJkLm", "trace_id": "6f9a2b5c8d1e4f7a0b3c6d9e2f5a8b1c4d7e0f3a6b9c2d5e8f1a4b7c0d3e6f9a2" } }, "meta": { "mode": "test", "organization_id": "Fu5vHgJkLm", "trace_id": "6f9a2b5c8d1e4f7a0b3c6d9e2f5a8b1c4d7e0f3a6b9c2d5e8f1a4b7c0d3e6f9a2" } } ``` {% endtab %} {% endtabs %} ## 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](https://docs.commercelayer.io/developers/v/api-reference/stock_items), [shipment](https://docs.commercelayer.io/developers/v/api-reference/shipments), and [gift card](https://docs.commercelayer.io/developers/v/api-reference/gift_cards) objects or on how to update an order. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.commercelayer.io/how-tos/placing-orders/checkout/placing-the-order.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.