iotoms Docs

List vendors

GET
/api/v1/procurement/vendors

Returns vendors sorted by name, paginated with 0-based page and size (1 to 100, default 20). Use query for text search and activeOnly to hide inactive vendors.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

activeOnly?boolean

true to hide deactivated vendors. Defaults to false (all vendors).

Defaultfalse
query?string

Case-insensitive text search across vendor name, vendor code and contact name.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

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?

One page of vendors plus paging totals.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/procurement/vendors' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "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"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}