Core APIs
Zipcodes API

Overview

2min

Zipcodes API Overview

BigBox API allows you to set up zip/postal codes on your account and run your API requests in the context of those zipcodes.

Once set up on your account, you should set your requests customer_zipcode request parameter to specify the pre-configured zipcode to use (note that the platform requires a couple of minutes after the zipcode has been added to your account for it to be available to service requests).

You can add, list and delete zipcodes via the Zipcodes API as well as the Dashboard.

Zip or postal codes can be added to your account on the zipcodes page of the Dashboard, or via the Zipcodes API.

Zipcodes Dashboard
Zipcodes Dashboard


You can add zip or postal codes in bulk using the Dashboard or Zipcodes API.

Adding Zipcodes
Adding Zipcodes


Once a zip or postal code has been set up it can be specified in the customer_zipcode request parameter

Specifying a Zipcode
Specifying a Zipcode


Updated 09 Aug 2024
Did this page help you?