Versions Compared

Key

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

...

This terminal result state means that the batch has been processed and that the partial results are included in the response. Partial means that one or more processing units (authorities, or source systems, ) were unavailable and/or timed out. This means that the items associated with that unit all have supportedByCarrier unconditionally set to false.

...

This can take place as long as the batch hasn't expired. If the batch has expired, the service will return INVALID_UUID.

REJECTED_BUSY

This terminal error state means that the system is overloaded, and that the processing queue is full. Try again later.

...

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
authorityThe authority / source system that made the decision about the customer address being supported by carrier or not.

DI

1
companyName of the qualifying distribution company.

MANU

0 - 1
transportMain car number.85000 - 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
locationWhat is this precisely?Name / address of the pick up point.Patamäenkatu 90 - 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.