PRpromorepublic
Locations Data

Get the post / zip code for locations

Get the post / zip code assigned to a location

get/locations/postcodes

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Query parameters

locationIdsstring[]

Get the post / zip codes for associated to the given list of location Ids

businessIdsstring[]

Get the post / zip codes for locations assigned to a business id

countriesstring[]

Get the post / zip codes for locations within a country

provincesstring[]

Get the post / zip codes for locations within a province / state

citiesstring[]

Get the post / zip codes for locations within a city

querystring

Restricts the response to the post/zip codes that contain this text, for example "374" would return "37490" when appropriate.

maxinteger

Maximum number of items to return

offsetinteger

Offset used for pagination. Default: 0

Response

Postcodes successfully retrieved

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Changes

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