{{ activeApiMethod.description }}
This interface provides information on the availability of a given On Demand product to send from a particular locality (state, suburb & postcode) to a particular destination locality. The request is wrapped in a list to support multiple serviceability lookups in a single request. It is assumed that the requested origin and destination are valid addresses and the requested product requires a serviceability check. No additional validation will be performed by the service.
Serviceability lookup is only applicable to the following On Demand products:
Requests for other products will not be serviceable
HTTP Response Code: 200
HTTP Response Code: 200
HTTP Response Code: 400
| Element Name | Description | Optional / Mandatory | Type |
|---|---|---|---|
| product_id | The unique code of the eligible On Demand product to lookup serviceability for. Valid values are: TON, SAT, AFT, TONID, SATID, AFTID. | Mandatory | String |
| from | The from location of the serviceability request. | Mandatory | |
| state | The state code for the from location. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA. | Mandatory | String |
| postcode | The postcode for the from location. | Mandatory | String |
| suburb | The suburb for the from location. | Mandatory | String |
| to | The to location of the serviceability request. | Mandatory | |
| state | The state code for the to location. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA. | Mandatory | String |
| postcode | The postcode for the to location. | Mandatory | String |
| suburb | The suburb for the to location. | Mandatory | String |
| Element Name | Description | Type |
|---|---|---|
| results | The list of results for the serviceability lookup. There will be one result for each lookup in the request. | List |
| product_id | The unique code of the eligible On Demand product that the serviceability lookup result is for. Valid values are: TON, SAT, AFT, TONID, SATID, AFTID. | String |
| from | The from location of the serviceability request. | |
| state | The state code for the from location. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA. | String |
| postcode | The postcode for the from location. | String |
| suburb | The suburb for the from location. | String |
| to | The to location of the serviceability request. | |
| state | The state code for the to location. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA. | String |
| postcode | The postcode for the to location. | String |
| suburb | The suburb for the to location. | String |
| serviceable | Whether or not the requested to and from locations are serviceable by the requested product. | Boolean |
| errors | The list of errors that caused the lookup result to be unserviceable. | List |
| errors | The combined list of all the lookup results' errors. | List |
| code | The code associated with the error. | String |
| name | The name category for the error. | String |
| message | The human readable error message. | String |
| field | The request field that is in error. | String |
| Element Name | Description | Type | Length |
|---|---|---|---|
| errors | The error codes and descriptions related to the action attempted. | Array | |
| code | The code associated with the error. | String | |
| name | The name category for the error. | String | |
| message | The human readable error message. | String | |
| context | A map of values that attempts to highlight important information that may have caused the error. This may or may not be populated depending on the type of error. | Map |
| Code | Name | Example Message |
|---|---|---|
| 40002 | JSON_MANDATORY_FIELD_MISSING | The input request is missing the mandatory field with the name <field name>. Please resubmit the request including the required fields and values. |
| 82000 | UNSERVICEABLE_INVALID_STATE_COMBINATION | The from and to state are required to be the same for product <product id>. |
| 82001 | UNSERVICEABLE_TO_ADDRESS | The requested to address <suburb postcode state> is not supported by product <product id>. |
| 82002 | UNSERVICEABLE_FROM_ADDRESS | The requested from address <suburb postcode state> is not supported by product <product id>. |