Submits a batch of customer addresses to check for coverage.
The caller will get a handle, called a UUID, back to refer to the batch when invoking FetchAddressCheckV2.
SubmitAddressCheckRequest
Field | Description | Example | Data type | Size | Count |
|---|---|---|---|---|---|
| product | Product name for the unit. | BREV | String | <= 10 | 1 |
| customerSystem | Name of the customer system for the unit. | STRAA | String | <= 5 | 1 |
| batchId | Client-side identifier for the unit (may be empty). | Â | String | - | 1 |
| customerAddress | Describes a customer address to be checked for coveage. | Â | - | - | 1 - 10'000 |
CustomerAddress
Field | Description | Example | Data type | Size | Count |
|---|---|---|---|---|---|
ReferenceId | Customer identifier. Must be unique within the customerSystem. | Â | String | 37 | 1 |
| Date | The date of when the product should be delivered to local terminal. This is values is optional. Specify only when time of delivery is known and the date. | Â | Date (YYYY-MM-DD) | 10 | 0 - 1 |
| customerName | Customer name. | Pedersen Tor | String | <= 60 | 1 |
| countryCode | The country of the address. | NO | String | 2 | 1 |
| postalName | City / place of the address. | Oslo | String | <= 30 | 1 |
| zipCode | Zip code of the address. | 2500, 186 (leading zeros are stripped, this is postal code "0186" in Norway) | Integer | 5 | 1 |
| address | Customer address. This can include street, house number, entrance and appartment number. | Christian Krohgs gate 54 B H0204 | String | <= 60 | 1 |
| co | CO address of the customer, if any. | Â | String | <= 255 | 0 - 1 |
SubmitAddressCheckResponse
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 | ||||||
| status | Describes the current status of the unit.
See more detailed descriptions of the states below. | INPROGRESS | String | 6 - 13 | 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 provide reasonable min, max and default values for the delay. | 120 | Integer | - | 1 |
Status codes
The service will return one of the below status codes.
QUEUED
This processing states means that the batch has been received by service, and it is waiting to be processed.
INPROGRESS
This processing states means that the batch has been received by the service and is currently being processed.
REJECTED_BUSY
This error state means that the system is overloaded, and that the processing queue is full. Try again later.
Â