Orders

Orders creates an order from a basket and reads or updates the current end user’s orders. An order carries the basket’s items and currency, your own data fields (shipping, payment, notes), and platform-maintained status, totalAmount, and itemCount. Available wherever a current end user exists: tools, dynamic jobs, and trigger-fired turns (see execution contexts). Verified against lua-cli 3.33.0.

import { Orders, OrderStatus } from 'lua-cli';

Quick example

import { Orders, OrderStatus } from 'lua-cli';

const order = await Orders.create({ basketId: 'basket_abc123', data: { paymentMethod: 'stripe' } });
await order.updateStatus(OrderStatus.CONFIRMED);
await order.update({ trackingNumber: '1Z999AA10123456784' });
console.log(order.toJSON().id, order.status, order.trackingNumber);

Methods

create()

Creates an order from a basket’s items.

Orders.create(orderData: { basketId: string; data: Record<string, any> }): Promise<OrderInstance>

string

required

The basket to convert.

Record<string, any>

required

Your order fields, for example shippingAddress, paymentMethod, and notes.

The parameter is typed any in the SDK; the platform requires basketId. Returns — the order as an OrderInstance with status pending. Example

import { Orders } from 'lua-cli';

const order = await Orders.create({
  basketId: 'basket_abc123',
  data: { shippingAddress: { line1: '1 Main St', city: 'Oslo', postalCode: '0150', country: 'NO' }, paymentMethod: 'stripe' },
});
console.log(order.toJSON().id, Number(order.totalAmount).toFixed(2));

Errors — Failed to create order.

updateStatus()

Sets an order’s status. The status comes first.

Orders.updateStatus(status: OrderStatus, orderId: string): Promise<OrderResponse>

OrderStatus

required

One of the OrderStatus values.

string

required

The order’s id.

Returns

OrderResponse

The raw order record, not an instance.

Show properties

string

Order id.

string

The order’s public identifier.

{ currency: string; items: BasketItem[]; createdAt: string; basketId: string; orderDate: string; orderId: string; [key: string]: any }

Contents and your fields.

{ status: string; totalAmount: string | number; currency: string; itemCount: number }

Platform-maintained totals and status.

string

ISO 8601 timestamps.

Example

import { Orders, OrderStatus } from 'lua-cli';

const updated = await Orders.updateStatus(OrderStatus.FULFILLED, 'order_def456');
console.log(updated.common.status);

Errors — Failed to update order status.

updateData()

Merges fields into an order’s data. The data comes first.

Orders.updateData(data: Record<string, any>, orderId: string): Promise<OrderResponse>

Record<string, any>

required

Fields to add or replace.

string

required

The order’s id.

Returns — the raw order record, as updateStatus(). Example

import { Orders } from 'lua-cli';

await Orders.updateData({ trackingNumber: '1Z999AA10123456784', carrier: 'UPS' }, 'order_def456');

Errors — Failed to update order data.

get()

Returns the current end user’s orders, optionally filtered by status.

Orders.get(status?: OrderStatus): Promise<OrderInstance[]>

OrderStatus

Omit it for every order.

Returns — an array of OrderInstance. Example

import { Orders, OrderStatus } from 'lua-cli';

const pending = await Orders.get(OrderStatus.PENDING);
const revenue = pending.reduce((sum, order) => sum + Number(order.totalAmount), 0);

Errors — Failed to get user orders.

getById()

Returns one order by id.

Orders.getById(orderId: string): Promise<OrderInstance>

Returns — the order as an OrderInstance. An unknown id throws; there is no null return. Example

import { Orders } from 'lua-cli';

const order = await Orders.getById('order_def456');
console.log(order.status, order.items, order.shippingAddress);

Errors — Failed to get order.

OrderInstance

The object create(), get(), getById(), and Baskets.placeOrder() return. Every order field is readable directly through the instance’s proxy: status, totalAmount, itemCount, and currency from the platform, items, basketId, orderDate, createdAt, and your own data fields. Direct assignments stay local until save(). The identity fields id, orderId, userId, and agentId and the raw data and common objects are private in the type declarations, so order.id doesn’t compile. Read the id from order.toJSON().id. totalAmount is typed string | number; wrap it in Number() before arithmetic.

updateStatus()

Sets the status and refreshes the instance’s platform fields.

order.updateStatus(status: OrderStatus): Promise<any>

Returns — the order’s fields, { ...data, ...common, id }.

update()

Merges fields into data on the server and refreshes the instance.

order.update(data: Record<string, any>): Promise<any>

Returns — the order’s fields, { ...data, ...common, id }.

save()

Writes the whole local data to the server.

order.save(): Promise<boolean>

Returns — true. Example

import { Orders } from 'lua-cli';

const order = await Orders.getById('order_def456');
order.carrier = 'UPS';
order.estimatedDelivery = '2026-09-20';
await order.save();

Errors — Failed to save order data.

toJSON()

Returns { ...data, ...common, id }, which is what JSON.stringify(order) and console.log(order) print.

Types

OrderStatus

Member	Value	Meaning
`OrderStatus.PENDING`	`pending`	Created, not yet confirmed; the initial status
`OrderStatus.CONFIRMED`	`confirmed`	Confirmed and being processed
`OrderStatus.FULFILLED`	`fulfilled`	Completed
`OrderStatus.CANCELLED`	`cancelled`	Cancelled

OrderInstance and OrderStatus are exported. OrderResponse is not; name it from Orders.updateStatus.

import { Orders, OrderStatus } from 'lua-cli';

type OrderRecord = Awaited<ReturnType<typeof Orders.updateStatus>>;

export function isOpen(order: OrderRecord): boolean {
  return order.common.status === OrderStatus.PENDING || order.common.status === OrderStatus.CONFIRMED;
}

SDK

CLI

REST API

Quick example

Methods

create()

updateStatus()

updateData()

get()

getById()

OrderInstance

updateStatus()

update()

save()

toJSON()

Types

OrderStatus

See also

​Quick example

​Methods

​create()

​updateStatus()

​updateData()

​get()

​getById()

​OrderInstance

​updateStatus()

​update()

​save()

​toJSON()

​Types

​OrderStatus

​See also

Quick example

Methods

create()

updateStatus()

updateData()

get()

getById()

OrderInstance

updateStatus()

update()

save()

toJSON()

Types

OrderStatus

See also