Developer documentation

Distribution coverage

get https://app.iteras.dk/api/distributioncoverage/

The /api/distributioncoverage/ endpoint tells you whether the distribution integrations set up on your account deliver to a given address.

Parameters

  • address string required
    The formatted multi-line address without name and country, e.g. Herningvej 23\n8800 Viborg.
  • country string required
    The two-letter country code, e.g. DK.
GET /api/distributioncoverage/?address=Herningvej%2023%0A8800%20Viborg&country=DK HTTP/1.1
{
  "status": "covered"
}

A missing required parameter returns a plain text HTTP 404 error.

Return value

The status is one of five values:

  • covered - the distributor has the address on its list and delivers to it on at least one weekday.

  • known - the distributor knows the address but does not deliver to it.

  • unknown - the address lies inside the area the distributor covers, but was not found there. Likely a spelling error or a house number that does not exist.

  • notcovered - the address is outside the area the distributor covers.

  • notavailable - your account has no distribution integration that matches on addresses, so there is nothing to answer from.

In case you have multiple distributors, an address counts as covered as soon as one of your distributors delivers to it, so a covered address can still be out of reach for a particular product if coverage differs between them.