Get available zip codes for a country in a package

List ZIP codes available in a country (optionally narrowed by region and city) for this package. Use code values as the zip parameter of the connection-string endpoint.

Feature gate: returns 403 if your plan does not include ZIP targeting.

Requires the proxy:packages:read scope.

get/v1/proxy/packages/{package_id}/locations/countries/{cc}/zip-codes

Request

Base URL
https://api.platform.soax.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soax/apis/soax-api/docs/v1/proxy/packages/:package_id/locations/countries/:cc/zip-codes/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

package_idstring required

The ID of the proxy package

ccstring required

The ISO country code

Query parameters

network'wifi' | 'mobile' | 'mix' nullable

Filter by network type. Valid values are the package's own types (wifi, mobile, or mix); anything else returns 400 listing the networks available on the package.

regionstring nullable

The region name

citystring nullable

The city name

Response

Successful Response

Example response

{
  "data": [
    {
      "code": "10001",
      "name": "10001",
      "rank": 1,
      "volume_level": 3
    },
    {
      "code": "10002",
      "name": "10002",
      "rank": 2,
      "volume_level": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.