Get BoxTop shipping invoice
Reads a commercial shipping invoice and its lines from a job in Descartes BoxTop: totals, weights, commodity codes and origin.
@lainstack/boxtop/get-shipping-invoice · TMS · Available on Lainstack Cloud
How to use it
Section titled “How to use it”Use Get BoxTop shipping invoice to read a commercial shipping invoice from a job in Descartes BoxTop, for example to compare what is already on the job with a new document.
Good to know:
- Job number takes a job number or a warehouse job number.
- With a Sample data connection, MCT-26-0871 is the invoice on each sample job, such as NG004417. Any other number is Not found.
- The output holds the invoice’s date, currency, total and terms, and lines with each line’s part number, description, quantity, prices, weights, commodity code and country of origin. BoxTop can leave any of these out, and then they are empty.
- The block leaves on Found or Not found. Not found means BoxTop’s answer held no invoice. A wrong API address can answer the same way, so it does not prove the invoice is absent. Its output repeats the two numbers, and everything else is empty.
- A draft run calls this block for real, because it only reads. It changes nothing in BoxTop.
- A Sample data connection answers from a fixed set of fictional records and calls nothing, so you can build and run an automation before you have a BoxTop key. sample is true on those answers.
- If BoxTop refuses the request or does not accept the key, the step fails with the HTTP status and never shows BoxTop’s reply. A rate limit or server error also fails the step, and is worth trying again. Each request has 30 seconds to finish.
Settings
Section titled “Settings”| Setting | Key | Type | Details |
|---|---|---|---|
| BoxTop connection (required) | credentialId |
Connection | Use a Sample data connection until you have a BoxTop key. At most 160 characters. |
| Job number (required) | jobNumber |
Text | The BoxTop job, up to 12 characters. Find or create BoxTop job returns it. |
| Invoice number (required) | invoiceNumber |
Text | The commercial invoice number on that job. |
Outputs
Section titled “Outputs”| Output | Path | Type |
|---|---|---|
| Invoice Number | invoiceNumber |
Text |
| Job Number | jobNumber |
Text |
| Invoice Date | invoiceDate |
Text |
| Currency | currency |
Text |
| Total | total |
Number |
| Terms | terms |
Text |
| Lines | lines |
List |
| Sample | sample |
Yes or no |
| Exit | Port | Notes |
|---|---|---|
| Found | found |
|
| Not found | not_found |