Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Body

application/json
Minimum array length: 1
id
string
required

Unique order identifier

Example:

"08c0e60e-26bd-4e41-bb05-97bfbe1ba7cd"

friendlyName
string
required

Human-readable order name (e.g., #1059)

Example:

"#1059"

customer
object
required
orderTotal
number
required

Total order amount in Stripe format (e.g., 3995 = $39.95)

Example:

3995

currency
string
required

Currency code following ISO 4217 standard

Example:

"USD"

items
object[]
required

Array of ordered items

externalId
string

Order ID in the external system (your internal ID)

Example:

"order_12345"

metadata
object

Additional information in JSON format for AI prompting

Example:
status
enum<string>

Current order status

Available options:
open,
paid,
refunded,
partially_refunded,
cancelled,
disputed,
completed,
shipped,
fulfilled
Example:

"paid"

shipmentStatus
enum<string>

Shipping status

Available options:
none,
confirmed,
in_transit,
out_for_delivery,
attempted_delivery,
ready_for_pickup,
delivered,
failure
Example:

"in_transit"

source
enum<string>

Order source

Available options:
online,
in_store
Example:

"online"

trackingUrl
string

Shipping tracking URL

Example:

"https://tracking.example.com/12345"

address
object

Response

Orders created successfully

count
integer

Number of orders created

Example:

2

result
object[]

Array of created orders