Introduction
Systems Involved
- TOTVS Otimização Logística / TOTVS Roteirização e Entrega
- External System: ERPs that connect or intend to connect with TOL/TRE
Scope
Installation/Deployment/Usage Prerequisites
Minimum versions
- TOL/TRE: 6.4.0
- Protheus: ?
- Datasul: ?
- This integration requires no additional installations or updates.
Requisition Layout
| createLocality/updateLocality/deleteLocality: SOAP Integration, Synchronous | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| regionSourceId | String | Yes | 30 | Regional identifier; | Must be a valid regional; |
| identifier | String | Yes | 30 | Locality ID | The Locality ID must be unique; |
| name | String | Yes | 255 | Locality name | |
| description | String | No | 1000 | Locality description | |
| localityRestrictionSourceId | String | No | 30 | Locality constraint identifier; | Does not exist in TRE (R2); Must be a valid Locality constraint; If this information is not sent, the default Locality restriction configured in TOL will be used; |
| addressCountryAcronym | String | Yes | 2 | Acronym of the country of the Locality ; | It must be a valid acronym; |
| addressStateAcronym | String | Yes | 2 | Locality Addres State | It must be a valid acronym; |
| addressCity | String | Yes | 50 | Locality Addres City | The city will only be saved if the state is provided; |
| addressDistrict | String | No | 50 | Locality Addres District | The district will only be recorded if the state and city are provided; |
| addressStreet | String | Yes | 200 | Locality Addres Street | |
| addressNumber | String | No | 30 | Locality address number; | |
| addressComplement | String | No | 30 | Complement of the address of the locality; | |
| addressZipCode | String | No | 10 | zip code of the Locality ; | The value can't be invalid; Observation: - It is possible to configure in the installation of the TOL/TRE an automatic treatment for invalid ZIP sent in the integration; - There is the possibility of configuring a default zip code in the TOL/TRE for cases where the zip code is unknown; |
| latitude | Float | No | 13 | Locality latitude; | If this field is provided, the longitude of the Locality must also be provided; the value of this field must be in the range -90.0 to 90.0; Observation: - It is possible to configure an automatic treatment of geo-coding in the installation of the TOL/TRE; if this setting is enabled, upon receipt of a Locality , it will be automatically geocoded; |
| longitude | Float | No | 13 | Locality longitude; | If this field is provided, the latitude of the Locality must also be provided; the value of this field must be in the range -180.0 to 180.0; Observation: - It is possible to configure an automatic treatment of geo-coding in the installation of the TOL/TRE; if this setting is enabled, upon receipt of a Locality , it will be automatically geocoded; |
| logisticRoleId | Integer | Yes | 1 | Locality 's logistical role (i.e., whether it is origin, destination, or both); | 1=Both; 2=Destination; 3=Origin; |
| preferredDestinationLocalitySourceId | String | No | 30 | Identifier of the preferred destination Locality for this Locality ; | Does not exist in TRE (R2); The Locality id sent in this field can be the same as the Locality id sent in the "identifier (locality)" field; |
| isDestinationHub | Boolean | No | 1 | Flag indicating whether the Locality is a destination hub; | Does not exist in TRE (R2); 1=true; 0=false; only Locality s that have a "destination" or "both" logistical role can be destination hubs; |
| isPassingHub | Boolean | No | 1 | Flag indicating whether the Locality is a transit hub; | Does not exist in TRE (R2); 1=true; 0=false; only Locality s that have a "both" logistical role can be transit hubs; |
| classifications | classifications [] | No | N/A | Grouping element of all classifications of a locality; | |
| attributes | attributes[] | No | N/A | Grouping element of all attributes of a Locality ; | |
| classifications, data type used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| type | String | Yes | 255 | Locality classification type; | |
| value | String | Yes | 255 | Locality classification value; | |
| attributes, data type used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| name | String | Yes | 255 | Locality attribute name; | |
| value | String | Yes | 255 | Locality attribute value; | |
Answer Layout
| localityResponse, data type used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| result | result[] | Yes | N/A | Grouping element of all results | There must be at least 1 result in this list; |
| sucess | Boolean | Yes | 1 | Success or failure flag | |
| result, data type used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| errorCodes | String | no | 30 | List of error codes | |
| errorMessage | String | no | 255 | Error messages | |
| identifier | String | no | 30 | Error table identifier | |
| sucess | Boolean | Yes | 1 | Success or failure flag | |
Error catalog
| Code | Message | Description |
Attachments
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas