Biklo for developersTESTsandbox-api.biklo.comchange

One city, with postal codes

GET/v1/geo/cities/{id}

scope catalog.read

The postal codes are SUGGESTIONS for autofill. A code missing from this list is not invalid — roughly 7.5% of real codes are absent from our source, so never reject on absence.

Response#

FieldTypeDescription
idintegerThe city id.
namestringName in local script.
countyobjectThe county it sits in.
county.idintegerCounty id, for the county_id field on an address.
county.namestringCounty name.
county.codestringCounty code.
countryobjectThe country it sits in.
country.codestringISO-2.
country.namestringCountry name.
postal_codesstring[]Known postal codes for this city, as a CONVENIENCE for autocomplete.

Not supported Not a list to validate against. Roughly one code in thirteen that real users enter is missing from this data, so treating absence as invalid rejects correct addresses. Validate the FORMAT — GET /v1/geo/address-rules — and let the courier judge the rest.

Example

{
    "id": 1,
    "name": "Craiova",
    "county": {
        "id": 1,
        "name": "Dolj",
        "code": "DJ"
    },
    "country": {
        "code": "RO",
        "name": "Romania"
    },
    "postal_codes": [
        "200008",
        "200009",
        "200010"
    ]
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X GET "https://sandbox-api.biklo.com/v1/geo/cities/711" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/geo/cities/711');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://sandbox-api.biklo.com/v1/geo/cities/711");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.get(
    "https://sandbox-api.biklo.com/v1/geo/cities/711",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/geo/cities/711", {
  method: "GET",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY"
  }
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/geo/cities/711"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());