Get BoxTop job milestones

Lists the milestones on a job in Descartes BoxTop, to see which names it uses before you add one.

@lainstack/boxtop/get-job-milestones · TMS · Available on Lainstack Cloud

How to use it

Use Get BoxTop job milestones to list the milestones on a job in Descartes BoxTop. Run it first to see which names a job uses, so that Add BoxTop milestone writes one that matches.

Good to know:

• Each entry in milestones has its name, label, date, targetDate and comment, published, and customerAdvised, the date the customer was told. BoxTop can leave any of these out, and then they are empty.
• The list is in the order BoxTop gives. BoxTop documents no order of its own.
• published is true for any value of BoxTop’s Publish field other than 0. BoxTop’s docs don’t say what its values mean, so check this against a real job.
• The block always leaves on Out. A job with no milestones is a normal result with an empty list and a foundCount of 0, and it does not prove the job exists.
• A Sample data connection lists the same few milestones for each sample job, such as NG004417.
• 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

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.

Outputs

Output	Path	Type
Milestones	milestones	List
Found Count	foundCount	Number
Sample	sample	Yes or no