Interfaces
General
With the COGLAS WEB WMS, data is exchanged bidirectionally via a data interface to any IT system. The outgoing data interface of COGLAS can be set up in push or pull mode. Push – COGLAS sends data as soon as they are available. Pull – The customer creates a WEB API direct query and receives the data message. We have already connected ERP systems (Enterprise Resource Planning), WM systems (Warehouse Management System), BDE systems (Production Data Acquisition), TMS (Transport Management System), PPS systems (Production Planning and Control), CEP service providers (Courier Express Package), forwarding agencies, web shops and FIBU (Financial Accounting).
COGLAS provides the customer with standard WEB-API’s, which can be called in JSON format. If your IT system cannot call our JSON standard interfaces directly, there is the possibility to transfer the data in XML format, XLSX format, JSON format or CSV files to the COGLAS WEB WMS. The import and export of Excel files is also possible without any problems.
In case you do not call our standard interfaces in JSON format, we use our own interface application. This is responsible for receiving and converting the data (e.g. XML, XLSX, CSV). We can install the interface application locally on your premises, on any server or in our cloud. The aim of the COGLAS data interface application is to connect external data interfaces to our COGLAS WEB WMS in a simple and uncomplicated way.
The interface application consists of an adapter and converter. The adapter is responsible for receiving and sending data. It establishes the connection between other IT systems and the interface application. For example, the adapter can unpack the sent files, establish access to your database (e.g. MS-SQL) or establish a connection to another WEB-API, etc. The converter transforms the received data and sends it to the interface application. The converter transforms the received files into our standard JSON format and message types and takes over the mapping (transmission of the correct data).
The connection with the formats JSON and XML can be applied to the COGLAS standard message types immediately. The connection to the formats CSV and XLSX requires an individual mapping. The connection to an SAP system for IDOC structures is also possible without any problems.
With the COGLAS WEB WMS we can send and receive data, we can poll or send data on a specific event (e.g. on status, time interval).
What do you need for authentication between your IT system and the COGLAS WEB WMS backend?
Specify URL and warehouse name
username* (string): Warehouse alias and user name in the form “warehouse/user name”.
password* (string): Password of the user
What do we need for authentication to use the interface application?
Scenario | Description | Further information |
---|---|---|
Interface application is located locally on a server at the customer’s site | Client puts files in a directory, we read from the directory regularly. No authentication is necessary | Client must set up server and perform maintenance. IIS must be installed. Remote maintenance access for COGLAS necessary. Mapping must be carried out for CSV and XLSX. |
Interface application resides in the Open Telecom Cloud | Via API key in the form of customer password via HTTPS | No remote maintenance access necessary for COGLAS. Customer does not need a server. Customer must send the data. |
Interface application is located on any server | By means of SFTP or HTTPS. Authentication takes place in both directions with a password, i.e. in the direction of the IT system and COGLAS WEB WMS. | |
SFTP (local at the customer’s site, cloud or on an external server) | FTP server regulates access data | |
Access from COGLAS WEB WMS to an external IT system | We need the access data from the customer |
Also for your project we will find together an optimal solution for the communication between your IT system and our COGLAS WEB WMS.
To ensure that long numerical values (e.g. NVE / SSCC numbers) are transferred correctly when opening CSV files with Excel, the data must be imported as text.
Type | Description |
---|---|
Article | For the transfer of article master data to the COGLAS Web WMS one of the following data structures can be used: Download |
Business partner | An overview of the possible business partner categories for the “PartnerType” field can be found under Master data → Business partner. The English designations are to be used. The following data structure can be used to transfer business partners to COGLAS Web WMS: Download |
Orders | For the transmission of orders to the COGLAS Web WMS one of the following data structures can be used: Download |
Delivery orders | For transmission of delivery bills to the COGLAS Web WMS one of the following data structures can be used: Download Furthermore it is possible to transfer delivery bills via WMTORD from SAP to COGLAS using a SOAP 1.1 interface. |
Customer orders | For the transmission of customer orders to the COGLAS Web WMS one of the following data structures can be used: Download Furthermore it is possible to transmit customer orders to COGLAS via a WMTORD using SOAP 1.1 interface. Tour data can be transferred to COGLAS as an update to the customer order header from an external planning system. The message type ShippingTour is used for this purpose. |
Production orders | The following data structure can be used to transfer production orders to the COGLAS Web WMS: Download |
Production receipts | The following data structure can be used to transfer production inputs to the COGLAS Web WMS: Download |
DHL Package
COGLAS Web WMS provides a direct interface to the DHL Paket product. This can be used to create the required shipping labels (also called shipping labels) for outgoing shipments in the course of packaging.
The generated shipping labels are created in the packing process and can be printed directly from the browser on any printer.
For test purposes, a so-called sandbox operation is possible in order to be able to generate sample labels.
DHL Package-business-customer
A business customer account with DHL Paket is required to use the service. You can find more information here.
Configuration
Select: If the DHL package option is enabled, DHL package can be selected in the of the. The available partners with defined interfaces are displayed in a selection box as soon as “Carrier” is selected as partner type.
Store access data: For productive operation, the access data of the DHL account to be used must be stored in the master data of the business partners. In multi-client operation, a separate account can be assigned to each client.
The DHL Business Customer Portal Access Data button can be used to enter the user, signature and EKP. As soon as the service is to be used with relevant data, the Productive operation checkbox must be activated.
Generate shipping labels
If DHL Paket was used as the carrier for the customer order, the shipping labels can be generated in the packaging or goods out.
The reference number is limited to 35 digits and should not be exceeded. Excerpt DHL:
ShipmentOrder. Shipment. ShipmentDetails. | String | Description |
---|---|---|
customerReference | maxLength: 35 | A reference number that the client can assign for better association purposes. Appears on shipment label. To use the reference number for tracking purposes, it should be at least 8 characters long and unique. |
Shipcloud
Shipping labels (also called shipping marks) can be created for the common CEP service providers via the service provider Shipcloud.
Shipcloud offers its own web portal independent of the COGLAS Web WMS. Here you can use e.g. the shipping labels generated so far can be managed or the costs incurred can be viewed.
Shipcloud assigns an ID / API key to each account. COGLAS needs this key to enable a connection to the COGLAS Web WMS.
Shipcloud-account
A paid Shipcloud account is required for regular use of the service.Configuration
Once the shipcloud account is configured, the CEP service providers can be selected in the business partner master data. The available partners are displayed in a selection box as soon as ” Carrier ” is selected as the partner type.Generate shipping labels
If one of the shipcloud service providers was used as the carrier for the customer order, the shipping labels can be generated in the packaging or goods out.
Sendcloud
The service provider Sendcloud can be used to create shipping labels for the most common CEP service providers. UPS and DPD are enabled by default.
Sendcloud offers its own web portal independent of the COGLAS Web WMS. Here, the shipping labels created so far can be managed (e.g. canceled) or the costs incurred can be viewed.
The customer must enter into their own contracts in order for these to be implemented.
Sendcloud assigns an API Key and API Secret to each account. COGLAS needs this key to enable a connection to the COGLAS Web WMS.
Functionality
Button | Beschreibung |
---|---|
If the business partner is stored as a client, the SendCloud APIs can be stored under the login data. | |
The SendCloud APIs are entered in the login data. The APIs can be found under the respective individual SendCloud accounts. | |
When a customer order has been picked and packed, the shipping labels are generated. | |
The shipping can be either called up ( green) or deleted (canceled) (red) via the marked buttons. |
Facilities
A Sendcloud account is required for regular use of the service. Create an integration in the Sendcloud account (menu Integration → Sendcloud API). For an integration a name must be assigned, this should also be meaningful to the recipients
COGLAS must first activate Sendcloud in the WMS before this function can be used.
After that the API Key and API Secret must be entered to enable the connection to the COGLAS WEB WMS. These APIs are stored in the respective business partners. The business partner must have the partner category “Client”.
After that the APIs can be entered in the following menu:
Once the Sendcloud account is configured in COGLAS, the CEP service providers can be selected in the business partner master data. The available partners are displayed in a selection box as soon as ” Carrier ” is selected as the partner type.
If one of the Sendcloud service providers was used as the carrier for the customer order, the shipping labels can be generated in the packaging:
Package dimensions are not transmitted to Sendcloud. The transfer of the weight from COGLAS to Sendcloud is done via interface to determine the shipping method. Reprint: In the COGLAS packaging menu, created shipping labels can be reprinted at any time (as long as the Sendcloud server allows it).
Cancellation of shipping labels (optional) can be done directly in the COGLAS packaging menu or alternatively via shipcloud.de. (How to cancel an order?)
→ back to COGLAS processes
→ back to COGLAS menu