---
title: "Record an order"
method: POST
path: "/v1/orders"
---

# Record an order

`POST /v1/orders`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/orders`
- Auth: HTTP bearer

## Request body

- object
  - `buyer_name` string, nullable
  - `customer_id` string, uuid, nullable
  - `reference` string, nullable
  - `status` 'pending' | 'paid' | 'fulfilled' | 'cancelled' | 'refunded'
  - `currency` string, nullable
  - `placed_at` string, date-time, nullable
  - `items` object[], required
    - `variant_id` string, uuid, nullable
    - `title` string, required
    - `unit` number, required
    - `quantity` integer, required

## Response `200`

Default Response

- unknown

---

[API](https://skmtc.dev/octapi/apis/octapi-api.md) · [All operations](https://skmtc.dev/octapi/apis/octapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/octapi/apis/octapi-api/revisions/580afda787d2?raw)