Shop

Place an order from a cart

post/orders

Request

  • Base URL
    https://gorest.co.in/public/v3
  • URL
    https://gorest.co.in/public/v3/orders
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

A unique key (a UUID is fine) that makes a POST safe to retry for 24 hours. A retry with the same key, path and body gets the first answer again with Idempotent-Replayed: true and creates nothing; a retry while the first is still running gets 409 conflict with Retry-After: 1. The same key with another request gets 422 idempotency_key_mismatch. Only a 2xx answer is kept, so after an error the retry runs again. An answer over 64 KiB, or one that holds a new token's value, is not kept: its retry gets 409 conflict with the Location of what the first request made.

Request body

cart_idstring uuid required

An active cart of yours with at least one line. Its lines become the order's at the current prices, the stock is taken, and the cart becomes ordered.

Response

The new order.

cart_idstring uuid nullable

The cart it was placed from; null once that cart is deleted.

created_atstring date-time
currencystring
idstring uuid required
read_onlyboolean

True for sample data (the seed); it cannot be changed.

status'pending' | 'paid' | 'fulfilled' | 'cancelled' | 'refunded'

pending to paid or cancelled; paid to fulfilled or refunded; fulfilled to refunded. A cancel puts the stock back.

total_minorinteger

The sum of the lines.

updated_atstring date-time
user_idstring uuid nullable

The cart's user; null once that user is deleted.

Example response

{
  "user": {
    "email": "aarav.sharma@example.com",
    "name": "Aarav Sharma"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.