cobi.shipping
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
cobi.shipping [2025/08/22 12:47] – thuth | cobi.shipping [2025/08/22 13:40] (current) – [Installation] thuth | ||
---|---|---|---|
Line 2: | Line 2: | ||
COBI.shipping is a REST-API service that acts as a connector between **Barcode Shipping** and **SAP Business One**. | 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. | + | Its primary purpose is to exchange delivery and shipping data: \\ |
+ | - It retrieves open delivery notes from SAP Business One and | ||
+ | - reports back shipping information (including tracking numbers, weights, and item details) after the shipment has been processed. | ||
===== Features ===== | ===== Features ===== | ||
Line 26: | Line 28: | ||
===== Implementation details ===== | ===== Implementation details ===== | ||
- | * Delivered as a Windows service (installation via included batch files). \\ | + | - 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 ===== | ===== Required UDFs in SAP Business One ===== | ||
Line 41: | Line 43: | ||
^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
- | \| cobi-shipping\_firstNameField | + | | cobi-shipping\_firstNameField |
- | \| cobi-shipping\_lastNameField | + | | cobi-shipping\_lastNameField |
- | \| cobi-shipping\_companyField | + | | cobi-shipping\_companyField |
- | \| cobi-shipping\_phoneField | + | | cobi-shipping\_phoneField |
- | \| cobi-shipping\_emailField | + | | cobi-shipping\_emailField |
Under //Delivery Notes -> Header//: | Under //Delivery Notes -> Header//: | ||
^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
- | \| cobi-shipping\_trackingInHeaderField | + | | cobi-shipping\_trackingInHeaderField |
- | \| cobi-shipping\_alarmGroupId | + | | cobi-shipping\_alarmGroupId |
Under //Items (OITM)//: | Under //Items (OITM)//: | ||
^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
- | \| cobi-shipping\_oitmCommodityCodeField | Alphanumeric | + | | cobi-shipping\_oitmCommodityCodeField | Alphanumeric |
+ | ===== Installation ===== | ||
+ | |||
+ | **1. Install Barcode Shipping** | ||
+ | |||
+ | * Download and install Barcode Shipping from the internal archive (`N: | ||
+ | * During setup, choose **Shop → Eigentwicklung** and **Shipper → Einfacher Versender**, | ||
+ | * Install **Java 11** (required by Barcode Shipping). Instructions: | ||
+ | * Log in to Barcode Shipping with COMP.net credentials. | ||
+ | |||
+ | **2. Install COBI.shipping service** | ||
+ | |||
+ | * Extract the `cobi-shipping` ZIP archive (recommended path: `C: | ||
+ | * Configure the connection values in the file `cobi-shipping-service.exe.config` (SAP database settings). | ||
+ | * Run the provided batch files: | ||
+ | |||
+ | * `InstallService.bat` → installs the Windows service. | ||
+ | * `DeleteService.bat` → removes the Windows service. | ||
+ | |||
+ | **3. Configure Barcode Shipping** | ||
+ | |||
+ | * Open Barcode Shipping → File → Settings. | ||
+ | * General: | ||
+ | |||
+ | * Default shipper: *Einfacher Versender* | ||
+ | * Disable *Check order status* | ||
+ | * Enable *Mouse Mode* | ||
+ | * Default shop: *Connector* | ||
+ | * Connector: \\ | ||
+ | * API URL: http://< | ||
cobi.shipping.1755859652.txt.gz · Last modified: by thuth