TRANXACT.AI Help

Supply Chain · Freight Management

Freight Tariffs

A price agreement with a carrier. The rate basis is what lets one engine price parcel, LTL and truckload: three different arithmetics, one lane comparison.

Type REST10 operationsBase path /api/scm/freight-tariffsPublished as /api/v1/freight-tariffs

Download specification (OpenAPI 3.1) Screen: Freight Tariffs

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 › Freight Tariffs 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.freight_tariffs · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/scm/freight-tariffsList freight tariffs

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": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tariff_no": "TAR-000001",
      "name": "Example",
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "rate_basis": "text",
      "currency": "USD",
      "minimum_charge": "1250.00",
      "discount_pct": "12.0000",
      "fuel_surcharge_pct": "1250.00",
      "fuel_index_source": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/freight-tariffs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/freight-tariffs/{id}Read one freight tariff

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_no": "TAR-000001",
  "name": "Example",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_basis": "text",
  "currency": "USD",
  "minimum_charge": "1250.00",
  "discount_pct": "12.0000",
  "fuel_surcharge_pct": "1250.00",
  "fuel_index_source": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-tariffsCreate a freight tariff

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
tariff_notextYesTariff number
nametextYesName
carrier_iduuidYesCarrier
carrier_service_iduuidNoService
transport_lane_iduuidNoLane
contract_iduuidNoContract
rate_basistextNoPriced by
currencytextNoCurrency
minimum_chargenumericNoMinimum charge
discount_pctnumericNoDiscount off the base tariff % — LTL is quoted as a discount rather than a net rate, so a general rate increase can be applied without rewriting every line.
fuel_surcharge_pctnumericNoFuel surcharge %
fuel_index_sourcetextNoFuel index source
dim_factornumericNoDimensional divisor — 5000 for cm3/kg. Where volume is worth more than weight the carrier charges on volume, and this divisor is the whole rule.
dim_uomtextNoDimensional units
valid_fromdateNoIn force from
valid_todateNoUntil
is_defaultbooleanNoDefault for this carrier
statustextNoStatus
Allowed: draft active expired superseded cancelled
notestextNoNotes

Sample body

{
  "tariff_no": "TAR-000001",
  "name": "Example",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_basis": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_no": "TAR-000001",
  "name": "Example",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_basis": "text",
  "currency": "USD",
  "minimum_charge": "1250.00",
  "discount_pct": "12.0000",
  "fuel_surcharge_pct": "1250.00",
  "fuel_index_source": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/freight-tariffs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tariff_no":"TAR-000001","name":"Example","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_service_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","transport_lane_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","contract_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","rate_basis":"text"}'
PUT/api/scm/freight-tariffs/{id}Change a freight tariff

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
tariff_notextYesTariff number
nametextYesName
carrier_iduuidYesCarrier
carrier_service_iduuidNoService
transport_lane_iduuidNoLane
contract_iduuidNoContract
rate_basistextNoPriced by
currencytextNoCurrency
minimum_chargenumericNoMinimum charge
discount_pctnumericNoDiscount off the base tariff % — LTL is quoted as a discount rather than a net rate, so a general rate increase can be applied without rewriting every line.
fuel_surcharge_pctnumericNoFuel surcharge %
fuel_index_sourcetextNoFuel index source
dim_factornumericNoDimensional divisor — 5000 for cm3/kg. Where volume is worth more than weight the carrier charges on volume, and this divisor is the whole rule.
dim_uomtextNoDimensional units
valid_fromdateNoIn force from
valid_todateNoUntil
is_defaultbooleanNoDefault for this carrier
statustextNoStatus
Allowed: draft active expired superseded cancelled
notestextNoNotes

Sample body

{
  "tariff_no": "TAR-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_no": "TAR-000001",
  "name": "Example",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_basis": "text",
  "currency": "USD",
  "minimum_charge": "1250.00",
  "discount_pct": "12.0000",
  "fuel_surcharge_pct": "1250.00",
  "fuel_index_source": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tariff_no":"TAR-000001","name":"Example"}'
DELETE/api/scm/freight-tariffs/{id}Delete a freight tariff

Path parameters

NameTypeDescription
idstring (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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-tariffs/{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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/freight-tariffs/{parentId}/breaksBreaks

Path parameters

NameTypeDescription
parentIdstring (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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/breaks" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-tariffs/{parentId}/breaksBreaks

Path parameters

NameTypeDescription
parentIdstring (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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/breaks" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/freight-tariffs/{parentId}/breaks/{lineId}Breaks

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/breaks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/freight-tariffs/{parentId}/breaks/{lineId}Breaks

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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/freight-tariffs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/breaks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
tariff_notextread, writeTariff number
nametextread, writeName
carrier_iduuidread, writeCarrier
carrier_service_iduuidread, writeService
transport_lane_iduuidread, writeLane
contract_iduuidread, writeContract
rate_basistextread, writePriced by
currencytextread, writeCurrency
minimum_chargenumericread, writeMinimum charge
discount_pctnumericread, writeDiscount off the base tariff % — LTL is quoted as a discount rather than a net rate, so a general rate increase can be applied without rewriting every line.
fuel_surcharge_pctnumericread, writeFuel surcharge %
fuel_index_sourcetextread, writeFuel index source
dim_factornumericread, writeDimensional divisor — 5000 for cm3/kg. Where volume is worth more than weight the carrier charges on volume, and this divisor is the whole rule.
dim_uomtextread, writeDimensional units
valid_fromdateread, writeIn force from
valid_todateread, writeUntil
is_defaultbooleanread, writeDefault for this carrier
statustextread, writeStatus
Allowed: draft active expired superseded cancelled
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Freight Tariffs 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.