> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Orders
> The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact
The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.
```http theme={null}
GET https://services.leadconnectorhq.com/payments/orders
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
LocationId is the id of the account.
AltId is the unique identifier e.g: account id.
Order status.
Payment Status of the Order
Mode of payment.
Starting interval of orders.
Closing interval of orders.
The name of the order for searching.
Contact id for filtering of orders.
Funnel product ids separated by comma.
Source id
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
## Respuestas
An array of orders
The unique identifier for the order.
AltId is the unique identifier eg: account id.
AltType is the type of identifier.
Contact id corresponding to the order.
Contact name corresponding to the order.
Contact email corresponding to the order.
Currency in which order was created.
Order value.
Order sub-total value.
Discount value on order.
The status of the order (e.g., completed).
Order is in live / test mode.
Total products in an order.
Source type of order (eg: funnel).
Source name for the order.
Source id for the order.
Meta content for the source of order.
Coupon code for the order.
The creation timestamp of the order.
The last update timestamp of the order.
Source sub-type for the order.
Fulfillment status of the order.
Total one time products in an order.
Total recurring time products in an order.
User ID who created the order.
total orders count
```json theme={null}
{
"data": [
{
"_id": "653f5e0cde5a1314e62a837c",
"altId": "3SwdhCu3svxI8AKsPJt6",
"altType": "account",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactName": "James Bond",
"contactEmail": "james.bond@leadwaycrm.com",
"currency": "USD",
"amount": "100",
"subtotal": "100",
"discount": "10",
"status": "completed",
"liveMode": "false",
"totalProducts": "5",
"sourceType": "funnel",
"sourceName": "onestep",
"sourceId": "kDj7BHej9Zyyq3QakJmz",
"sourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId: \"rBVhyYhMsbxbO8ZqOcei\", pageUrl: \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId: \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
"couponCode": "100PER",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"sourceSubType": "one_step_order_form",
"fulfillmentStatus": "unfulfilled",
"onetimeProducts": "1",
"recurringProducts": "1",
"createdBy": "user123"
}
],
"totalCount": 0
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/payments/orders' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/payments/orders', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/payments/orders',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```