Master data Integration
Intro and objective
This guideline describes how to maintain the master data on ECLIC. This can be done manually or automatically through API connection with your internal system. This guideline is intended for users that wish to integrate via an API. For the manual documentation, please refer to eECD master data
Product master data (seller)
When integrating your internal ERP software with ECLIC the product master data and corresponding SDS can be automatically created, updated and deleted on ECLIC based upon the actions of a user in your internal ERP software.
Create
When a new product is created in your own system which is relevant for processes running over ECLIC, the product should also be created on ECLIC. This product must be unique. This means no product may exist with the same article number and UN number. This can be done by following endpoints:
POST /v1/products
Creating a new product one can also upload an SDS document or refer to an external URL link. This can be done by following endpoints:
PUT /v1/products/{productId}/sds
PUT /v1/products/{productId}/sds/{language}/blob
Before using the ECLIC platform existing products must uploaded and created on ECLIC. This can be done in bulk by using following endpoint:
POST /v1/products/import
PUT /v1/products/{productId}/sds/{language}/blob
Update
When specific product master data is updated in your own system and the information is also a data field on ECLIC, this data field must be updated on ECLIC. To build the logic of checking if the product needs to be updated on ECLIC following endpoints can be used:
GET /v1/products
GET /v1/products/{productId}/sds/info
To update the specific data fields of the product or SDS following endpoints can used:
PUT /v1/products/{productId}/sds
Delete
When an products are deleted in your own system because the products will not be used anymore, the products can be deleted on ECLIC (Also, see section loading location to delete the corresponding loading locations). To build the logic of checking if the products needs to be deleted on ECLIC following endpoints can be used:
GET /v1/products
To delete the specific product following endpoints can used:
DELETE /v1/products/{productId}
DELETE /v1/products/bulk
DELETE /v1/products/{productId}/sds
Loading location master data (seller)
When defining your products on ECLIC through API integration it is also possible to define your loading locations where the product can be loaded (internal loading locations and external locations such as tank operators). Depending on whether you integrated your transport orders with ECLIC or not, you must define the loading locations and have to use other API endpoints.
Normal Seller
Defining your loading locations is optional. This loading location is used/selected by the Equipment Operator when he assigns a Load (referring to your transport order) to his Equipment. If not defined, the Equipment Operator is free to fill in the loading location. Defining normal loading locations can be done with the normal endpoints.
Integrated Seller
When you integrated your transport order information to ECLIC, loading locations must be defined. The loading location will be automatically available when the Equipment Operator assigns a Load (by selecting your transport order) to his Equipment. The special ‘integrated’ loading location endpoints has to be used in this case.
Create
You can define the different loading locations of a product which was created on ECLIC. This can be done by following endpoints:
POST /v1/products/locations/import
POST /v1/products/locations/integrated
POST /v1/products/locations/integrated/bulk
Update
When the loading locations needs to be updated for a specific product, one can check first what is already on the ECLIC platform defined and then update the loading locations. To build the logic following endpoints can be used:
GET /v1/products/locations/search
GET /v1/products/locations/{id}
GET /v1/products/{productId}/loaders/{loaderId}/locations
GET /v1/products/locations/integrated
GET /v1/products/locations/integrated/{id}
GET /v1/products/{productId}/locations/integrated/{uniqueReference}
When the loading locations needs to be updated for a specific product, one can check first what is already on the ECLIC platform defined and then update the loading locations. To build the logic following endpoints can be used:
PUT /v1/products/locations/{id}
PUT /v1/products/locations/integrated/{id}
Delete
You can define the different loading locations of a product which was created on ECLIC. This can be done by following endpoints:
DELETE /v1/products/locations/{id}
DELETE /v1/products/locations/integrated/{id}
DELETE /v1/products/locations/integrated/bulk
Equipment master data maintenance (equipment operator)
Create
When a new equipment is created in your own system, the equipment should also be created on ECLIC. This equipment must be unique. This means no equipment may exist with the same license plate (tanktrailer) or container ID (tankcontainer). This can be done by following endpoint:
POST /v1/equipment
Before using the ECLIC platform existing equipment must uploaded and created on ECLIC. This can be done in bulk by using following endpoint:
POST /v1/equipment/import
Update
When specific information of an equipment is updated in your own system and the information is also a data field on ECLIC, the equipment must be updated on ECLIC for the specific data field. To build the logic of checking if the equipment needs to be updated on ECLIC following endpoints can be used:
To update the specific data field of the equipment following endpoint can used:
Delete
When an equipment is deleted in your own system because the equipment will not be used anymore, the equipment can be deleted on ECLIC. To build the logic of checking if the equipment needs to be deleted on ECLIC following endpoints can be used:
To delete the equipment following endpoint can used:
DELETE /v1/equipment/{id}