...
Field | Description | Example | Data type | Size | Count | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| uuid | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV2) action. | 388f70cd-3e0c-4be6-a51a-35f32e7e96d9 | UUID (String) | 36 | 1 | |||||||||||||||
| nextAction | Describes what the client should do next:
| STOP | String | 4 | 6 | 1 | |||||||||||||||
| statusresultStatus | Describes the current status of the unit.
Terminal statuses are all result states and error states. See more detailed descriptions of the states below. | INPROGRESS | String | 6 - 28 | 1 | |||||||||||||||
| secondsDelay | A hint from the server that may be provided if the server known when the status of the unit is likely to change. Defaults to two minutes. The client should also ensure reasonable min, max and default values for the delay on their end. | 120 | Integer | Â | 1 | |||||||||||||||
| product | Product name for the unit. | AFM | String | 10 | 1 | |||||||||||||||
| customerSystem | Name of the customer system for the unit. | AFT | String | 5 | 1 | |||||||||||||||
| batchId | Client-side identifier for the unit (may be empty). | Â | String | - | 1 | |||||||||||||||
| skipRouteCheck | Â | Â | Â | Â | Â | |||||||||||||||
| requireExactMatch | Â | Â | Â | Â | Â | |||||||||||||||
| addressCoverage | Describes a customer, whether his/her address is supported, and gives transport information if supported. Whether there are zero or more address coverage items depends on the nextAction field. | Â | - | - | 0 - 10'000 |
...
Field | Description | Example | Data type | Size | Count | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| referenceId | Customer identifier. Must be unique within the customerSystem. | Â | String | 37 | 1 | ||||||
| date | Estimated distribution date by carrier. | 2016-06-01 | Date (YYYY-MM-DD) | 10 | 1 | ||||||
| supportedByCarrier | Whether the customer address is covered by carrier. | true | Boolean | 4 | 5 | 1 | ||||||
| geoLocation | Describes the geographical area. Current values are 1, 2 and 3. | 1 | Integer | 1 | 0 - 1 | ||||||
| authority | Who produced this information | Â | Â | Â | 0 - 1Â | ||||||
| company | Name of the qualifying distribution company. | SDØ | String | <= 5 | 0 - 1 | ||||||
| transport | Main car number. | 8500 | Integer | - | 0 - 1 | ||||||
| subTransport | Sub car name, if any. | Some name. | String | - | 0 -1 | ||||||
| routeNo | routeNr | Route number of the covering route. | 21618 | String | 10 | 0 - 1 | |||||
| routeName | Â | Â | Â | Â | Â | ||||||
| addrSeq | Address sequence defining sorting on the associated route. | 51 | Integer | 3 | 0 - 1 | sortKeyKey that can be used to sort the addresses in the sequence they should be packaged. Key will contain several geographical parts like SortingLocation, Distribution Company, Transport, Route, Address sequence. The exact format will be defined at a later stage. | 003001234500123401234 | TBD | TBD | 0-1 | |
| deliveryPointId | Numeric identifier for the delivery point found for the customer address. Typically fed back into the source system to speed up subsequent processes, for instance parcel creation. | 6734687 | Integer | - | 0 - 1 | ||||||
| transport | Main car number. | 8500 | Integer | - | 0 - 1 | ||||||
| subTransport | Sub car name, if any. | Some name. | String | - | 0 -1 | ||||||
| location | Name / address of the pick-up point. | Rostedsgate 8 | varchar | 60 | 0 - 1 | ||||||
| locationDirections | Directions associated with the pick-up point. | Free text. | varchar | 60 | 0 -1 | ||||||
| sortKey | Key that can be used to sort the addresses in the sequence they should be packaged. Key will contain several geographical parts like SortingLocation,Distribution Company, Transport, Route, Address sequence. The exact format will be defined at a later stage. | 003001234500123401234 | TBD | TBD | 0-1 | ||||||
| linkedAddress | Â | Â | - | - | ? |
linkedAddress
...