Home > @vsf-enterprise/bigcommerce-api > Endpoints > getOrders

# Endpoints.getOrders() method

Returns a list of orders. Optional filter parameters can be passed in.

Signature:

getOrders(context: BigcommerceIntegrationContext, params?: GetOrdersParameters): Promise<OrdersResponse>;

# Parameters

Parameter Type Description
context BigcommerceIntegrationContext An auto-generated value prepended to the method as a first parameter.
params GetOrdersParameters (Optional) An object which contains optional properties for retrieving a list of orders.

Returns:

Promise<OrdersResponse>