Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| moneyworks:billig_shipping_script [2026/02/18 15:11] – Martin Falconer | moneyworks:billig_shipping_script [2026/02/18 18:59] (current) – Martin Falconer | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| - | The Billig shipping script, named ' | + | The Billig shipping script, named ' |
| - | It runs as a MW script and uses CURL to send shipping orders over tcp/http. It is triggered by selecting Sales Invoices and pressing the " | + | It runs as a MW script and uses CURL to send shipping orders over tcp/http. It is triggered by selecting Sales Invoices and pressing the " |
| ====== Technical documentation ====== | ====== Technical documentation ====== | ||
| Line 14: | Line 15: | ||
| * **Validates Delivery Addresses: | * **Validates Delivery Addresses: | ||
| * **Validates Country 2 Char representation: | * **Validates Country 2 Char representation: | ||
| + | |||
| + | ===== Missing features: ===== | ||
| + | |||
| + | * Unable to resend if send failure. | ||
| + | * No local record of sent orders (with MW SQLite, this could be done. Again, script is pretty busy already) | ||
| + | * If when adding a Sales Line to Sales Header fails.... no resend available as per above. Just gets left off order (has only happened a few times) | ||
| + | * UI feedback while working. Bit of a limitation of long running MW script. (Only recommend sending max of 10 Sales Invoices) | ||
| ===== BILLIG API Information: | ===== BILLIG API Information: | ||
| - | == Test Site Enpoints == | + | **API is locked down by IPs.** The available IPs are Martin' |
| + | API looks like it is maintained by prentow.com (Contacts not added here as public page) | ||
| + | |||
| + | ==== Test Site Enpoints | ||
| * Sales Header endpoint: http:// | * Sales Header endpoint: http:// | ||
| Line 23: | Line 34: | ||
| * Header duplication check: http:// | * Header duplication check: http:// | ||
| - | == Live Site Enpoints == | + | ==== Live Site Enpoints |
| * Sales Header endpoint: http:// | * Sales Header endpoint: http:// | ||
| Line 36: | Line 47: | ||
| * Cannot immediately check for duplicated orders. | * Cannot immediately check for duplicated orders. | ||
| * Uses HTTP and not HTTPS | * Uses HTTP and not HTTPS | ||
| - | * The test site is never updated with data and rules from the " | + | * The test site is never updated with data and rules from the " |
| - | * Uses NTLM for authentication. | + | * Uses antiquated |
| + | |||
| + | ==== How API Works ==== | ||
| + | |||
| + | * Before adding a Sales Header, check if order already exists using the Header Check duplication endpoint | ||
| + | * A Sales Header is created using the Sales Header endpoint | ||
| + | * Individual lines are added to Sales Header using the Lines Header endpoint | ||
| + | |||
| + | |||
| + | === Sales Header Fields (text from script) === | ||
| + | |||
| + | Document_No = " | ||
| + | External_Docuement_No = " | ||
| + | shippingCodeLines = See below how shippingCodeLines are calculated\\ | ||
| + | |||
| + | let pdata = " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + shippingCodeLines | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + "\n} | ||
| + | |||
| + | === Sales Line Fields (text from script) === | ||
| + | |||
| + | Document_No = " | ||
| + | Line_No = sequential integer number. 1, 2, 3, etc...\\ | ||
| + | |||
| + | let pdata = " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | let pdata = pdata + " | ||
| + | |||
| + | === Shipping Code Lines === | ||
| + | |||
| + | A few shipping codes are sent in the Sales Header. | ||
| + | * " | ||
| + | * " | ||
| + | |||
| + | The logic depends (as of today, 17th Feb 2026): | ||
| + | |||
| + | * If internal order is for customer " | ||
| + | * " | ||
| + | * " | ||
| + | * If destination country " | ||
| + | * " | ||
| + | * " | ||
| + | * If destination country " | ||
| + | * " | ||
| + | * " | ||
| + | * If destination country is none of the above, and not " | ||
| + | * " | ||
| + | * " | ||
| + | |||
| + | ==== Entry point: ==== | ||
| - | ====== Entry point: ====== | + | on Before: |
| + | InstallToolBarIcon(windowRef, | ||
| + | end | ||
| + | |||
| + | ==== Script Logic and Steps ==== | ||
| - | main.rs calls `start_server` which runs the main service loop. | + | * User highlights Sales Invoices to send and presses " |
| + | * Check each Transaction is of type " | ||
| + | * Check Transaction.user_4 field is empty AND != " | ||
| + | * Check there are Transactions selected. | ||
| + | * Attempt to send transactions with following validations for each transaction | ||
| + | * Validate again if user_4 is empty or anything but " | ||
| + | * Check if Web Order. | ||
| + | * Parse transaction delivery addresses and validate | ||
| + | * Address must be 4, 5, or 6 lines | ||
| + | * If only 4 lines, third line must have City and Postcode on same line, in that order | ||
| + | * First line is always | ||
| + | * Last line is always the country name, or country 2 code letters, nothing more. i.e " | ||
| + | * Second to last line must always be JUST postocde, or have postcode as last value on line. i.e " | ||
| + | * Parse for 2 Char country code if full country name is given | ||
| + | * Check all Transaction lines are from the " | ||
| + | * Check order doesn' | ||
| + | * Create Sales Header | ||
| + | * Add lines to Sales Header, one by one | ||
| + | | ||