Get serviceable postcodes for a hub

GET

https://sandbox-api.deliveryapp.com/api/v1/serviceable-postcodes

GET

/api/v1/serviceable-postcodes

curl -G https://sandbox-api.deliveryapp.com/api/v1/serviceable-postcodes \
     -H "Authorization: Bearer <token>" \
     -d hub_id=1

{
  "data": [
    {
      "id": 1,
      "postcode": "string",
      "city": "string",
      "country": {
        "id": 437,
        "name": "United Kingdom",
        "code": "GB"
      }
    }
  ],
  "links": {
    "first": "https://sandbox-api.deliveryapp.com/api/v1/[resource URI]?page=1",
    "last": "https://sandbox-api.deliveryapp.com/api/v1/[resource URI]?page=4",
    "prev": "https://sandbox-api.deliveryapp.com/api/v1/[resource URI]?page=1",
    "next": "https://sandbox-api.deliveryapp.com/api/v1/[resource URI]?page=3"
  },
  "meta": {
    "current_page": 2,
    "last_page": 4,
    "per_page": 15,
    "from": 16,
    "to": 30,
    "total": 57,
    "path": "https://sandbox-api.deliveryapp.com/api/v1/[resource URI]"
  },
  "hub": {
    "id": 3745,
    "name": "BHM3",
    "updated_at": "2024-01-15T09:30:00Z",
    "version": 1
  }
}

Authentication

AuthorizationBearer

Query parameters

pageintegerOptionalDefaults to 1

The index of the page to retrieve from the results listing.

hub_idintegerRequired

Hub identifier

Response

Paginated list of serviceable postcodes

datalist of objects

linksobject

metaobject

hubobject

The details of the hub found by this request.

Errors

422

Unprocessable Entity Error