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
createProducts/updateProducts/deleteProducts: SOAP Integration, Synchronous | |||||
---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
regionSourceId | String | Yes | 30 | Regional identifier; | Must be a valid regional; |
shipperId | String | Yes | 255 | Shipper ID; | This field must be from a valid shipper; |
identifier | String | Yes | 30 | SKU ID; | The SKU ID must be unique for the same shipper; |
name | String | No | 255 | SKU name; | |
description | String | No | 300 | SKU description; | |
productCategoryId | String | No | 30 | SKU Category ID; | This field must be a valid category; |
shape | Integer | Yes | 1 | Shipping Wrapper Form ID associated with the SKU; | This field must be a valid form of shipping envelope; 0=Cash; 1=Tube; 2=Coil; 3=Liquid; 4=Undefined; |
height | Float | Yes | 13 | Height of the shipping envelope shape associated with the SKU; | Does not exist in TRE (R2); If the shape of the shipping envelope is "box" or "tube", this field is mandatory and must be greater than zero; if the shape of the shipping envelope is "coil", this field is mandatory and must be equal to zero; for the "tube" shape, the height is the size of the inner diameter of the tube (thus, the width of a tube must always be greater than its height); if the form of the shipping envelope is "liquid" or "undefined", this field will not be considered (i.e., it does not need to be informed); |
length | Float | Yes | 13 | Length of the shipping wrap shape associated with the SKU; | Does not exist in TRE (R2); If the form of the shipping envelope is "box" or "tube" or "coil", this field is mandatory and must be greater than zero; if the form of the shipping envelope is "liquid" or "undefined", this field will not be considered (i.e., it does not need to be informed) |
width | Float | Yes | 13 | Width of the shipping envelope shape associated with the SKU; | Does not exist in TRE (R2); If the form of the shipping envelope is "box" or "tube" or "coil", this field is mandatory and must be greater than zero; for the "tube" shape, the width is the size of the outer diameter of the tube (thus, the width of a tube must always be greater than its height); if the form of the shipping envelope is "liquid" or "undefined", this field will not be considered (i.e., it does not need to be informed) |
weight | Float | No | 13 | SKU weight; | Does not exist in TRE (R2); This field must be a number greater than zero; |
hlwAllow | Boolean | No | 1 | Flag indicating whether the SKU can be overturned in the ACL orientation; | Does not exist in TRE (R2); A=Height; L=Width; C=Length; see possible orientations of a SKU; if this information is not informed, the data parameterized in the system (ProductSysParams) will be used; |
hwlAllow | Boolean | No | 1 | Flag indicating whether the SKU can be tipped in ALC orientation; | Does not exist in TRE (R2); A=Height; L=Width; C=Length; see possible orientations of a SKU; if this information is not informed, the data parameterized in the system (ProductSysParams) will be used; |
lhwAllow | Boolean | No | 1 | Flag indicating whether the SKU can be overturned in CAL orientation; | Does not exist in TRE (R2); A=Height; L=Width; C=Length; see possible orientations of a SKU; if this information is not informed, the data parameterized in the system (ProductSysParams) will be used; |
lwhAllow | Boolean | No | 1 | Flag indicating whether the SKU can be overturned in CLA orientation; | Does not exist in TRE (R2); A=Height; L=Width; C=Length; see possible orientations of a SKU; if this information is not informed, the data parameterized in the system (ProductSysParams) will be used; |
whlAllow | Boolean | No | 1 | Flag indicating whether the SKU can be overturned in LAC orientation; | Does not exist in TRE (R2); A=Height; L=Width; C=Length; see possible orientations of a SKU; if this information is not informed, the data parameterized in the system (ProductSysParams) will be used; |
wlhAllow | Boolean | No | 1 | Flag indicating whether the SKU can be tipped in the LCA orientation; | Does not exist in TRE (R2);
|
classifications | classifications [] | No | N/A | Grouping element of all classifications of a product; | |
attributes | attributes[] | No | N/A | Grouping element of all attributes of a product; |
classifications, data type used in TOL/TRE integrations | |||||
---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
type | String | Yes | 255 | Product classification type; | |
value | String | Yes | 255 | Product classification value; |
attributes, data type used in TOL/TRE integrations | |||||
---|---|---|---|---|---|
Name | Type | Mandatory | Size | Description | Observation |
name | String | Yes | 255 | Product attribute name; | |
value | String | Yes | 255 | Product attribute value; |
Answer Layout
ordersResponse, 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 | Lista de códigos List of error codesde erros | |
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