Skip to content

Class: OrderAPI ​

Order API client for retrieving order information. Provides methods to access order data and associated customer information.

Constructors ​

Constructor ​

ts
new OrderAPI(http: HttpClient, apiKey: string): OrderAPI;

Parameters ​

http ​

HttpClient

apiKey ​

string

Returns ​

OrderAPI

Methods ​

getCustomerOrders() ​

ts
getCustomerOrders(
   customerId: string, 
   page?: number, 
limit?: number): Promise<CustomerOrdersResponse>;

Retrieves customer orders with pagination.

Parameters ​

customerId ​

string

The customer ID to fetch orders for

page? ​

number = 1

Page number (default: 1)

limit? ​

number = 10

Number of orders per page (default: 10)

Returns ​

Promise<CustomerOrdersResponse>

Promise resolving to customer orders response with metadata

Throws ​

When the API returns an error

Throws ​

When a network error occurs

Example ​

typescript
const response = await sdk.orderAPI().getCustomerOrders('customer-123', 1, 10);
console.log('Orders:', response.orders);
console.log('Total pages:', response.metadata.total_pages);