TBDSubmits 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Ā FetchAddressCheckV1.
SubmitAddressCheckRequest
Field | Description | Example | Count |
|---|---|---|---|
| product | Product name for the unit. | AFM | 1 |
| customerSystem | Name of the customer system for the unit. | AFT | 1 |
| batchId | Client-side identifier for the unit (may be empty). | 1 | |
| skipRouteCheck | Whether the route check shall be skipped for the customer addreses in the unit. Setting this to true means that supportedByCarrier will only tell if there was a match on the address.Ā | false | 1 |
| requireExactMatch | Whether an exact match on a customer address was required to mark it as supported. | false | 1 |
| transportDate | The transport date used by the system to obtain the address coverage results.Ā Format isĀ yyyy-mm-dd. This information is quality-enhancing data and is optional. If unspecified the nearest Wednesday will be used. | 2015-12-21 | 0 - 1 |
| deliveryDate | The delivery date used by the system to obtain the address coverage results. Format isĀ yyyy-mm-dd. This information is quality-enhancing data and is optional. If unspecified the nearest Wednesday will be used. | 2015-12-22 | 0 - 1 |
| customerAddress | Describes a customer address to be checked for coveage. | 1 - 10'000 |
CustomerAddress
Field | Description | Example | Count |
|---|---|---|---|
| delivererMask | A mask that gives processing instructions to the service. The two mechanisms used are to tell that the address shall not be supported, and to tell the system that only specific distribution companies are qualified. The mappings between a letter and a distribution company are specified per customer system. | AD (letter A + letter D) | 1 |
| customerId | Customer identifier. | 1 | |
| customerName | Customer name. | 1 | |
| countryCode | The country of the address. | FI | 1 |
| postalName | City / place of the address. | Helsinki | 1 |
| zipCode | Zip code of the address. | 00100 | 1 |
| address | Customer address. This can include street, house number, entrance and appartment number. | Esplanadi 5 A 5 | 1 |
| co | CO address of the customer, if any. | 0 - 1 |
SubmitAddressCheckResponse
Field | Description | Example | Count | ||||||
|---|---|---|---|---|---|---|---|---|---|
| uuid | Unique identifier for the processing unit, obtained in the response for theĀ SUBMIT (SubmitAddressCheckV1)Ā action. | 388f70cd-3e0c-4be6-a51a-35f32e7e96d9 | 1 | ||||||
| status | Describes the current status of the unit.
See more detailed descriptions of the states below. | INPROGRESS | 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 | 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.
Files
| View file | ||||
|---|---|---|---|---|
|
| View file | ||||
|---|---|---|---|---|
|