TRANXACT.AI Help

Supply Chain · Maps & Geography

Places

A place, geocoded. Held once and referenced everywhere: the same customer address appears on a hundred deliveries, and correcting it once should correct all of them.

Type REST6 operationsBase path /api/scm/geo-placesPublished as /api/v1/geo-places

Download specification (OpenAPI 3.1) Screen: Places

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 › Places 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.geo_places · 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/geo-placesList places

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",
      "code": "COD-000001",
      "name": "Example",
      "place_type": "text",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "region": "text",
      "postal_code": "POS-000001"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "place_type": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextNoCode
nametextYesName
place_typetextNoType
location_iduuidNoCompany location
warehouse_iduuidNoWarehouse
account_iduuidNoCustomer
supplier_iduuidNoSupplier
address_line1textNoAddress
address_line2textNoAddress line 2
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
latitudenumericNoLatitude — A rooftop match and a postal-code centroid are both "geocoded", and routing to the second puts a 40-tonne vehicle in a village square.
longitudenumericNoLongitude
timezonetextNoTime zone
open_fromtime without time zoneNoOpen from
open_totime without time zoneNoOpen to
appointment_requiredbooleanNoAppointment required
max_vehicle_typetextNoLargest vehicle that can get in
has_dockbooleanNoHas a dock
has_forkliftbooleanNoHas a forklift
requires_tail_liftbooleanNoNeeds a tail lift
access_notestextNoAccess notes
contact_nametextNoContact
contact_phonetextNoTelephone
is_activebooleanNoActive

Sample body

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

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "place_type": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/geo-places" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","code":"COD-000001","place_type":"text","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/geo-places/{id}Change a place

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
codetextNoCode
nametextYesName
place_typetextNoType
location_iduuidNoCompany location
warehouse_iduuidNoWarehouse
account_iduuidNoCustomer
supplier_iduuidNoSupplier
address_line1textNoAddress
address_line2textNoAddress line 2
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
latitudenumericNoLatitude — A rooftop match and a postal-code centroid are both "geocoded", and routing to the second puts a 40-tonne vehicle in a village square.
longitudenumericNoLongitude
timezonetextNoTime zone
open_fromtime without time zoneNoOpen from
open_totime without time zoneNoOpen to
appointment_requiredbooleanNoAppointment required
max_vehicle_typetextNoLargest vehicle that can get in
has_dockbooleanNoHas a dock
has_forkliftbooleanNoHas a forklift
requires_tail_liftbooleanNoNeeds a tail lift
access_notestextNoAccess notes
contact_nametextNoContact
contact_phonetextNoTelephone
is_activebooleanNoActive

Sample body

{
  "name": "Example",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "place_type": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001"
}

Sample request

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

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/geo-places/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/geo-places/{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/geo-places/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 place, 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
codetextread, writeCode
nametextread, writeName
place_typetextread, writeType
location_iduuidread, writeCompany location
warehouse_iduuidread, writeWarehouse
account_iduuidread, writeCustomer
supplier_iduuidread, writeSupplier
address_line1textread, writeAddress
address_line2textread, writeAddress line 2
citytextread, writeCity
regiontextread, writeRegion
postal_codetextread, writePostal code
countrytextread, writeCountry
latitudenumericread, writeLatitude — A rooftop match and a postal-code centroid are both "geocoded", and routing to the second puts a 40-tonne vehicle in a village square.
longitudenumericread, writeLongitude
elevation_mnumericread onlyElevation m
geocode_precisiontextread onlyGeocode precision
geocoded_attimestamp with time zoneread onlyGeocoded at
geocode_providertextread onlyGeocode provider
timezonetextread, writeTime zone
open_fromtime without time zoneread, writeOpen from
open_totime without time zoneread, writeOpen to
appointment_requiredbooleanread, writeAppointment required
max_vehicle_typetextread, writeLargest vehicle that can get in
has_dockbooleanread, writeHas a dock
has_forkliftbooleanread, writeHas a forklift
requires_tail_liftbooleanread, writeNeeds a tail lift
access_notestextread, writeAccess notes
contact_nametextread, writeContact
contact_phonetextread, writeTelephone
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 › Places 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.