List connected providers
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/shipping/providers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bitbybit.studio/customer/api/open/v1/shipping/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bitbybit.studio/customer/api/open/v1/shipping/providers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/shipping/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"code": "gosend",
"name": "GoSend",
"connected": true,
"capabilities": [
"calculate_fee",
"cancel_booking"
],
"description": "Gojek instant motorcycle/car delivery within select Indonesian cities. Best for same-day intra-city shipments."
},
{
"code": "kirimin_aja",
"name": "KiriminAja",
"connected": true,
"capabilities": [
"calculate_fee",
"coverage_lookup",
"create_booking",
"cancel_booking",
"tracking"
],
"description": "Aggregator that exposes 12+ Indonesian couriers (JNE, J&T, SiCepat, …) plus on-demand instant via GoSend, Grab Express, Borzo."
},
{
"code": "ride_blitz",
"name": "RideBlitz",
"connected": false,
"capabilities": [
"calculate_fee",
"create_booking",
"cancel_booking",
"tracking"
],
"description": "Bali- & Java-focused electric-fleet instant courier with hourly SLAs."
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Providers
List shipping providers
Return all shipping providers the bitbybit platform integrates with, including whether your company has each one connected and the capability set each provider supports. Use this to render a provider picker in your UI.
GET
/
shipping
/
providers
List connected providers
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/shipping/providers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bitbybit.studio/customer/api/open/v1/shipping/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bitbybit.studio/customer/api/open/v1/shipping/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bitbybit.studio/customer/api/open/v1/shipping/providers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/shipping/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"code": "gosend",
"name": "GoSend",
"connected": true,
"capabilities": [
"calculate_fee",
"cancel_booking"
],
"description": "Gojek instant motorcycle/car delivery within select Indonesian cities. Best for same-day intra-city shipments."
},
{
"code": "kirimin_aja",
"name": "KiriminAja",
"connected": true,
"capabilities": [
"calculate_fee",
"coverage_lookup",
"create_booking",
"cancel_booking",
"tracking"
],
"description": "Aggregator that exposes 12+ Indonesian couriers (JNE, J&T, SiCepat, …) plus on-demand instant via GoSend, Grab Express, Borzo."
},
{
"code": "ride_blitz",
"name": "RideBlitz",
"connected": false,
"capabilities": [
"calculate_fee",
"create_booking",
"cancel_booking",
"tracking"
],
"description": "Bali- & Java-focused electric-fleet instant courier with hourly SLAs."
}
]
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Authorizations
API key for authentication. Create one in Settings > Developer. The key must have the BITCRM product scope and an orders resource scope; required action depends on the endpoint (READ, WRITE, or DELETE).
Response
Successful response.
Show child attributes
Show child attributes
⌘I

