TRANXACT.AI Help

Supply Chain · Yard

Yard Locations

The spots a trailer can stand in, and which of them are on a door.

Type REST6 operationsBase path /api/scm/yard-locationsPublished as /api/v1/yard-locations

Download specification (OpenAPI 3.1) Screen: Yard Locations

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 › Yard Locations 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.yard_locations · 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/yard-locationsList yard locations

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",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "spot_type": "parking",
      "door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "x_mm": "1250.00",
      "y_mm": "1250.00",
      "has_power": true,
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z",
      "xf_text_1": "text",
      "xf_text_2": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "spot_type": "parking",
  "door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "x_mm": "1250.00",
  "y_mm": "1250.00",
  "has_power": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
warehouse_iduuidYesWarehouse
codetextYesSpot
nametextYesName
spot_typetextNoType
Allowed: parking door gate scale fuel repair drop_lot
door_iduuidNoDoor
x_mmnumericNoX on the map (mm)
y_mmnumericNoY on the map (mm)
has_powerbooleanNoHas power for a refrigerated trailer
is_activebooleanNoActive

Sample body

{
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "spot_type": "parking",
  "door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "x_mm": "1250.00",
  "y_mm": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "spot_type": "parking",
  "door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "x_mm": "1250.00",
  "y_mm": "1250.00",
  "has_power": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/yard-locations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","spot_type":"parking","door_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","x_mm":"1250.00","y_mm":"1250.00"}'
PUT/api/scm/yard-locations/{id}Change a yard location

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
warehouse_iduuidYesWarehouse
codetextYesSpot
nametextYesName
spot_typetextNoType
Allowed: parking door gate scale fuel repair drop_lot
door_iduuidNoDoor
x_mmnumericNoX on the map (mm)
y_mmnumericNoY on the map (mm)
has_powerbooleanNoHas power for a refrigerated trailer
is_activebooleanNoActive

Sample body

{
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "spot_type": "parking",
  "door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "x_mm": "1250.00",
  "y_mm": "1250.00",
  "has_power": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

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

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/yard-locations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/yard-locations/{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/yard-locations/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 yard location, 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
warehouse_iduuidread, writeWarehouse
codetextread, writeSpot
nametextread, writeName
spot_typetextread, writeType
Allowed: parking door gate scale fuel repair drop_lot
door_iduuidread, writeDoor
x_mmnumericread, writeX on the map (mm)
y_mmnumericread, writeY on the map (mm)
has_powerbooleanread, writeHas power for a refrigerated trailer
is_activebooleanread, writeActive
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 › Yard Locations 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.