Skip to main content
POST
/
orders
cURL
curl -X POST https://api.neuraldraft.io/v1/orders \
  -H "Authorization: Bearer ndsk_live_yourkey" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"items":[{"product_id":32,"quantity":1}],"customer":{"name":"Joe","email":"joe@example.com"},"payment_method":"manual"}'
{
  "id": 901,
  "order_number": "ND-1745014102-A8F2",
  "customer_email": "jsmith@example.com",
  "status": "pending",
  "payment_status": "unpaid",
  "total": 123,
  "currency": "gbp",
  "customer_name": "<string>",
  "customer_phone": "<string>",
  "subtotal": 123,
  "tax_amount": 123,
  "shipping_amount": 123,
  "discount_amount": 123,
  "payment_method": "stripe",
  "billing_address": {},
  "shipping_address": {},
  "notes": "<string>",
  "admin_notes": "<string>",
  "items": [
    {
      "name": "<string>",
      "quantity": 1,
      "unit_price": 2999,
      "total": 2999,
      "product_id": 123,
      "product_variant_id": 123,
      "sku": "<string>",
      "metadata": {}
    }
  ],
  "paid_at": "2023-11-07T05:31:56Z",
  "shipped_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.neuraldraft.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Project API key. Pass as Authorization: Bearer ndsk_live_.... Manage keys via /projects/me/api-keys. Test-mode keys use the ndsk_test_ prefix.

Headers

​
Idempotency-Key
string

Unique key (any string up to 255 chars; UUID recommended). Retries with the same key within 24 hours return the original response without re-executing side effects.

Maximum string length: 255

Body

application/json
​
items
object[]
required
Minimum array length: 1
​
customer
object
required
​
billing_address
object
​
shipping_address
object
​
payment_method
enum<string>
default:stripe
Available options:
stripe,
manual
​
notes
string

Response

Created.

​
id
integer
required
Example:

901

​
order_number
string
required
Example:

"ND-1745014102-A8F2"

​
customer_email
string<email>
required
​
status
enum<string>
required
Available options:
pending,
paid,
processing,
shipped,
delivered,
cancelled,
refunded
​
payment_status
enum<string>
required
Available options:
unpaid,
paid,
partially_refunded,
refunded,
failed
​
total
integer
required
​
currency
string
required
Example:

"gbp"

​
customer_name
string
​
customer_phone
string | null
​
subtotal
integer
​
tax_amount
integer
​
shipping_amount
integer
​
discount_amount
integer
​
payment_method
enum<string> | null
Available options:
stripe,
manual
​
billing_address
object
​
shipping_address
object
​
notes
string | null
​
admin_notes
string | null

Hidden in public lookups.

​
items
object[]
​
paid_at
string<date-time> | null
​
shipped_at
string<date-time> | null
​
delivered_at
string<date-time> | null
​
cancelled_at
string<date-time> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>