Get Transactions

Returns all vendor's transactions

/v3/transactions

GET https://apis.sandbox.flexshopper.com/v3/transactions

Query Parameters

NameTypeDescription

leaseStatus

string

Filter by lease status (signed/pending)

page

string

Page number to retrieve. Max 1000

limit

string

Limit of transactions to retrieve, defaults to 20. Max 1000,

fromDate

string

Start date to retrieve

toDate

string

End date to retrieve

Headers

NameTypeDescription

Authorization

string

Authorization token

{
  "data": {
    "transactions": [
      {
        "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
        "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": { 
              ordered: 1, 
              shipped: 1 
            }
          }
        ]
      }
    ],
    {
      "meta": {
      "count": 1,
      "totalPages": 1,
      "page": 1,
      "limit": 20
    }
  }
}

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all transactions created.

Key

Type

Description

transactions

Array

The list transactions.

transactions.id

Number

Transaction id

transactions.createAt

Date

Transaction creation date

transactions.shippingCost

Number

Total Shipping Cost

transactions.items

Array

The list items.

transactions.items.quantity

Number

Item quantity.

transactions.items.quantityByStatus

Object

Quantity of items grouped by status. Ex. { signed: 1}

transactions.items.cost

Number

Item cost

transactions.items.description

String

Item description

transactions.items.brand

String

Item's brand

meta

Object

Result metadata

meta.count

Number

Amount of transactions

meta.totalPages

Number

Total number of pages

meta.page

Number

Current page

meta.limit

Number

Page size

Last updated