List
GET /zipcodes
To list zipcodes to your account you should make an HTTP GET request to the List Zipcodes endpoint. You can list zipcodes for a specific domain and perform a search using the search_term querystring parameter.
Zipcode Licensing To view how many zipcodes you can add to your account you can use the Account API.
Zipcodes can also be listed and edited visually via the Dashboard.
For more information about using zip & postal codes with BlueCart API please see the zipcodes overview.
The following querystring (HTTP GET) parameters allow you to refine the results returned by the List Zipcodes API.
Parameter | Required | Description |
api_key | required | The API key for your account. |
search_term | optional | Limits the returned zipcodes to just those containing the search_term i.e. search_term=455 (to return only zipcodes containing the string 455 ). |
domain | optional | Filters the zipcodes returned to only those from the domain specified. |
page | optional | The page of results to return. A maximum of 10 results are returned per page. |
In the example below we List all the zipcodes on your account:
An example of a successful response to the List Zipcodes API is shown below: