Table of Contents
Updated by Colin
Packing Instructions allow additional information to be attached to an order regarding how it should be packed as well as PDF documents which should be printed and inserted/affixed to an order during packing. Some examples where this feature may be useful would include:
- Bill of Lading for LTL or other pre-paid shipping label
- Box content information for FBA shipments to Amazon
- Customized promotional material (order-specific)
- Instructions regarding which size box to use
- Instructions regarding special handling of items (e.g. "Do not stack")
Packing Instructions can be added via the Admin or Client UI during order creation or after, as well as through the API.
Add Packing Instructions
From the Order page when creating a new Order click the Add button on the Packing Instructions header, or from an existing order click Edit in the Packing Instructions section.
Then proceed to fill the form fields. You may click Add multiple times to add additional Packing Instructions as needed.
Each Packing Instruction will have a "Note" which will be displayed to the packer in a modal notification requiring a confirmation from the packer. The Packing Instruction "Presentation" has three options which determine the timing of this notification and how many confirmations are required to satisfy the Packing Instruction.
- Once per Order (the first package of the first shipment)
- Once per Shipment (the first package of each shipment)
- Once per Package (each package of each shipment)
If a File is added, the "Target Printer" specified will determine which printer type the print job will be sent to. The "Presentation" will also determine how many copies of the file to send to the printer depending on how many shipments or packages are used to complete the order.
If the Target Printer is Label Printer, ShipStream will attempt to extract a 4x6 label from the document even if it is embedded in a letter-sized page. If it is for a Laser Printer and the PDF page size does not match the printer paper size, the document will be shrunk as necessary to fit the paper or else printed at actual size in the center of the paper.
The packer will be allowed to skip a Packing Instruction initially, but will be required to confirm it before they can "Finish Packing". A green check mark will denote all instructions that have been confirmed and the user may tap any instruction at any time to confirm it and print the files if attached. The user who confirmed a Packing Instruction and the time at which they confirmed it will be recorded and visible on the order page.
Packing Instructions can also be attached to orders through the API and using a Before Create Order Script with the
// Add special handling instructions
note: "Please be extra careful!",
A file can be attached by adding a
file_request option which must specify a
url from which the print job file will be downloaded. This url must accept an HTTP GET request and download a PDF file. A
print_target is also required when attaching a file with options being
// Add a special print job
note: "Adhere the label to the side of the package.",
For more advanced needs you can optionally specify a username/password using
auth for HTTP Basic Authentication or custom headers using
headers as an array of header names and values.
// Add a special print job with custom auth, headers and file_name
note: "Place the flyer on top of the infill.",
"X-Custom-Header": "header value..."