iotoms Docs

Get returnable lines for a transaction

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

For each line of a sale, returns the quantity sold, already returned and still returnable, plus whether a further return is allowed. Call it before creating a return against an invoice.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

transactionId*string

The sale to check, from List transactions or Get a transaction.

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 sale's lines with returnable quantities.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/transaction/transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08/returnable'
Example Response
{  "status": "string",  "message": "string",  "data": {    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",    "invoiceNumber": "string",    "storeId": 0,    "customerNumber": "string",    "lines": [      {        "itemId": "string",        "description": "string",        "quantitySold": 0,        "quantityReturned": 0,        "quantityReturnable": 0,        "unitPrice": 0,        "discountAmount": 0,        "taxAmount": 0,        "lineSubtotal": 0,        "lineTotal": 0,        "eligible": true,        "disallowReason": "string"      }    ]  }}