TRANXACT.AI Help

Supply Chain · Freight Management

Carrier Scorecard

Computed rather than typed: what each carrier moved, what it cost, how much of it arrived on time, and how often their invoice was wrong.

Type REST6 operationsBase path /api/scm/carrier-scorecardPublished as /api/v1/carrier-scorecard

Download specification (OpenAPI 3.1) Screen: Carrier Scorecard

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Carrier Scorecard 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.
Tablescm.carrier_scorecard · kept per company (and organisational unit where it has one)
RecordRead only; key carrier_id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/carrier-scorecardList carrier scorecard

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_no": "CAR-000001",
      "name": "Example",
      "carrier_type": "text",
      "scac": "text",
      "status": "draft",
      "currency": "USD",
      "insurance_expires_on": "2026-10-30",
      "shipments": 10,
      "delivered": 10,
      "on_time_count": 10,
      "on_time_pct": "1250.00",
      "spend": "1250.00",
      "weight_kg": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/carrier-scorecard?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/carrier-scorecard/{carrier_id}Read one carrier

Path parameters

NameTypeDescription
carrier_idstring (uuid)The record's carrier_id, as a list returns it.

Response 200

{
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_no": "CAR-000001",
  "name": "Example",
  "carrier_type": "text",
  "scac": "text",
  "status": "draft",
  "currency": "USD",
  "insurance_expires_on": "2026-10-30",
  "shipments": 10,
  "delivered": 10,
  "on_time_count": 10,
  "on_time_pct": "1250.00",
  "spend": "1250.00",
  "weight_kg": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/carrier-scorecard/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/carrier-scorecardPost carrier scorecard

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/carrier-scorecard" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/carrier-scorecard/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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/carrier-scorecard/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/scm/carrier-scorecard/{id}Put carrier scorecard

Path parameters

NameTypeDescription
idstring (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 PUT "https://demo.tranxact.ai/api/scm/carrier-scorecard/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/carrier-scorecard/{id}Delete carrier scorecard

Path parameters

NameTypeDescription
idstring (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 DELETE "https://demo.tranxact.ai/api/scm/carrier-scorecard/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a carrier, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
carrier_iduuidread onlyCarrier id
org_iduuidread onlyOrg id
carrier_notextread onlyCarrier no
nametextread onlyName
carrier_typetextread onlyCarrier type
scactextread onlyScac
statustextread onlyStatus
currencytextread onlyCurrency
insurance_expires_ondateread onlyInsurance expires on
shipmentsintegerread onlyShipments
deliveredintegerread onlyDelivered
on_time_countintegerread onlyOn time count
on_time_pctnumericread onlyOn time pct
spendnumericread onlySpend
weight_kgnumericread onlyWeight kg
cost_per_kgnumericread onlyCost per kg
invoicesintegerread onlyInvoices
disputed_invoicesintegerread onlyDisputed invoices
invoice_variancenumericread onlyInvoice variance
invoice_accuracy_pctnumericread onlyInvoice accuracy pct
exception_eventsintegerread onlyException events

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Carrier Scorecard for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.