Orders

Module role in sales flow

orders is for post-checkout access in authenticated sessions.

Use this module for order history and order detail pages after checkout.
For guest checkout completion, immediate order data comes from payments.initialize() when action === 'showOrder'.
After user login, use orders.list/orders.get for long-term order retrieval.

Methods

List

Use: orders.list(filters?, options?).

Field	Type	Required	Description
`filters.pageNumber`	`number`	Optional	Page number (default `1`).
`filters.pageSize`	`number`	Optional	Page size.
`filters.filters`	`Array<{ name: string; value: any }>`	Optional	Backend filters payload (for example `self_only`).
`options`	`RequestOptions`	Optional	Per-request controls.

Returns: SazitoResponse<OrdersListResponse>.

const ordersRes = await client.orders.list({
  pageNumber: 1,
  pageSize: 20,
  filters: [{ name: 'self_only', value: true }],
});

Get

Use: orders.get(orderId, options?).

Parameter	Type	Required	Description
`orderId`	`number`	Required	Order ID.
`options`	`RequestOptions`	Optional	Per-request controls.

Returns: SazitoResponse<Order>.

const ordersRes = await client.orders.list({ pageNumber: 1, pageSize: 1 });
const firstOrderId = ordersRes.data?.orders?.[0]?.id;

if (firstOrderId) {
  const orderRes = await client.orders.get(firstOrderId);
}

`Order` key fields

Field	Type	Required	Description
`id`	`number`	Required	Order ID.
`orderNumber`	`string`	Required	Human-readable order number.
`orderIdentifier`	`string`	Required	Stable order identifier token.
`invoice.invoiceItems`	`InvoiceItem[]`	Required	Purchased items.
`invoice.shippingItems`	`any[]`	Required	Shipping assignments on order invoice.

Known errors

Type	When it happens
`api`	Missing/invalid authentication token or inaccessible order.

Examples

// app/lib/sazito-client.ts
import { createSazitoClient } from '@sazito/client-sdk';

export const sazito = createSazitoClient({
  domain: process.env.NEXT_PUBLIC_SAZITO_DOMAIN!,
});

// app/[lang]/(home)/page.tsx
'use client';
import { useEffect, useState } from 'react';
import { sazito } from '@/app/lib/sazito-client';

export default function Example() {
  const [data, setData] = useState<any>(null);

  useEffect(() => {
    sazito.orders.list({ pageNumber: 1, pageSize: 20 }).then((res) => setData(res.data ?? null));
  }, []);

  return <pre>{JSON.stringify(data, null, 2)}</pre>;
}

Type Details

The following tables are generated from SDK TypeScript types and include nested object fields.

OrderFilters

Source: src/types/order.ts

Field	Type	Required
`pageNumber`	`number`	Optional
`pageSize`	`number`	Optional
`filters`	`Array<{ name: string; value: any }>`	Optional
`filters.[].name`	`string`	Required
`filters.[].value`	`any`	Required

Order

Source: src/types/order.ts

Field	Type	Required
`id`	`number`	Required
`orderNumber`	`string`	Required
`orderIdentifier`	`string`	Required
`invoice`	`{ shippingItems: any[]; invoiceItems: InvoiceItem[]; }`	Required
`invoice.shippingItems`	`any[]`	Required
`invoice.invoiceItems`	`InvoiceItem[]`	Required

InvoiceItem

Source: src/types/invoice.ts

Field	Type	Required
`id`	`number \| string`	Required
`productVariantId`	`number`	Required
`name`	`string`	Required
`quantity`	`number`	Required
`unitPrice`	`number`	Required
`lineTotal`	`number`	Required
`rawPrice`	`number`	Required
`customerProfit`	`number`	Required
`image`	`Image`	Required
`product`	`CheckoutProductSnapshot`	Required
`commercialFiles`	`any`	Optional
`formAttributes`	`Record<string, FormAttributeValue> \| InvoiceItemFormAttributes`	Optional
`bookingAttributes`	`SchedulerBookingAttributes`	Optional
`formFields`	`Record<string, any>`	Optional

ShippingAddress

Source: src/types/invoice.ts

Field	Type	Required
`id`	`number`	Required
`identifier`	`string`	Required
`firstName`	`string`	Required
`lastName`	`string`	Required
`mobilePhone`	`string`	Optional
`phoneNumber`	`string`	Optional
`email`	`string`	Optional
`region`	`Region`	Optional
`city`	`City`	Required
`address`	`string`	Required
`postalCode`	`string`	Optional
`latitude`	`number`	Optional
`longitude`	`number`	Optional
`userSetCoordinatesBefore`	`boolean`	Optional
`createdAt`	`string`	Optional
`updatedAt`	`string`	Optional

PaymentMethod

Source: src/types/payment.ts

Field	Type	Required
`id`	`number`	Required
`code`	`PaymentGateway`	Required
`isDefault`	`boolean`	Required

Orders

On this page