How To Upload Custom Documents via API To Print at Time of Shipping for External Shipments

You can now import by API custom, externally generated BOL, packing slips, and other shipping documentation and autoprint from ShipHawk at booking. This offers more flexibility for 3PLs and merchants who want to generate external documents.

API Endpoint

The ShipHawk API endpoint for the import is:

POST /api/v4/orders/:order_id/documents with params file and document_type

The supported file types include:

• .jpg

• .jpeg

• .png

• .tif

• .tiff

• .pdf

• .doc

• .docx

• .xls

• .txt

(NOTE: support for .zpl is coming soon.)

The document_type can be specified as: bol, for bill of lading (BOL), or when uploading packing slip, should be specified as packing_slip.

Example:

POST https://shiphawk.com/api/v4/orders/:order_id/documents/:id?api_key=YOUR_API_KEY`

file: ExternalBOL.pdf

document_type: bol

Workflow

On the ShipHawk TMS Order Details page, after you click Ship and book the shipment, the BOL (uploaded by API) displays, which can then be sent to a printer.

1. Click Ship:

Open

2. Order is booking…

Open

3. BOL displays:
   
   

    

4. Print BOL from Order Details page: