Skip to content
Lainstack Docs

Find recent BoxTop jobs

Lists a customer’s newest jobs in Descartes BoxTop, for example to compare a new shipment with what they usually ship.

@lainstack/boxtop/find-recent-jobs · TMS · Available on Lainstack Cloud

How to use it

Section titled “How to use it”

Use Find recent BoxTop jobs to list a customer’s newest jobs in Descartes BoxTop, for example to compare a new shipment’s values with what they usually ship.

Good to know:

  • Look back takes 1 to 3650 days and defaults to 90. The search runs up to tomorrow, so a job dated today in the UK is not missed around midnight. Most jobs takes 1 to 100 and defaults to 5. A number outside those limits fails the step and says so, without calling BoxTop.
  • jobs lists the newest first, sorted by job date. Jobs with no date come last. BoxTop documents no order of its own, so the block sorts them before it cuts the list to Most jobs.
  • foundCount says how many jobs BoxTop listed in the period, and truncated is true when that is more than Most jobs.
  • No jobs is a normal result: jobs is empty and the block still leaves on Out. It does not prove the account exists, so use Get BoxTop customer to check that.
  • 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.
Account number (required) accountNumber Text The customer’s BoxTop account, up to 8 characters.
Look back (days) lookBackDays Number Jobs dated within this many days of today, from 1 to 3650. Defaults to 90.
Most jobs mostJobs Number How many of the newest jobs to return, from 1 to 100. Defaults to 5.

Outputs

Section titled “Outputs”
Output Path Type
Jobs jobs List
Found Count foundCount Number
Truncated truncated Yes or no
Sample sample Yes or no

Last updated: