Get Transactions

Get transactions for a merchant.

GET /v3/transactions

Request

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

Headers

You may need to provide specific headers.

Name	Type	Required	Description
x-consumer-custom-id	string		Consumer data with the format "channel:vendorId"

Query

You may provide query parameters to filter the output.

Name	Type	Required	Description
page	number		Page number to retrieve. Max 1000
limit	number		Limit of transactions to retrieve. Max 1000
leaseStatus	string		Filter by lease status (signed/pending)
fromDate	date		Start date to retrieve
toDate	date		End date to retrieve

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.

200

{
    "data": {
        "transactions": [
            {
                "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                "orderId": "2f962a52-df63-426f-abc7-617055dba2f7",
                "customer": {
                    "id": "5a319511a86980001d602095",
                    "firstName": "John",
                    "lastName": "Doe",
                    "email": "[email protected]"
                },
                "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
        }
    }
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [email protected]",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

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