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
Asynchronous integration consisting of Trip Release and Trip Unblock services:
- If the orderBreakParts tag is empty, there are no breaks (splits) for trips sent in the interface;
- If the orderBreakParts tag is filled in, it means that there are trips on this interface that have breaks (splits); if this occurs, you must identify, within this structure, the transport requests that suffered breaks through the following fields:
- o orderSourceId: This field is the identifier of the transport request received in the order interface; if a transport request is inside the orderBreakParts structure, it means that it has suffered a break;
- o orderItemSourceId: This field is the item identifier of the transport order received in the order interface;
- If a transport order item is inside the orderBreakParts structure, it means that this item (which is inside the orderSourceId order) suffered a break;
- The loadId field that exists within the orderBreakParts structure serves to associate the transport request (orderSourceId and orderItemSourceId fields) with the load generated by TOL\TRE in this interface;
- The quantities updated by TOL\TRE after breaks must be obtained in the fields: quantShipmUnits; the quantProdUnits;
- o orderItemSourceId: This field is the item identifier of the transport order received in the order interface;
- o orderSourceId: This field is the identifier of the transport request received in the order interface; if a transport request is inside the orderBreakParts structure, it means that it has suffered a break;
Installation/Deployment/Usage Prerequisites
Minimum versions
- TOL/TRE: 6.4.0
- Protheus: ?
- Datasul: ?
- This integration requires no additional installations or updates.
Requisition Layout
| publishReleasedTrip: SOAP, Asynchronous integration with doUnblockReleasedTrip; | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| messageId | Integer | Yes | 10 | Trip release request message ID; | |
| orderBreakParts | orderBreakPart[] | No | N/A | Grouping element of all breaks; | There must be at least 1 break in this list; |
| tripReleaseRequests | tripReleaseReques[] | Yes | N/A | Grouping element of all travel release requests from; | There must be at least 1 travel release request on this list; |
| orderBreakPart, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| regionSourceId | String | Yes | 30 | Regional identifier; | Must be a valid regional; |
| orderBreakPartId | Integer | Yes | 10 | Break IDs; | |
| orderSourceId | String | Yes | 30 | Transport order ID associated with the break; | |
| orderTypeSourceId | String | Yes | 30 | Order type code; | |
| orderItemSourceId | String | Yes | 30 | Item ID of the transport order associated with the break; | |
| loadId | Integer | Yes | 10 | Load ID associated with the break; | |
| shipmentUnitId | Integer | Yes | 1 | Shipping Unit Enclosure Category ID; | 1=Package; 2=Non-unitizable bulk; 3=Pallet; 4=Unitizable bulk; 5=Coil; 6=Skid; 7=Tube; 8=Bundle of tubes; |
| quantShipmUnits | Float | Yes | 13 | Number of shipment units at break; | If the shipment item is shipped with fractional amounts, this field may, in some situations, also return fractional amounts; |
| quantProdUnits | Float | Yes | 13 | Number of units of the SKU in the breakdown; | |
| classifications | classifications [] | No | N/A | Grouping element of all classifications of a trip; | |
| attributes | attributes[] | No | N/A | Grouping element of all the attributes of a trip; | |
| tripreleaseRequest, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| regionSourceId | String | Yes | 30 | Regional identifier; | Must be a valid regional; |
| basketSourceId | String | No | 30 | ID of the basket where this operation was performed manually by the user; | This field may not be sent in cases where the release was requested automatically and not through the screen (in these cases, the user's basket cannot be identified); |
| identifier (trip) | Integer | Yes | 10 | ID of the trip whose release is being requested; | |
| freightValue | Float | Yes | 13 | Cost of freight for the trip; | |
| carrierId | String | Yes | 255 | ID da transportadora da viagem; | Does not exist in TRE (R2) |
| vehicleId | String | Yes | 255 | Trip Vehicle Type ID; | |
| vehicleDescription | String | No | 255 | Description of the type of vehicle for the trip; | |
| truckLicensePlate | String | No | 8 | Trip truck plate; | This plate may be informed by the carrier when accepting the trip (Partner Collaboration); |
| truckLicensePlateState | String | No | 2 | State of the trip truck's license plate; | |
| truckStatusId | String | No | 2 | Identifier of the situation of the truck; | 0=Unknown, 1=Aggregate, 2=Own fleet, 3=Outsourced fleet; |
| truckStatusDescription | String | No | 255 | Description of the situation of the truck; | |
| truckAxlesQuantity | Integer | No | 10 | Number of truck axles; | The axles of all the truck's trunks will be counted; |
| trailers | trailer[] | No | N/A | Grouping element of all trailers on a trip; | Does not exist in TRE (R2) |
| classifications | classifications [] | No | N/A | Grouping element of all classifications of a trip; | |
| attributes | attributes[] | No | N/A | Grouping element of all the attributes of a trip; | |
| comments | String | No | 255 | Travel observation; | |
| loads | load[] | Yes | N/A | Grouping element of all loads of a trip; | There must be at least 1 cargo in this list; |
| trailer, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| trailerLicensePlate | String | No | 8 | Travel trailer plate; | This plate may be informed by the carrier when accepting the trip (Partner Collaboration); |
| trailerLicensePlateState | String | No | 2 | Status of the travel trailer's license plate; | |
| load, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| identifier (load) | Integer | Yes | 10 | Trip Cargo ID; | |
| serviceTypeId | Integer | Yes | 1 | Load Service Type ID; | Full truck load (FTL); Less than truck load (LTL); |
| serviceTypeDescription | String | Yes | 255 | Description of the load service type; | |
| loadMode | Integer | Yes | 1 | Load Type ID; | 1=Stowage; 2=Palletized; 3=Mixed; |
| modal | Integer | Yes | 1 | Cargo modal ID; | 1=Roadway; 2=Waterway; 3=Railway; 4=Air; |
| distance | Float | Yes | 13 | Load distance; | |
| freight | Float | Yes | 13 | Freight of Load; | |
| dispatchLimitTime | Date/hour (String) | No | 29 | Deadline for dispatch of cargo; | Last possible time window for the load; |
| stops | stop[] | Yes | N/A | Grouping element of all the stops of a load of a trip; | There must be at least 2 stops on this list; |
| stop, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| identifier (stop) | Integer | Yes | 10 | ID of the stop of a shipment of a trip; | |
| localitySourceId | String | Yes | 30 | ID of the stop locality of a shipment of a trip; | |
| transportZoneId | String | Yes | 255 | Transport zone ID of the stop of a load of a trip; | |
| transportZoneDescription | String | No | 50 | Description of the transport zone of the stop of a load of a trip; | |
| sequenceOnLoad | Integer | Yes | 10 | Sequence of the stop of a load of a trip; | |
| subStops | subStop[] | Yes | N/A | Grouping element of all the sub-stops of a load of a trip; | There must be at least 1 sub-stop for a stop; |
| subStop, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| identifier (sub-stop) | Integer | Yes | 10 | ID of the sub-stop of a shipment of a trip; | |
| arrivalTime | Date/hour (String) | Yes | 29 | Planned date of arrival of the vehicle at the sub-stop of a load of a trip; | |
| startServiceTime | Date/hour (String) | Yes | 29 | Planned start date of loading/unloading at sub-stop of a load of a trip; | |
| endServiceTime | Date/hour (String) | Yes | 29 | Planned date of end of loading/unloading in the sub-stop of a load of a trip; | |
| departureTime | Date/hour (String) | Yes | 29 | Planned date of departure of the vehicle from the sub-stop of a load of a trip; | |
| dockId | Integer | No | 10 | ID of the planned loading/unloading dock at the sub-stop of a load of a trip; | |
| dockDescription | String | No | 255 | Description of the planned loading/unloading dock at the sub-stop of a load of a trip; | |
| loadedShipmentUnits | Yes | N/A | Grouping element of shipment units that will be loaded at a stop of a load of a trip; | There must be at least 1 shipping unit on this list; | |
| unloadedShipmentUnits | shipmentUnit[] | Yes | N/A | Grouping element of shipment units that will be unloaded at a stop of a load of a trip; | There must be at least 1 shipping unit on this list; |
| shipmentUnit, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| identifier (shipment unit) | Integer | Yes | 10 | ID of the shipment unit of a stop of a load of a trip; | |
| shipmentUnitCategoryId | Integer | Yes | 1 | Shipping Unit Enclosure Category ID; | 1=Package; 2=Non-unitizable bulk; 3=Pallet; 4=Unitizable bulk; 5=Coil; 6=Skid; 7=Tube; 8=Bundle of tubes; |
| shipmentUnitDescription | String | No | 20 | Description of the shipping unit enclosure category; | BULK; BULK_UNIT, PACK; PALLET; DRUM; SKID; TUBE; TUBE_PACK; |
| shipmentUnitQty | Float | Yes | 13 | Number of boarding units of a stop of a load of a trip; | |
| weight | Float | Yes | 13 | Weight of the shipment units of a stop of a load of a trip; | |
| volume | Float | Yes | 13 | Volume of the shipment units of a stop of a load of a trip; | |
| length | Float | Yes | 13 | Length of the shipment units of a stop of a load of a trip; | |
| width | Float | Yes | 13 | width of the shipment units of a stop of a load of a trip; | |
| height | Float | Yes | 13 | height of the shipment units of a stop of a load of a trip; | |
| palletHeightTotal | Float | Yes | 13 | Total maximum height of the boarding units of a stop of a load of a trip; | |
| deliveryUnitList | deliveryUnit[] | Yes | N/A | Grouping entity of the delivery units of a stop of a load of a trip; | There must be at least 1 delivery unit on this list; |
| deliveryUnit, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| identifier (delivery unit) | String | Yes | 30 | Delivery unit ID; | |
| orderSourceId | String | Yes | 30 | Delivery unit transport order ID; | |
| orderTypeSourceId | String | Yes | 30 | Order Type code; | |
| orderItemSourceId | String | Yes | 30 | Delivery unit transport order item ID; | |
| productSourceId | String | Yes | 30 | ID do produto da unidade de entrega; | |
| sequenceComposition | Integer | No | 10 | Delivery unit SKU composition sequence (only for SKUs that are multi-volume); | |
| quantity | Float | Yes | 13 | Quantity of delivery units; | |
| price | Float | Yes | 13 | Price of delivery units; | |
| deliveryDate | Date/hour (String) | Yes | 29 | Planned date of delivery of the delivery unit; | |
| integrationSource | String | Yes | 30 | Data source ID; | |
| classifications | classifications [] | No | N/A | Grouping element of all classifications of a delivery unit | |
| attributes | attributes[] | No | N/A | Grouping element of all attributes of a delivery unit | |
| classifications, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| type | String | Yes | 255 | Trip classification type; | |
| value | String | Yes | 255 | Trip classification value; | |
| attributes, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
| name | String | Yes | 255 | Trip attribute name; | |
| value | String | Yes | 255 | Trip attribute value; | |
Answer Layout
| publishReleasedTripResponse, type of data used in TOL/TRE integrations | |||||
|---|---|---|---|---|---|
| Name | Type | Mandatory | Size | Description | Observation |
| publishReleasedTripResponse | String | Yes | 1 | Message confirming receipt of travel release requests; | "Y" ou "N"; |
Error catalog
| Code | Message | Description |
Attachments
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas