iotoms Docs

Get a transaction

GET
/api/v1/transaction/transactions/{transactionId}

Returns one sale by its ID with everything recorded on it: header totals, line items with returned and still-returnable quantities, the payment split when the sale is linked to a recorded payment, and a summary of returns taken against it.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

transactionId*string

Transaction identifier, from List transactions or Create a transaction from a cart.

Formatuuid

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The transaction.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/transaction/transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "status": "string",  "message": "string",  "data": {    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",    "cartId": "string",    "clientTransactionId": "string",    "channel": "LINE_DISTRIBUTION",    "contextType": "STORE_VISIT",    "businessDate": "2019-08-24",    "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",    "storeId": 0,    "storeName": "string",    "registerId": 0,    "customerNumber": "string",    "invoiceNumber": "string",    "subtotal": 0,    "taxTotal": 0,    "discountTotal": 0,    "grandTotal": 0,    "paymentStatus": "Paid",    "cashCollected": 0,    "creditIssued": 0,    "paymentMode": "string",    "syncStatus": "string",    "soldBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "lines": [      {        "itemId": "string",        "description": "string",        "quantitySold": 0,        "unitPrice": 0,        "discountAmount": 0,        "taxAmount": 0,        "lineSubtotal": 0,        "lineTotal": 0,        "quantityReturned": 0,        "quantityReturnable": 0      }    ],    "payments": [      {        "mode": "CASH",        "amount": 0      }    ],    "returnSummary": {      "totalReturnedAmount": 0,      "returnCount": 0,      "status": "string"    }  }}