Versions Compared

Key

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

...

Field
Description
Example
Count
customerId

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

 

1
supportedByCarrier

Whether the customer address is covered by carrier.

true

1
authority

The authority / source system that made the decision about the customer address being supported by carrier or not.

The value NOT_PROCESSED indicates that the item for some reason wasn't processed by any authority (due to an error state). These will have supportedByCarrier unconditially set to false.

DI

1
companyName of the qualifying distribution company.

MANU

0 - 1
transportMain car number.8500 Some name0 - 1
subTransportSub car name, if any.Some name.0 -1
rotueNoRoute number of the covering route.5234430 - 1
routeName

Name of covering route.

Keskusta 201 0 - 1
addrSeqAddress sequence defining sorting on the associated route.510 - 1
deliveryPointIdNumeric 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.67346870 - 1
locationName / address of the pick-up point.Patamäenkatu 90 - 1
locationDirectionsDirections associated with the pick-up point.Free text.0 -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.