getServicesByServiceCodes

Nothing Found

Locations API

Version 2.3.0

getServicesByServiceCodes

This endpoint returns an array of services based on a comma-delimited list of service codes supplied in the request. **Note: ** A list of all current service codes is available from the getServices endpoint.

SecurityAUTH-KEY

Request

path Parameters

service_codes

required

string

A comma-delimited list of service codes by which to filter the returned list of matching locations.

query Parameters

string

A partner code identifies an entity that owns location data. Currently we offer access only to Australia Post outlet and services data. In the future we may expand this to include location data from partner providers. Note: If this field is left empty, the default value is "AP". Submitting any other value will return an empty data set.

Responses

200

get/services/{service_codes}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"services": [{"service_code": 3,
"partner_code": "AP",
"name": "Special",
"description": "Open before 9.00am weekdays",
"appointment_required": false,
"searchable": false,
"url_name": "open-before-900am-weekdays",
"categories": [{"name": "opening_hours",
"description": "Opening hours"
}
]
},
{"service_code": 6,
"partner_code": "AP",
"name": "Boxes_Available",
"description": "PO Boxes available",
"appointment_required": false,
"searchable": false,
"url_name": "po-boxes-available",
"categories": [{"name": "parcels_mail",
"description": "Parcels & mail"
}
]
}
]
}