API Guides

Ready-to-use client libraries for popular programming languages.

API Center Menu

Regions & Coverage

Request Type: 

GET

API Endpoint:

<url>/api/region/zipcodes/:zip_code/schedule_availability 

Mandatory Headers Properties:

  • Authorization (type: string): the valid access token from the authentication.

Mandatory Query parameters:

  • zip_code (type: string): the zip code you would like to get the availability for.

Return a list of manifests and dates and their capacity availability for a given zip code

Response

{

	"status": "ok",

	"data": [

	{

		"_id": "5ca791f3efaef700201523c7",

		"scheduled_date": "2019-04-24T16:00:00.000Z",

		"route_id": "Bklyn/Qns/SI",

		"stops": 5,

		"max_number_of_stops": 14,

		"total_pieces": 14,

		"max_number_of_pieces": 45,

	  "capacity_status": 1

	},

	{

		"_id": "5cac997f8afc7a0020539caf",	

		"scheduled_date": "2019-05-01T16:00:00.000Z",	

		"route_id": "Bklyn/Qns/SI",	

		"stops": 2,	

		"max_number_of_stops": 14,	

		"total_pieces": 20,	

		"max_number_of_pieces": 45,	

		"capacity_status": 1

	}]

}