Add

3min
Add Zipcode
﻿POST  /zipcodes
To add zipcodes to your account you should make an  HTTP POST  request to the Add Zipcodes endpoint, specifying an array of objects containing a  zipcode  and  domain  property describing the zipcodes you'd like to add and the domain to use them on.
Zipcode Licensing
To view how many zipcodes you can add to your account you can use the Account API.
Zipcodes can also be added visually via the Dashboard.
For more information about using zip & postal codes with Backyard API please see the zipcodes overview.
Zipcode Status
When a zipcode is first added to your account it will report its status as  status=preparing . Zipcodes take around 2 minutes from the point they are added to your account to them being ready to service requests (during which time any requests specifing the zipcode in their  customer_zipcode  parameter will fail). When the zipcode is ready it will report as  status=available  and can then be used in a requests  customer_zipcode  parameter. For more information see the zipcode overview.
Curl
Node.js
Python
PHP
$ curl "https://api.backyardapi.com/zipcodes?api_key=demo" \
  --data '[ { "zipcode": "30339", "domain": "homedepot.com" } ]'
$ curl "https://api.backyardapi.com/zipcodes?api_key=demo" \
  --data '[ { "zipcode": "30339", "domain": "homedepot.com" } ]'
﻿
An example of a successful response to the Add Zipcodes API is shown below:
JSON
{
  "request_info": {
    "success": true,
    "message": "2 zipcodes added"
  }
}
{
  "request_info": {
    "success": true,
    "message": "2 zipcodes added"
  }
}
﻿
﻿
Next Steps
     Zipcodes Overview
     Deleting a zipcode via the Zipcodes API
     Listing all zipcodes via the Zipcodes API﻿
Updated 08 Aug 2024
Did this page help you?
Overview
List