Class Orders

Orders resource handler

Index

Constructors

Methods

cancel count create delete get list markAsFulfilled markAsPaid update

Constructors

constructor

new Orders(client): Orders
Parameters
- client: SapoClient
Returns Orders
- Defined in resources/orders.ts:10

Methods

cancel

cancel(id): Promise<Order>
Cancel an order
Parameters
- id: number
  Order ID
Returns Promise<Order>
Cancelled order
- Defined in resources/orders.ts:79

count

count(params?): Promise<number>
Get total order count
Parameters
- Optional params: Partial<OrderListParams>
  Filter parameters
Returns Promise<number>
Total number of orders matching filters
- Defined in resources/orders.ts:69

create

create(data): Promise<Order>
Create a new order
Parameters
- data: CreateOrderData
  Order creation data
Returns Promise<Order>
Created order
- Defined in resources/orders.ts:36

delete

delete(id): Promise<void>
Delete an order
Parameters
- id: number
  Order ID
Returns Promise<void>
- Defined in resources/orders.ts:60

get

get(id): Promise<Order>
Get a single order by ID
Parameters
- id: number
  Order ID
Returns Promise<Order>
Order details
- Defined in resources/orders.ts:26

list

list(params?): Promise<PaginatedResponse<Order>>
Get a list of orders
Parameters
- Optional params: OrderListParams
  Query parameters for filtering and pagination
Returns Promise<PaginatedResponse<Order>>
Paginated list of orders
- Defined in resources/orders.ts:17

markAsFulfilled

markAsFulfilled(id): Promise<Order>
Mark an order as fulfilled
Parameters
- id: number
  Order ID
Returns Promise<Order>
Updated order
- Defined in resources/orders.ts:99

markAsPaid

markAsPaid(id): Promise<Order>
Mark an order as paid
Parameters
- id: number
  Order ID
Returns Promise<Order>
Updated order
- Defined in resources/orders.ts:89

update

update(id, data): Promise<Order>
Update an existing order
Parameters
- id: number
  Order ID
- data: Partial<CreateOrderData>
  Order update data
Returns Promise<Order>
Updated order
- Defined in resources/orders.ts:49