iotoms Docs

Get credit note PDF for a return

GET
/api/v1/transaction/returns/{returnId}/pdf

Returns a download link (pdfUrl) and the credit note number for the return's credit note PDF. The stored PDF is reused while the merchant's active credit note template is unchanged; otherwise a new one is generated first.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

returnId*string

ID of the return, from Create an order return or List order returns.

Formatuuid

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 GET 'https://beta.iotoms.com/api/v1/transaction/returns/497f6eca-6276-4993-bfeb-53cbbbba6f08/pdf'
Example Response
{  "status": "string",  "message": "string",  "data": {    "property1": {},    "property2": {}  }}