...
Field | Description | Example | Count |
---|---|---|---|
customerId | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV1) action. |
| 1 |
supportedByCarrier | Whether the customer address is covered by carrier. | true | 1 |
authority | The authority / source system that made the decision about the customer address being supported by carrier or not. The value NOT_PROCESSED indicates that the item for some reason wasn't processed by any authority (due to an error state). These will have supportedByCarrier unconditially set to false. | DI | 1 |
company | Name of the qualifying distribution company. | MANU | 0 - 1 |
transport | Main car number. | 8500 Some name | 0 - 1 |
subTransport | Sub car name, if any. | Some name. | 0 -1 |
rotueNo | Route number of the covering route. | 523443 | 0 - 1 |
routeName | Name of covering route. | Keskusta 201 | 0 - 1 |
addrSeq | Address sequence defining sorting on the associated route. | 51 | 0 - 1 |
location | Name / address of the pick-up point. | Patamäenkatu 9 | 0 - 1 |
locationDirections | Directions associated with the pick-up point. | Free text. | 0 -1 |
The field supportedByCarrier determines whether the fields with count 0 - 1 will be present (true) or not, except for when skipRouteCheck has been set to true. In that case, there will be no route information even though supportedByCarrier may be true.