# Get Transactions

<mark style="color:blue;">`GET`</mark> /v3/transactions

## Request

The details below help you form your HTTP requests to this endpoint.

### Headers

You may need to provide specific headers.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>x-consumer-custom-id</td><td>string</td><td>true</td><td>Consumer data with the format "channel:vendorId"</td></tr></tbody></table>

### Query

You may provide query parameters to filter the output.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>page</td><td>number</td><td>false</td><td>Page number to retrieve. Max 1000</td></tr><tr><td>limit</td><td>number</td><td>false</td><td>Limit of transactions to retrieve. Max 1000</td></tr><tr><td>leaseStatus</td><td>string</td><td>false</td><td>Filter by lease status (signed/pending)</td></tr><tr><td>fromDate</td><td>date</td><td>false</td><td>Start date to retrieve</td></tr><tr><td>toDate</td><td>date</td><td>false</td><td>End date to retrieve</td></tr></tbody></table>

## Response

The details below help you understand the responses you could get from this endpoint.

### Samples

Below are samples of responses, with tabs corresponding to returned status code.

{% tabs %}
{% tab title="200" %}

```javascript
{
    "data": {
        "transactions": [
            {
                "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                "orderId": "2f962a52-df63-426f-abc7-617055dba2f7",
                "customer": {
                    "id": "5a319511a86980001d602095",
                    "firstName": "John",
                    "lastName": "Doe",
                    "email": "johndoe@flexshopper.com"
                },
                "shippingCost": 1.23,
                "createdAt": "2018-03-19T15:51:27.080Z",
                "lease": {
                    "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                    "status": "signed"
                },
                "items": [
                    {
                        "description": "iPad Mini",
                        "sku": "abc123",
                        "brand": "Apple",
                        "cost": 100.23,
                        "quantity": 1,
                        "quantityByStatus": {
                            "ordered": 1,
                            "shipped": 1
                        }
                    }
                ],
                "purchaseTotal": 3795,
                "purchaseSalesTax": 808
            }
        ],
        "meta": {
            "count": 1,
            "totalPages": 1,
            "page": 1,
            "limit": 20
        }
    }
}
```

{% endtab %}

{% tab title="400" %}

```javascript
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
```

{% endtab %}
{% endtabs %}

### Schema

The response's schema is outlined below.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].id</td><td>string</td><td>true</td><td>transaction identifier</td></tr><tr><td>data.transactions[].orderId</td><td>string</td><td>false</td><td>The reference to the external order ID</td></tr><tr><td>data.transactions[].customer</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].customer.id</td><td>string</td><td>true</td><td>User id</td></tr><tr><td>data.transactions[].customer.firstName</td><td>string</td><td>false</td><td>First Name</td></tr><tr><td>data.transactions[].customer.lastName</td><td>string</td><td>false</td><td>Last Name</td></tr><tr><td>data.transactions[].customer.email</td><td>string</td><td>false</td><td>Last Name</td></tr><tr><td>data.transactions[].shippingCost</td><td>number</td><td>true</td><td>shipping cost number</td></tr><tr><td>data.transactions[].createdAt</td><td>string</td><td>true</td><td>transaction creation date</td></tr><tr><td>data.transactions[].lease</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].lease.id</td><td>string</td><td>true</td><td>order identifier</td></tr><tr><td>data.transactions[].lease.status</td><td>string</td><td>true</td><td>Signing status of the transaction</td></tr><tr><td>data.transactions[].items</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].items[].description</td><td>string</td><td>true</td><td>item description</td></tr><tr><td>data.transactions[].items[].sku</td><td>string</td><td>true</td><td>item sku number</td></tr><tr><td>data.transactions[].items[].brand</td><td>string</td><td>true</td><td>item brand</td></tr><tr><td>data.transactions[].items[].cost</td><td>number</td><td>true</td><td>item cost</td></tr><tr><td>data.transactions[].items[].quantity</td><td>number</td><td>true</td><td>item quantity</td></tr><tr><td>data.transactions[].items[].quantityByStatus</td><td>object</td><td>false</td><td>Items quantity grouped by status</td></tr><tr><td>data.transactions[].purchaseTotal</td><td>number</td><td>false</td><td>total purchase cost in cents</td></tr><tr><td>data.transactions[].purchaseSalesTax</td><td>number</td><td>false</td><td>total sale tax in cents</td></tr><tr><td>data.meta</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.count</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.totalPages</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.page</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.limit</td><td>number</td><td>false</td><td>N/A</td></tr></tbody></table>