iotoms Docs

Get a vendor

GET
/api/v1/procurement/vendors/{id}

Returns one vendor by its ID, including contact details, payment terms and whether it is active.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?

The vendor record.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/procurement/vendors/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "vendorCode": "string",    "vendorName": "string",    "contactName": "string",    "contactEmail": "string",    "contactPhone": "string",    "address": "string",    "paymentTermsDays": 0,    "isActive": true,    "notes": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}