Skip to main content
API docs by Redocly

Pickup Point Service ((dev))

Download OpenAPI specification:Download

Merchant-facing pickup point lookup API. Authenticated merchant context is required; no additional scope.

List pickup points

Search pickup points by postal code, city, name (≥3 chars), carrier, or carrier+carrier_id. Country defaults to FI when a search parameter is provided. Returns the simple/merchant response shape.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a pickup point by id

Returns a single pickup point in the simple/merchant response shape.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "public_name": {
    },
  • "description": {
    },
  • "address": "string",
  • "postalcode": "string",
  • "city": "string",
  • "country": "string",
  • "coordinates": [
    ],
  • "branch": "string",
  • "location_info": "string",
  • "type": "string",
  • "carrier_info": {
    }
}

Get a pickup point by carrier code and carrier-specific id

Singleton lookup of an active pickup point by carrier code and the carrier-specific ID (e.g. the nShift-ID for Posti). Returns the simple/merchant response shape. Merchant visibility rules apply; hidden pickup points return 404 to avoid leaking their existence.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "public_name": {
    },
  • "description": {
    },
  • "address": "string",
  • "postalcode": "string",
  • "city": "string",
  • "country": "string",
  • "coordinates": [
    ],
  • "branch": "string",
  • "location_info": "string",
  • "type": "string",
  • "carrier_info": {
    }
}

Search pickup points near an address

Find pickup points near a delivery address using geo-search. Applies an adaptive radius strategy: starts at radius_km (default 50 km) and expands to expanded_radius_km (default 100 km) when fewer than min_results (default 5) results are found. If geocoding fails or the geocoded location does not match the postal code area, a postcode-anchor fallback is used. Merchant visibility rules apply (include/exclude lists, carrier skip config). Returns the simple/merchant response shape.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json
address
required
string non-empty

Street address line.

postalcode
required
string non-empty

Postal code of the delivery address.

city
required
string non-empty

City of the delivery address.

country
string = 2 characters

ISO 3166-1 alpha-2 country code. Defaults to FI.

radius_km
number > 0

Initial search radius in km. Default: 50.

expanded_radius_km
number > 0

Expanded search radius in km, used when the initial radius returns fewer than min_results. Default: 100.

min_results
integer ( 0 .. 9007199254740991 ]

Minimum result count that triggers the expanded-radius pass. Default: 5.

max_results
integer ( 0 .. 9007199254740991 ]

Hard cap on returned results. Default: 50.

carriers
Array of strings

Carrier codes to include. Defaults to all known carriers: fi_posti, fi_matkahuolto, fi_schenker, postnord, budbee.

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "postalcode": "string",
  • "city": "string",
  • "country": "st",
  • "radius_km": 0,
  • "expanded_radius_km": 0,
  • "min_results": 9007199254740991,
  • "max_results": 9007199254740991,
  • "carriers": [
    ]
}

Response samples

Content type
application/json
{
  • "pickup_points": [
    ],
  • "execution_details": {
    }
}

Pickup point stats summary

Counts of active pickup points grouped by branch and by carrier.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "by_branch": {
    },
  • "by_carrier": {
    },
  • "total": 0
}