Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Fetches the results for the specified address check request.

...

Field
Description
Example
Data typeSize
Count
referenceId

Customer identifier. Must be unique within the customerSystem.


String371
dateEstimated distribution date by carrier.2016-06-01Date (YYYY-MM-DD)101
supportedByCarrier

Whether the customer address is covered by carrier.

true

Boolean4 | 51
geoLocationDescribes the geographical area. Current values are 1, 2 and 3.1Integer10 - 1
authorityWho produced this information



companyName of the qualifying distribution company.

SDØ

String<= 50 - 1
routeNrRoute number of the covering route.21618String100 - 1
routeName




addrSeqAddress sequence defining sorting on the associated route.51Integer30 - 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.

6734687Integer-0 - 1
transportMain car number.8500Integer-0 - 1
subTransportSub car name, if any.Some name.String-0 - 1
locationName / address of the pick-up point.Rostedsgate 8varchar600 - 1
locationDirectionsDirections associated with the pick-up point.Free text.varchar600 - 1
sortKey

Key that can be used to sort the addresses in the sequence they should be packaged. Key will contain several geographical parts and sorting terms:

  • getTransportNetId(),
  • ac.getTransportCompanyId(),
  • ac.getPreTransportCarSorting(),
  • ac.getMainCarSorting(),
  • ac.getSubCarSorting(),
  • ac.getDeliveryPointSorting(),
  • ac.getRouteId(),
  • ac.getAddrSeq()

"%05d%05d%05d%05d%05d%05d%07d%05d"


In the V3 version the string consists of these fields:

  • ac.getHandOverLocationZip()
  • ac.getTransport()
  • ac.getDeliveryPointId()
  • ac.getRouteId()
  • ac.getAddrSeq()

"%05d%010d%010d%010d%05d"


In the V5 version the string consists of these fields:

  • ac.getHandOverLocationZip()
  • ac.getTransport()
  • ac.getDeliveryPointId()
  • ac.getRouteName()
  • ac.getAddrSeq()

"%05d%010d%010d%010d%05d"

003001234500123401230001212345671234512345Integer42

0 - 1

linkedAddress

--?
transportDescriptionA string that describes the transport information, on the format: XXXX-yy/ZZZZ-øø-grenbil1 x025117x500

XXXX - Main car number on the pre transport transport
yy - Delivery sequence number on XXXX

ZZZZ - Main car number
øø - Delivery sequence number on ZZZZ

grenbil1 - Name of subcar

x025117 - x + Routenumber
x500 - x + sequence on route

XXXX-yy/ZZZZ-øø-grenbil1 x025117x500

String360 - 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 but deliveryPointId may be set to aid troubleshooting.

%05d%010d%010d%010d%05d