ShipHawk Guide

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

You can now import by API custom, externally generated BOL 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

  • .zpl

The document_type can be specified as: bol, for bill of lading (BOL).

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.

  • No labels