Transactions

Transaction resource client for order operations

Access through sdk.transactions on a Lomadee instance. Import request and query types from @thelomadee/sdk/domains.

import type {
  GetOrdersQuery,
  CreateOrderBody,
  UpdateOrderBody,
  OrderCustomer,
  OrderItem,
  OrderSubItem,
  OrderSubItemKey,
  OrderStatus,
  OrderQueryStatus,
} from '@thelomadee/sdk/domains';

In the current SDK contract, list, get, create, and update return Promise<unknown>. The package does not export a response type for these methods. Validate or narrow the resolved value in your application before use.

list

list(query: GetOrdersQuery): Promise<unknown>

Parameters — GetOrdersQuery

page · number

Optional page index.

limit · number

Optional page size.

search · string

Optional search string.

status · OrderQueryStatus

Optional single status filter. Union: OrderStatus | 'Canceled'.

statuses · OrderQueryStatus[]

Optional multi-status filter. Accepts Canceled in addition to write statuses.

Returns

Promise<unknown> — response shape is not declared in the current SDK contract.

Example

const result = await sdk.transactions.list({ page: 1, limit: 20, status: 'Pending' });

---

get

get(id: string): Promise<unknown>

id · string · required

Transaction (order) identifier.

Returns

Promise<unknown> — response shape is not declared in the current SDK contract.

Example

const result = await sdk.transactions.get('order-id');

---

create

create(body: CreateOrderBody): Promise<unknown>

Parameters — CreateOrderBody

orderId · string · required

External order identifier.

customer · OrderCustomer

Optional customer payload. See OrderCustomer.

items · OrderItem[] · required

Line items. See OrderItem.

status · OrderStatus

Optional order status for writes. Union: 'Approved' | 'Reproved' | 'Pending'.

value · number · required

Order value.

subItems · OrderSubItem[] · required

Sub-item breakdown. See OrderSubItem.

affiliateId · string · required

Affiliate identifier.

channelId · string

Optional channel identifier.

group · string

Optional grouping label.

Returns

Promise<unknown> — response shape is not declared in the current SDK contract.

Example

import type { CreateOrderBody } from '@thelomadee/sdk/domains';

const body: CreateOrderBody = {
  orderId: 'ext-123',
  affiliateId: 'affiliate-id',
  items: [
    {
      id: 'sku-1',
      name: 'Product',
      imageUrl: 'https://example.com/img.png',
      price: 100,
      listPrice: 120,
      quantity: 1,
      parentId: 'parent-1',
    },
  ],
  value: 100,
  subItems: [{ key: 'Shipping', value: 10 }],
};

const result = await sdk.transactions.create(body);

---

update

update(id: string, body: UpdateOrderBody): Promise<unknown>

id · string · required

Transaction (order) identifier.

Parameters — UpdateOrderBody

id · string

Optional identifier field in body.

customer · OrderCustomer

Optional customer payload. See OrderCustomer.

items · OrderItem[] · required

Line items. See OrderItem.

status · OrderStatus

Optional order status for writes. Union: 'Approved' | 'Reproved' | 'Pending'.

value · number · required

Order value.

subItems · OrderSubItem[] · required

Sub-item breakdown. See OrderSubItem.

channelId · string

Optional channel identifier.

group · string

Optional grouping label.

Returns

Promise<unknown> — response shape is not declared in the current SDK contract.

---

delete

delete(id: string): Promise<void>

id · string · required

Transaction (order) identifier.

Returns

Promise<void> — resolves with no value on success.

---

Types

OrderCustomer

May contain personally identifiable information (PII). Handle according to your privacy and retention policies.

id · string · required

Customer identifier.

email · string

Optional email address.

firstName · string · required

Given name.

lastName · string · required

Family name.

documentType · string

Optional document type label (unrestricted string in SDK types).

document · string

Optional document number.

phone · string

Optional phone number.

OrderItem

id · string · required

Item identifier.

name · string · required

Display name.

imageUrl · string · required

Image URL.

price · number · required

Unit or line price (number in SDK types; unit semantics are not specified).

listPrice · number · required

List price (number in SDK types).

quantity · number · required

Quantity.

parentId · string · required

Parent item identifier.

OrderSubItem

key · OrderSubItemKey · required

Sub-item key. See OrderSubItemKey.

value · number · required

Sub-item numeric value. Backend validation: Items and Shipping require value >= 0; Discounts requires value <= 0.

OrderSubItemKey

Value	Backend value constraint
'Items'	value >= 0
'Shipping'	value >= 0
'Discounts'	value <= 0

OrderStatus

Used in CreateOrderBody.status and UpdateOrderBody.status:

'Approved' | 'Reproved' | 'Pending'

OrderQueryStatus

Used in GetOrdersQuery.status and GetOrdersQuery.statuses:

OrderStatus | 'Canceled'

Related

• Client
• Error handling