Get Transaction By ID

Find the transaction by the given Id

GET /v3/transactions/:transactionId

Request

Path Parameters

Name	Type	Description
transactionId	string	Transaction Id

Headers

Name	Type	Description
Authorization	string	Authorization token

Response

Samples

200 Transaction successfully retrieved.

{
  "data": {
    "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": 1
        "quantityByStatus": {
          ordered: 1,
          shipped: 1
        }
      }
    ]
  }
}

404 Could not find the transaction

{
  "error": {
    "statusCode": 404,
    "code": "TransactionNotFound",
    "message": "The transaction with the provided id was not found",
    "data": {}
  }
}

Schema Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the transaction info

Key	Type	Description
id	String	Transaction id
createAt	String	Transaction creation date
shippingCost	Number	Total Shipping Cost
lease.id	String	Lease Id
lease.status	String	The current lease status, values allowed: signed, pending
items	Array	The list items.
items.quantity	Number	Item quantity.
items.quantityByStatus	Object	Quantity of items grouped by status. Ex { signed: 1 }
items.cost	Number	Item cost with any discounts already applied.
items.description	String	Item description
items.brand	String	Item's brand
items.sku	String	Item unique identifier