# List Sales Orders

This endpoint returns a list of sales orders with optional filtering and sorting.

## API Endpoint

**GET /v-beta/sales_orders**

## Query Parameters

The following query parameters can be used to filter and sort sales orders:

| Parameter | Type | Description |
|  --- | --- | --- |
| `order_source_id` | string (GUID) | Filter by order source ID |
| `external_order_id` | string | ID assigned by Order Source |
| `external_order_number` | string | Number assigned by Order Source |
| `modified_at_start` | date string (ISO 8601) | Filter by modification date (start) |
| `modified_at_end` | date string (ISO 8601) | Filter by modification date (end) |
| `created_at_start` | date string (ISO 8601) | Filter by creation date (start) |
| `created_at_end` | date string (ISO 8601) | Filter by creation date (end) |
| `order_date_start` | date string (ISO 8601) | Filter by order date (start) |
| `order_date_end` | date string (ISO 8601) | Filter by order date (end) |
| `payment_status` | enum | `unknown`, `paid`, `unpaid`, `partially_paid` |
| `fulfillment_status` | enum | `unknown`, `fulfilled`, `unfulfilled`, `partially_fulfilled` |
| `cancelled` | boolean | Filter by cancellation status |
| `page` | integer | Page number (defaults to 1) |
| `page_size` | integer | Results per page (defaults to 25) |
| `sort_dir` | enum | `asc` or `desc` |
| `sort_by` | enum | `modified_at`, `created_at`, `order_date` |


## Example Request


```http
GET /v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=1&page_size=1 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
```

## Response Structure

The response includes:

- Array of `sales_orders` objects containing order details
- `total` - total number of orders
- `page` - current page number
- `pages` - total pages available
- `links` - pagination links (first, last, prev, next)


Each sales order contains information about:

- Order identification and source
- Order status (payment, fulfillment, cancellation)
- Payment details with currency amounts
- Customer information
- Billing and shipping addresses
- Line items with product details