Skip to navigation

Get serviceable postcodes for a hub

View as Markdown
List the postcodes served by a Zippd hub for the selected service. Use the same service type when listing hubs and their postcodes.

Authentication

AuthorizationBearer

Query parameters

pageintegerOptionalDefaults to 1
The index of the page to retrieve from the results listing.
hub_idintegerRequired

The ID of a serviceable hub for the selected service. An Economy hub ID requires service_type=economy.

service_typeenumOptionalDefaults to non_dedicated

The service to look up. Use economy for Economy coverage. The default is non_dedicated.

Allowed values:

Response

Paginated list of serviceable postcodes
datalist of objects
metaobject
hubobject
The details of the hub found by this request.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error