Details:  Courier Manifest

URL:  https://yourlibrary.caiasoft.com/api/couriermanifest/v1/{shipfrom}/{shipto}/{courier}

HTTP Verb:  GET

Authorization Required:  

Name	Value	Required	Notes
X-API-Key	string	Yes	send in header

Parameters:  

Name	Value	Required	Notes
shipfrom	date in YYYYMMDD format	Yes	Shipment Date From
shipto	date in YYYYMMDD format	Yes	Shipment Date To
courier	date in YYYYMMDD format	Yes	Courier Name or "GOOGLE"

Return Response:  
{“success”:”true/false”, “error”:”string”, “count”:”integer”, "stoplist":[ { “name”:”value” (see items-> section of table below) } ]}

Name	Value	Notes
success	true/false
error	string	API format/key errors only. Will only be filled in when success = false
shipment_count	integer	Count of Shipments Sent in Date Range
manifest -> shipment	string	Shipment Number
manifest -> carts -> bin	string	Cart/Bin Number in Shipment If Google, Cart Number always applies
manifest -> carts -> items	array	Items include in Bin/on Cart in Shipment
manifest -> carts -> item_count	int	Number of Items in Bin/on Cart in Shipment
cart_count	int	total Number of Bins/Carts on Shipment
stoplist -> delivery_ert	string	Yes if location is accepting E-Retrieval (ERT) Requests
shipment_status	string	LOADING / DISPATCHED
dispatch_date	string	If Dispatch, date marked as such

Examples:  
API Call:

https://yourlibrary.caiasoft.com/api/couriermanifest/v1/20241115/20241120/GOOGLE

API Return:

{ "success": true, "error": "", "shipment_count": 1, "manifest": [ { "shipment": "GOOGLE-0006", "carts": [ { "bin": "CART0000001", "items": [ "99604008327", "99604095314", "99308406066" ], "item_count": 3 }, { "bin": "CART000001B", "items": [ "99604278298", "99604484431", "99601988705", "99602912596", "99604008386", "99602688071", "99602150221"], "item_count": 7 } }, "cart_count": 2, "shipment_status": "DISPATCH", "dispatch_date": "2024-11-18" } ] }