iotoms Docs

Generate a delivery note PDF

POST
/api/v1/transaction/transactions/{transactionId}/delivery-note

Renders a delivery note (delivery challan) PDF for the transaction and returns its signed download link. A delivery note number is allocated on the first call. Pass templateId to override the active template.

How to use it

  1. Take the transactionId from Create a transaction from a cart or List transactions.
  2. Optionally pass templateId from List report templates to override the active delivery note template.
  3. The first call allocates the delivery note number; later calls re-render the same note. Download it from the signed link in the response.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

transactionId*string

The sale to render the delivery note for, from List transactions.

Formatuuid

Query Parameters

templateId?integer

Optional delivery note report template to render with, from List report templates. Defaults to the active delivery note template.

Formatint64

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?|

Key-value result. For PDF endpoints: pdfUrl (a temporary signed download link), templateId, templateVersion, generatedAt plus document keys such as dayCycleId.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/transaction/transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08/delivery-note'
Example Response
{  "status": "string",  "message": "string",  "data": {    "property1": {},    "property2": {}  }}