iotoms Docs

List requests for quote

GET
/api/v1/procurement/rfqs

Returns requests for quote, newest first, with their lines and invited vendors. Filter by status, or by a from/to range on the reply-by date (both needed; ignored when status is sent). vendorId limits the list to requests that vendor was invited to. Not paginated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

Only return requests in this status: DRAFT, SENT, QUOTED, AWARDED, CLOSED or CANCELLED.

Value in"DRAFT""SENT""QUOTED""AWARDED""CLOSED""CANCELLED"
vendorId?string

Only return requests this vendor was invited to quote on. Vendor ID from List vendors.

Formatuuid
from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate

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 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?array<>|

Requests for quote matching the filters, newest first, each with its lines and invited vendors. Not paginated.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/procurement/rfqs' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "rfqNumber": "string",      "status": "string",      "requisitionId": "a9bbc60e-08a6-4a17-9a18-6ef431a5aaaa",      "deliveryLocationId": "88e6bf49-abb5-45e8-9ea4-a579b32ec7db",      "deliveryLocationName": "string",      "responseDueDate": "2019-08-24",      "neededBy": "2019-08-24",      "notes": "string",      "awardReason": "string",      "awardedBy": "string",      "awardedAt": "2019-08-24T14:15:22Z",      "items": [        {          "id": 0,          "itemId": "string",          "itemName": "string",          "requiredQty": 0,          "unitOfMeasure": "string",          "uomId": "4df47f00-a69d-4ff2-b50d-4a7649a4b70c",          "notes": "string"        }      ],      "vendors": [        {          "id": 0,          "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",          "vendorName": "string",          "status": "string",          "invitedAt": "2019-08-24T14:15:22Z",          "quotationId": "98c8afab-b1d9-462f-9483-5a2dbf34985f",          "quotationTotal": 0        }      ],      "invitedCount": 0,      "quotedCount": 0,      "createdBy": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}