Get BoxTop customer

Reads a customer from Descartes BoxTop by account number: name, country, clearance and delivery instructions, and contacts.

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

How to use it

Use Get BoxTop customer to read one customer from Descartes BoxTop by account number, for example to check their clearance instructions before you prepare an entry.

Good to know:

• The output holds the customer’s name and country, their clearanceInstructions and deliveryInstructions, and contacts with each person’s company, name, email and phone. 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 customer. A wrong API address can answer the same way, so it does not prove the customer is absent. Its output repeats the account number, 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

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.

Outputs

Output	Path	Type
Account Number	accountNumber	Text
Name	name	Text
Country	country	Text
Clearance Instructions	clearanceInstructions	Text
Delivery Instructions	deliveryInstructions	Text
Contacts	contacts	List
Sample	sample	Yes or no

Exits

Exit	Port	Notes
Found	found
Not found	not_found