Geo Checkpoints

Retrieve geographic checkpoints such as toll gates, border crossings, and vignette control points. Checkpoints can be linked to the vignette tickets sold for that location, which lets you surface the right product when a customer plans a route.

List Checkpoints

text
GET /products/geo/checkpoints

API key only, no signature required.

Query Parameters

NameTypeRequiredDescription
countrystringNoTwo-letter country ISO code (e.g., SI)
typestringNoCheckpoint type discriminator
minLatnumberNoBounding box: minimum latitude
maxLatnumberNoBounding box: maximum latitude
minLngnumberNoBounding box: minimum longitude
maxLngnumberNoBounding box: maximum longitude
langstringNoLanguage code for localized text
pageintegerNoPage number (default: 1)
limitintegerNoItems per page (default: 50)

Example Request

GET/v2/partners/products/geo/checkpoints
curl "https://api.vignetim.com/v2/partners/products/geo/checkpoints" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

json
{
	"data": [
		{
			"id": "9a8b7c6d-5e4f-3210-fedc-ba0987654321",
			"countryIsocode": "SI",
			"type": "toll_gate",
			"latitude": 46.0569,
			"longitude": 14.5058,
			"title": {
				"en": "Ljubljana Ring Toll Point",
				"sl": "Cestninska tocka Ljubljana"
			},
			"description": {
				"en": "Vignette required beyond this point."
			},
			"infoText": {
				"en": "Applies to all vehicles up to 3.5t."
			},
			"iconType": "toll",
			"color": "#E53935",
			"productType": "ticket",
			"sortOrder": 10,
			"ticketIds": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
		}
	],
	"metadata": {
		"total": 87,
		"page": 1,
		"limit": 50,
		"totalPages": 2,
		"environment": "LIVE"
	}
}

Checkpoint Object

FieldTypeDescription
idUUIDCheckpoint ID
countryIsocodestringCountry the checkpoint belongs to
typestringCheckpoint type discriminator (optional)
latitudenumberLatitude
longitudenumberLongitude
titleobjectLocalized title map keyed by locale code
descriptionobjectLocalized description map
infoTextobjectLocalized info text map (optional)
iconTypestringIcon hint for map rendering (optional)
colorstringDisplay color (optional)
productTypestringRelated product type hint (optional)
sortOrderintegerSuggested display ordering
ticketIdsstring[]IDs of vignette tickets sold for this checkpoint (optional)