Using Liminal APIs
Liminal Network’s proprietary product connects you directly with your carriers. Updates depend on the carrier’s technology, and update frequency can be anywhere from near-real-time to daily.
Liminal Network currently supports eight major APIs:
- Single-Use API Key
- Get Delivery Status
- Get Expected Delivery Date
- Get Bill of Lading
- Get Proof of Delivery
- Rating
- Final Mile Photos Images
- Final Mile Photos QR Code
RESTful or Webhook
RESTful APIs and Webhooks are best suited to different business needs or technical requirements. Liminal offers both options to support your customers.
RESTful APIs are ideal for scenarios where you’re initiating a one-time inquiry or you don’t store data. Liminal’s Rating API only offers RESTful because there will only be one response.
RESTful APIs are also great for accessing external data that you don’t store. You can embed any of our LTL Get APIs on your customer-facing order site to create real-time visibility without adding a tool to manage the data.
Webhooks are perfect when you expect multiple updates. Get Delivery Status is the perfect use case – as the carrier updates Delivery Status, the Webhook will push updates to your system.
Access Options for Liminal APIs
Restful | Webhook | |
---|---|---|
Single-Use API Key | x | |
Get Delivery Status | x | x |
Get Expected Delivery Date | x | x |
Get Bill of Lading | x | x |
Get Proof of Delivery | x | x |
Rating | x | |
Final Mile Photos Images | x | x |
Final Mile Photos QR Code | x |
Data needed to call Liminal’s Status & Image APIs
Everyone has different data available. Our product works without a TMS – you probably have PRO / Tracking Number and Carrier available in your OMS or Invoice data. You can execute Status & Image calls with:
- Tracking Number/PRO
- Tracking Number & Carrier Name/SCAC
- BOL
- BOL & Carrier Name/SCAC
Using Tracking Number/PRO and Carrier Name/SCAC will provide the fastest return.
Using the Sandbox
Liminal Network’s sandbox is an environment designed for testing. You can use the sandbox to ensure your APIs are returning expected results. You don’t need to set up a Liminal account to use the Sandbox.
Sandbox API Key: qNAJFePYEfzZag1pDqvR
Sandbox PROs:
- “images_complete” -> 123456789
- {“delivery_date”: “2024-08-28”, “delivery_time”: “2024-08-28T02:57:15”, “status”: “images_complete”, “longstatus”: “Images Complete”, “scac”: “SANDBOX”, “pro”: “123456789”}
- “in_transit” -> 123456787
- {“delivery_date”: “2024-09-06”, “delivery_time”: “2024-09-06T05:19:24”, “status”: “in_transit”, “longstatus”: “In Transit”, “scac”: “SANDBOX”, “pro”: “123456787”}
Sandbox BOLs:
- “images_complete” -> 123456789
- {“delivery_date”: “2024-08-28”, “delivery_time”: “2024-08-28T02:57:15”, “status”: “images_complete”, “longstatus”: “Images Complete”, “scac”: “SANDBOX”, “bol”: “123456789”}
- “in_transit” -> 123456787
- {“delivery_date”: “2024-09-06”, “delivery_time”: “2024-09-06T05:19:24”, “status”: “in_transit”, “longstatus”: “In Transit”, “scac”: “SANDBOX”, “bol”: “123456787”}
Last Updated | October 23, 2024
API Hub Documentation