Skip to main content
POST
/
{version}
/
orders
/
{order_id}
/
items
/
add
Add Order Item
curl --request POST \
  --url https://api.example.com/{version}/orders/{order_id}/items/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "currency": "<string>",
  "qty": 123,
  "amount": 1.01
}
'
{
  "id": 123,
  "name": "<string>",
  "currency": "<string>",
  "qty": 123,
  "amount": 1.01,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
string
required
Allowed value: "v1"
​
order_id
string
required

Body

application/json

AddOrderItemPayload

​
name
string
required
​
currency
string
required

Three-letter ISO-4217 currency code (e.g. USD, LRD, NGN)

Required string length: 3
​
qty
integer
required
​
amount
required

A positive, non-zero amount.

Required range: x >= 0.01

Response

Successful Response

OrderItemResponse

​
id
integer
required
​
name
string
required
​
currency
string
required

Three-letter ISO-4217 currency code (e.g. USD, LRD, NGN)

Required string length: 3
​
qty
integer
required
​
amount
required

A positive, non-zero amount.

Required range: x >= 0.01
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
Last modified on June 23, 2026