Skip to main content
GET
/
public
/
orders
/
{order_number}
cURL
curl "https://api.neuraldraft.io/v1/public/orders/ND-1745014102-A8F2?email=anna@example.com"
{
  "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.

Path Parameters

order_number
string
required
Example:

"ND-1745014102-A8F2"

Query Parameters

email
string<email>
required

Response

Order.

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>