TRANXACT.AI Help

Supply Chain · Reachable by link

Rate Bands

One band of a tariff: between 500 and 1,000 kg, class 70, zone 4, this much per kg with a minimum.

Type REST6 operationsBase path /api/scm/freight-rate-breaksPublished as /api/v1/freight-rate-breaks

Download specification (OpenAPI 3.1) Screen: Rate Bands

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 › Rate Bands 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_rate_breaks · 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

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

GET/api/scm/freight-rate-breaksList rate bands

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",
      "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "freight_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "zone": "text",
      "origin_postal_from": "text",
      "origin_postal_to": "text",
      "destination_postal_from": "text",
      "destination_postal_to": "text",
      "break_from": "1250.00",
      "break_to": "1250.00",
      "break_uom": "text",
      "rate": "1250.00",
      "minimum_charge": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "freight_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "zone": "text",
  "origin_postal_from": "text",
  "origin_postal_to": "text",
  "destination_postal_from": "text",
  "destination_postal_to": "text",
  "break_from": "1250.00",
  "break_to": "1250.00",
  "break_uom": "text",
  "rate": "1250.00",
  "minimum_charge": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
tariff_iduuidYesTariff
line_nointegerNoLine
freight_class_iduuidNoFreight class
zonetextNoZone
origin_postal_fromtextNoOrigin postal from
origin_postal_totextNoOrigin postal to
destination_postal_fromtextNoDestination postal from
destination_postal_totextNoDestination postal to
break_fromnumericNoBand from
break_tonumericNoBand to — Leave empty for the open top band.
break_uomtextNoMeasured in — KG, KM, CBM, PLT, EA.
ratenumericNoRate
minimum_chargenumericNoMinimum charge
flat_chargenumericNoFlat charge
transit_daysnumericNoTransit days
is_activebooleanNoActive

Sample body

{
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "freight_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "zone": "text",
  "origin_postal_from": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "freight_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "zone": "text",
  "origin_postal_from": "text",
  "origin_postal_to": "text",
  "destination_postal_from": "text",
  "destination_postal_to": "text",
  "break_from": "1250.00",
  "break_to": "1250.00",
  "break_uom": "text",
  "rate": "1250.00",
  "minimum_charge": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/freight-rate-breaks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tariff_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10,"freight_class_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","zone":"text","origin_postal_from":"text"}'
PUT/api/scm/freight-rate-breaks/{id}Change a rate break

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_iduuidYesTariff
line_nointegerNoLine
freight_class_iduuidNoFreight class
zonetextNoZone
origin_postal_fromtextNoOrigin postal from
origin_postal_totextNoOrigin postal to
destination_postal_fromtextNoDestination postal from
destination_postal_totextNoDestination postal to
break_fromnumericNoBand from
break_tonumericNoBand to — Leave empty for the open top band.
break_uomtextNoMeasured in — KG, KM, CBM, PLT, EA.
ratenumericNoRate
minimum_chargenumericNoMinimum charge
flat_chargenumericNoFlat charge
transit_daysnumericNoTransit days
is_activebooleanNoActive

Sample body

{
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "freight_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "zone": "text",
  "origin_postal_from": "text",
  "origin_postal_to": "text",
  "destination_postal_from": "text",
  "destination_postal_to": "text",
  "break_from": "1250.00",
  "break_to": "1250.00",
  "break_uom": "text",
  "rate": "1250.00",
  "minimum_charge": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/freight-rate-breaks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tariff_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10}'
DELETE/api/scm/freight-rate-breaks/{id}Delete a rate break

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

Data model

Every field of a rate break, 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
tariff_iduuidread, writeTariff
line_nointegerread, writeLine
freight_class_iduuidread, writeFreight class
zonetextread, writeZone
origin_postal_fromtextread, writeOrigin postal from
origin_postal_totextread, writeOrigin postal to
destination_postal_fromtextread, writeDestination postal from
destination_postal_totextread, writeDestination postal to
break_fromnumericread, writeBand from
break_tonumericread, writeBand to — Leave empty for the open top band.
break_uomtextread, writeMeasured in — KG, KM, CBM, PLT, EA.
ratenumericread, writeRate
minimum_chargenumericread, writeMinimum charge
flat_chargenumericread, writeFlat charge
transit_daysnumericread, writeTransit days
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Rate Bands 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.