Skip to main content
POST
cURL

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 | null
shipping_address
object | null
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>