SubmitAddressCheckV2

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.

Can be accessed with a POST against this end point: https://ws.di.no/ws/json/addressCheck/v-2/submit

SubmitAddressCheckRequest

Field
Description
Example
Data typeSize
Count
productProduct name for the unit.

BREV

String<= 101
customerSystemName of the customer system for the unit.

STRAA

String<= 51
batchIdClient-side identifier for the unit (may be empty). String-1
requireExactMatch

Whether an exact match on a customer address was required to mark it as supported.

Is false by default

falseboolean<= 50-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. 

Is false by default 

falseboolean<= 50-1
customerAddress

Describes a customer address to be checked for coveage.
See detailed description of the addressCoverage entity below.

 --1 - 10'000

CustomerAddress

Field
Description
Example
Data typeSize
Count

customerId

Customer identifier. Must be unique within the customerSystem.

 

String371
date

The date of when the product arrives in geolocation 1, before delivery of the parcel to different parts of norway. This is values is optional.

Specify only when time of delivery is known and the date.

 Date (YYYY-MM-DD)100 - 1
customerName

Customer name.

Pedersen Tor

String<= 601
countryCodeThe country of the address.

NO

String21
postalNameCity / place of the address.

Oslo

String<= 301
zipCodeZip code of the address.2500, 186 (leading zeros are stripped, this is postal code "0186" in Norway)Integer51
address

Customer address.

This can include street, house number, entrance and appartment number.

Christian Krohgs gate 54 B H0204String<= 601
co

CO address of the customer, if any.

 String<= 2550 - 1

SubmitAddressCheckResponse

Field
Description
Example
Data typeSize
Count
uuid

Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV2) action.

388f70cd-3e0c-4be6-a51a-35f32e7e96d9

UUID (String)361
status

Describes the current status of the unit.

Processing states
Error states

QUEUED

REJECTED_BUSY

INPROGRESS

 

See more detailed descriptions of the states below.

INPROGRESS

String6 - 131
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.

120Integer-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.