Biklo for developersTESTsandbox-api.biklo.comchange

List pickup points

GET/v1/company/pickup-points

scope company.read

The addresses a courier collects from. A pickup point is also the origin for drop-shipped orders and the address returns travel back to.

Response#

FieldTypeDescription
countintegerHow many pickup points.
dataarrayYour collection locations. An order can ship from one of these instead of your own address; the RETURN address stays your seller address either way.
data[].idintegerThe pickup point id.
data[].labelstringYour name for it.
data[].typestring|nullWhat kind of location it is.
data[].addressobjectWhere it is. This is a real collection address a courier will drive to.
data[].address.streetstring|nullStreet and number.
data[].address.citystring|nullCity name, as the courier holds it.
data[].address.countystring|nullCounty name.
data[].address.postal_codestring|nullPostal code.
data[].address.country_codestring|nullISO-2.
data[].contactobjectWho the courier calls here.
data[].contact.phonestring|nullPhone.
data[].contact.emailstring|nullEmail.
data[].is_defaultbooleanWhether orders collect from here unless told otherwise.
data[].is_activebooleanWhether it can currently be used.

Example

{
    "count": 1,
    "data": [
        {
            "id": 11,
            "label": "Barcelona warehouse",
            "type": "warehouse",
            "address": {
                "street": "Carrer Gran 42",
                "city": "Barcelona",
                "county": "Barcelona",
                "postal_code": "08001",
                "country_code": "ES"
            },
            "contact": {
                "phone": "+34600000000",
                "email": "[email protected]"
            },
            "is_default": true,
            "is_active": true
        }
    ]
}

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/company/pickup-points" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/company/pickup-points');

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/company/pickup-points");

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

import requests

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

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/company/pickup-points", {
  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/company/pickup-points"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

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