Avalex Orders API — Create and Manage Order Records

The /orders resource records purchase transactions in Avalex. An order captures which customer made a purchase, which products were included, the total amount charged, and the IDs of any licenses that were generated as a result. Orders provide an auditable paper trail connecting your customers, products, and licenses in a single record.

Required Permissions

Action	Permission
List / retrieve orders	`orders:read`
Create / update orders	`orders:write`
Delete orders	`orders:delete`

List All Orders

string

required

Bearer <token> or Basic credentials.

Returns an array of all order records in your Avalex account.

curl http://localhost:8080/orders \
  -H "Authorization: Bearer <token>"

Response — 200 OK

[
  {
    "id": "ord_123",
    "customerId": "cust_123",
    "productIds": ["prod_123"],
    "totalAmount": 299.99,
    "licenseIds": ["lic_12345"],
    "createdAtEpochMillis": 1723140000000
  }
]

Create an Order

string

required

Bearer <token> or Basic credentials.

string

required

ID of the customer placing the order.

string[]

required

Array of product IDs included in this order.

number

required

Total charged amount in your account’s base currency.

string[]

Array of license IDs to associate with this order. These should reference licenses already created via /licenses.

Creates a new order record and returns it with a server-generated ID.

curl -X POST http://localhost:8080/orders \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cust_123",
    "productIds": ["prod_123"],
    "totalAmount": 299.99,
    "licenseIds": ["lic_12345"]
  }'

Response — 201 Created

{
  "id": "ord_123",
  "customerId": "cust_123",
  "productIds": ["prod_123"],
  "totalAmount": 299.99,
  "licenseIds": ["lic_12345"],
  "createdAtEpochMillis": 1723140000000
}

Get an Order by ID

string

required

The unique order ID (e.g. ord_123).

Returns a single order record. Responds with 404 Not Found if no order with that ID exists.

curl http://localhost:8080/orders/ord_123 \
  -H "Authorization: Bearer <token>"

Response — 200 OK

{
  "id": "ord_123",
  "customerId": "cust_123",
  "productIds": ["prod_123"],
  "totalAmount": 299.99,
  "licenseIds": ["lic_12345"],
  "createdAtEpochMillis": 1723140000000
}

Update an Order

string

required

The unique order ID.

Performs a full replacement of the order record. You must include all fields you want to retain. Returns 404 Not Found if the order does not exist.

This is a full replacement (PUT). Omitted fields — such as licenseIds — will be cleared. Include all existing values you want to keep.

curl -X PUT http://localhost:8080/orders/ord_123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cust_123",
    "productIds": ["prod_123"],
    "totalAmount": 349.99,
    "licenseIds": ["lic_12345"]
  }'

Response — 200 OK

{
  "id": "ord_123",
  "customerId": "cust_123",
  "productIds": ["prod_123"],
  "totalAmount": 349.99,
  "licenseIds": ["lic_12345"],
  "createdAtEpochMillis": 1723140000000
}

Delete an Order

string

required

The unique order ID.

Permanently removes the order record. Returns 204 No Content on success and 404 Not Found if the ID does not exist.

curl -X DELETE http://localhost:8080/orders/ord_123 \
  -H "Authorization: Bearer <token>"

Response — 204 No Content

Order Schema

Show Order fields

string

Unique identifier for the order, assigned by Avalex on creation (e.g. ord_123).

string

ID of the customer who placed this order.

string[]

Array of product IDs included in this order. An order may reference one or more products.

number

Total charged amount for the order in your account’s base currency.

string[]

Array of license IDs associated with this order. Each entry references a license record in /licenses.

number

Unix timestamp in milliseconds representing when this order was created.

Full Schema Example

{
  "id": "ord_123",
  "customerId": "cust_123",
  "productIds": ["prod_123"],
  "totalAmount": 299.99,
  "licenseIds": ["lic_12345"],
  "createdAtEpochMillis": 1723140000000
}

Authentication

License Validation

Resources

Staff & Admin

Audit Logs

Avalex Orders API — Create and Manage Order Records

Required Permissions

List All Orders

Create an Order

Get an Order by ID

Update an Order

Delete an Order

Order Schema

Full Schema Example

​Required Permissions

​List All Orders

​Create an Order

​Get an Order by ID

​Update an Order

​Delete an Order

​Order Schema

​Full Schema Example

Required Permissions

List All Orders

Create an Order

Get an Order by ID

Update an Order

Delete an Order

Order Schema

Full Schema Example