Supply Chain · Strategic Sourcing
e-Auctions
A reverse auction only moves one way, and only by the declared decrement — the rule lives in the database, so no bid gets in by another door.
/api/scm/auctionsPublished as /api/v1/auctionsOverview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › e-Auctions on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | scm.auctions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/auctionsList e-auctions
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auction_no": "AUC-000001",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"auction_type": "reverse",
"currency": "USD",
"starting_price": "1250.00",
"reserve_price": "1250.00",
"min_decrement": "1250.00",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"extension_minutes": 10,
"bid_count": 10,
"best_bid": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/auctions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/auctions/{id}Read one auctions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auction_no": "AUC-000001",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"auction_type": "reverse",
"currency": "USD",
"starting_price": "1250.00",
"reserve_price": "1250.00",
"min_decrement": "1250.00",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"extension_minutes": 10,
"bid_count": 10,
"best_bid": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/auctionsCreate a auctions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
rfx_id | uuid | No | From sourcing event |
title | text | Yes | Title |
auction_type | text | No | Type Allowed: reverse forward dutch japanese |
currency | text | No | Currency |
starting_price | numeric | Yes | Starting price |
reserve_price | numeric | No | Reserve price |
min_decrement | numeric | No | Minimum improvement — A bid that does not beat the standing best by this much is not a bid. |
starts_at | timestamp with time zone | No | Starts |
ends_at | timestamp with time zone | No | Ends |
extension_minutes | integer | No | Extension (minutes) — A bid in the closing minutes extends the clock. |
Sample body
{
"title": "Example",
"starting_price": "1250.00",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auction_type": "reverse",
"currency": "USD",
"reserve_price": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auction_no": "AUC-000001",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"auction_type": "reverse",
"currency": "USD",
"starting_price": "1250.00",
"reserve_price": "1250.00",
"min_decrement": "1250.00",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"extension_minutes": 10,
"bid_count": 10,
"best_bid": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","starting_price":"1250.00","rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","auction_type":"reverse","currency":"USD","reserve_price":"1250.00"}'PUT/api/scm/auctions/{id}Change a auctions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
rfx_id | uuid | No | From sourcing event |
title | text | Yes | Title |
auction_type | text | No | Type Allowed: reverse forward dutch japanese |
currency | text | No | Currency |
starting_price | numeric | Yes | Starting price |
reserve_price | numeric | No | Reserve price |
min_decrement | numeric | No | Minimum improvement — A bid that does not beat the standing best by this much is not a bid. |
starts_at | timestamp with time zone | No | Starts |
ends_at | timestamp with time zone | No | Ends |
extension_minutes | integer | No | Extension (minutes) — A bid in the closing minutes extends the clock. |
Sample body
{
"title": "Example",
"starting_price": "1250.00"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auction_no": "AUC-000001",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"auction_type": "reverse",
"currency": "USD",
"starting_price": "1250.00",
"reserve_price": "1250.00",
"min_decrement": "1250.00",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"extension_minutes": 10,
"bid_count": 10,
"best_bid": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","starting_price":"1250.00"}'DELETE/api/scm/auctions/{id}Delete a auctions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/auctions/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/scm/auctions/{id}/openOpen
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/open" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/auctions/{id}/bidBid
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
supplierId*, amountResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bid" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"supplierId":"value","amount":"value"}'POST/api/scm/auctions/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/auctions/{id}/awardAward
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/award" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/auctions/{parentId}/bidsBids
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bids" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/auctions/{parentId}/bidsBids
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bids" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/auctions/{parentId}/bids/{lineId}Bids
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bids/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/auctions/{parentId}/bids/{lineId}Bids
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/auctions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bids/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a auctions, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
auction_no | text | read only | Auction no |
rfx_id | uuid | read, write | From sourcing event |
title | text | read, write | Title |
auction_type | text | read, write | Type Allowed: reverse forward dutch japanese |
currency | text | read, write | Currency |
starting_price | numeric | read, write | Starting price |
reserve_price | numeric | read, write | Reserve price |
min_decrement | numeric | read, write | Minimum improvement — A bid that does not beat the standing best by this much is not a bid. |
starts_at | timestamp with time zone | read, write | Starts |
ends_at | timestamp with time zone | read, write | Ends |
extension_minutes | integer | read, write | Extension (minutes) — A bid in the closing minutes extends the clock. |
bid_count | integer | read only | Bid count |
best_bid | numeric | read only | Best bid |
best_supplier_id | uuid | read only | Best supplier id |
status | text | read only | Status |
awarded_at | timestamp with time zone | read only | Awarded at |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
awarded_bid_id | uuid | read only | Awarded bid id |
awarded_supplier_id | uuid | read only | Awarded supplier id |
awarded_amount | numeric | read only | Awarded amount |
awarded_by | uuid | read only | Awarded by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › e-Auctions for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.