TRANXACT.AI Help

Supply Chain · Freight Forwarding

Containers

The box itself. A container without a verified gross mass does not get loaded, which is why that is a column rather than a note.

Type REST6 operationsBase path /api/scm/containersPublished as /api/v1/containers

Download specification (OpenAPI 3.1) Screen: Containers

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 › Containers 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.containers · 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/containersList containers

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",
      "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "container_no": "CON-000001",
      "iso_type": "text",
      "size_ft": 10,
      "container_type": "text",
      "seal_no": "SEA-000001",
      "seal_type": "text",
      "tare_weight_kg": "1250.00",
      "cargo_weight_kg": "1250.00",
      "vgm_kg": "1250.00",
      "vgm_method": "method_1",
      "vgm_certified_by": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_no": "CON-000001",
  "iso_type": "text",
  "size_ft": 10,
  "container_type": "text",
  "seal_no": "SEA-000001",
  "seal_type": "text",
  "tare_weight_kg": "1250.00",
  "cargo_weight_kg": "1250.00",
  "vgm_kg": "1250.00",
  "vgm_method": "method_1",
  "vgm_certified_by": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
forwarding_shipment_iduuidNoShipment
load_iduuidNoLoad
container_notextYesContainer number
iso_typetextNoISO type
size_ftintegerNoSize (ft)
container_typetextNoType
seal_notextNoSeal number
seal_typetextNoSeal type
tare_weight_kgnumericNoTare weight (kg)
cargo_weight_kgnumericNoCargo weight (kg)
vgm_kgnumericNoVerified gross mass (kg) — SOLAS requires it before loading. Without it the box stays on the quay.
vgm_methodtextNoVGM method
Allowed: method_1 method_2
vgm_certified_bytextNoCertified by
vgm_certified_attimestamp with time zoneNoCertified at
volume_cbmnumericNoVolume (m3)
package_countintegerNoPackages
temperature_cnumericNoTemperature (C)
humidity_pctnumericNoHumidity %
vent_settingtextNoVent setting
stuffed_attimestamp with time zoneNoStuffed
gate_in_attimestamp with time zoneNoGated in
loaded_attimestamp with time zoneNoLoaded
discharged_attimestamp with time zoneNoDischarged
gate_out_attimestamp with time zoneNoGated out
emptied_attimestamp with time zoneNoEmptied
demurrage_free_untildateNoDemurrage free until
detention_free_untildateNoDetention free until
statustextNoStatus
Allowed: planned allocated stuffing stuffed gated_in loaded on_water discharged gated_out delivered emptied returned
notestextNoNotes

Sample body

{
  "container_no": "CON-000001",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "iso_type": "text",
  "size_ft": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_no": "CON-000001",
  "iso_type": "text",
  "size_ft": 10,
  "container_type": "text",
  "seal_no": "SEA-000001",
  "seal_type": "text",
  "tare_weight_kg": "1250.00",
  "cargo_weight_kg": "1250.00",
  "vgm_kg": "1250.00",
  "vgm_method": "method_1",
  "vgm_certified_by": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/containers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"container_no":"CON-000001","forwarding_shipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","iso_type":"text","size_ft":10}'
PUT/api/scm/containers/{id}Change a containers

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
forwarding_shipment_iduuidNoShipment
load_iduuidNoLoad
container_notextYesContainer number
iso_typetextNoISO type
size_ftintegerNoSize (ft)
container_typetextNoType
seal_notextNoSeal number
seal_typetextNoSeal type
tare_weight_kgnumericNoTare weight (kg)
cargo_weight_kgnumericNoCargo weight (kg)
vgm_kgnumericNoVerified gross mass (kg) — SOLAS requires it before loading. Without it the box stays on the quay.
vgm_methodtextNoVGM method
Allowed: method_1 method_2
vgm_certified_bytextNoCertified by
vgm_certified_attimestamp with time zoneNoCertified at
volume_cbmnumericNoVolume (m3)
package_countintegerNoPackages
temperature_cnumericNoTemperature (C)
humidity_pctnumericNoHumidity %
vent_settingtextNoVent setting
stuffed_attimestamp with time zoneNoStuffed
gate_in_attimestamp with time zoneNoGated in
loaded_attimestamp with time zoneNoLoaded
discharged_attimestamp with time zoneNoDischarged
gate_out_attimestamp with time zoneNoGated out
emptied_attimestamp with time zoneNoEmptied
demurrage_free_untildateNoDemurrage free until
detention_free_untildateNoDetention free until
statustextNoStatus
Allowed: planned allocated stuffing stuffed gated_in loaded on_water discharged gated_out delivered emptied returned
notestextNoNotes

Sample body

{
  "container_no": "CON-000001",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_no": "CON-000001",
  "iso_type": "text",
  "size_ft": 10,
  "container_type": "text",
  "seal_no": "SEA-000001",
  "seal_type": "text",
  "tare_weight_kg": "1250.00",
  "cargo_weight_kg": "1250.00",
  "vgm_kg": "1250.00",
  "vgm_method": "method_1",
  "vgm_certified_by": "text"
}

Sample request

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

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/containers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/containers/{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/containers/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 containers, 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
forwarding_shipment_iduuidread, writeShipment
load_iduuidread, writeLoad
container_notextread, writeContainer number
iso_typetextread, writeISO type
size_ftintegerread, writeSize (ft)
container_typetextread, writeType
seal_notextread, writeSeal number
seal_typetextread, writeSeal type
tare_weight_kgnumericread, writeTare weight (kg)
cargo_weight_kgnumericread, writeCargo weight (kg)
vgm_kgnumericread, writeVerified gross mass (kg) — SOLAS requires it before loading. Without it the box stays on the quay.
vgm_methodtextread, writeVGM method
Allowed: method_1 method_2
vgm_certified_bytextread, writeCertified by
vgm_certified_attimestamp with time zoneread, writeCertified at
volume_cbmnumericread, writeVolume (m3)
package_countintegerread, writePackages
temperature_cnumericread, writeTemperature (C)
humidity_pctnumericread, writeHumidity %
vent_settingtextread, writeVent setting
stuffed_attimestamp with time zoneread, writeStuffed
gate_in_attimestamp with time zoneread, writeGated in
loaded_attimestamp with time zoneread, writeLoaded
discharged_attimestamp with time zoneread, writeDischarged
gate_out_attimestamp with time zoneread, writeGated out
emptied_attimestamp with time zoneread, writeEmptied
demurrage_free_untildateread, writeDemurrage free until
detention_free_untildateread, writeDetention free until
statustextread, writeStatus
Allowed: planned allocated stuffing stuffed gated_in loaded on_water discharged gated_out delivered emptied returned
notestextread, writeNotes
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 › Containers 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.