This is an old revision of the document!
COBI.shipping
Table of Contents
COBI.shipping is a REST-API service that acts as a connector between Barcode Shipping and SAP Business One. Its primary purpose is to exchange delivery and shipping data: it retrieves open delivery notes from SAP and reports back shipping information (including tracking numbers, weights, and item details) after the shipment has been processed.
Features
Delivery note retrieval: COBI.shipping provides Barcode Shipping with open (or optionally closed) delivery notes from SAP Business One. Only delivery notes with allowed shipping methods and unassigned items (not yet packed) are included.
Shipping confirmation: After a shipment has been processed in Barcode Shipping, COBI.shipping sends shipping details back into SAP Business One, including tracking numbers, shipping weight, and item-package assignments.
Automatic delivery note creation: If no delivery note exists for an order, COBI.shipping can automatically generate one based on the corresponding Sales Order, ensuring correct serial number or bin location assignment.
Status updates: The service updates delivery notes with shipping statuses (“In progress” for partial shipments or “Completed” when fully shipped) and can optionally trigger automatic invoice creation.
Integration with Coresuite Print: After invoice creation, COBI.shipping can trigger automatic printing through the COBI.wms Printservice, using predefined layouts and print definitions.
Shop/Partner feedback: Once a shipment is completed, COBI.shipping can send status updates (including tracking numbers, delivery note references, and customer codes) back to connected shops or partners.
Implementation details
* Delivered as a Windows service (installation via included batch files).
* Requires Barcode Shipping software and Java 11.
* API endpoints are provided under `/api/v1/` with authentication through an API key.
* Configuration is stored in SAP Business One (`@CMP_CONFIG`) and must be reloaded by restarting the service after changes.
* Supports customizable UDF mappings for address fields, tracking numbers, and commodity codes.
* Optional automatic invoice creation and Coresuite Print integration.
* Reads address and shipping information directly from SAP table `DLN12`.
Required UDFs in SAP Business One
For COBI.shipping to function properly, several User-Defined Fields (UDFs) must be created in SAP Business One. These fields store address information, shipping metadata, and customs information that are required by the integration.
Under Delivery Notes → Lines (DLN12):
| Title | Data type | Size | Description |
|---|---|---|---|
| cobi-shipping\_firstNameField | Alphanumeric | 50 | First name of the recipient |
| cobi-shipping\_lastNameField | Alphanumeric | 50 | Last name of the recipient |
| cobi-shipping\_companyField | Alphanumeric | 100 | Company name of the recipient |
| cobi-shipping\_phoneField | Alphanumeric | 30 | Phone number of the recipient |
| cobi-shipping\_emailField | Alphanumeric | 100 | Email address of the recipient |
Under Delivery Notes → Header:
| Title | Data type | Size | Description |
|---|---|---|---|
| cobi-shipping\_trackingInHeaderField | Alphanumeric | 100 | Field to store tracking number(s) in delivery note |
| cobi-shipping\_alarmGroupId | Numeric | 11 | Alarm group for invoice errors |
Under Items (OITM):
| Title | Data type | Size | Description |
|---|---|---|---|
| cobi-shipping\_oitmCommodityCodeField | Alphanumeric | 20 | Customs tariff code for export/import handling |