Get shipment
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id}"
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/shipments/{id}', 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/shipments/{id}",
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/shipments/{id}"
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/shipments/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id}")
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": {
"id": "<string>",
"orderId": "<string>",
"providerLabel": "<string>",
"name": "<string>",
"fee": 123,
"currency": "<string>",
"serviceName": "<string>",
"selectedExpedition": "<string>",
"selectedDelivery": "<string>",
"courierGroup": "<string>",
"bikeFuelType": "<string>",
"pickupSchedule": "2023-11-07T05:31:56Z",
"storeLocationId": "<string>",
"sender": {
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": "<string>",
"notes": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"kecamatan": "<string>",
"kecamatanId": 123,
"kelurahan": "<string>",
"kelurahanId": 123,
"coordinates": {
"lat": 0,
"lng": 0
}
},
"delivery": {
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": "<string>",
"notes": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"kecamatan": "<string>",
"kecamatanId": 123,
"kelurahan": "<string>",
"kelurahanId": 123,
"coordinates": {
"lat": 0,
"lng": 0
}
},
"package": {
"weight": 123,
"length": 123,
"width": 123,
"height": 123,
"itemName": "<string>",
"itemType": "<string>",
"itemValue": 123,
"itemQty": 123,
"notes": "<string>"
},
"driver": {
"name": "<string>",
"phone": "<string>",
"photo": "<string>",
"licensePlate": "<string>"
},
"insurance": true,
"insuranceFee": 123,
"insuranceAmount": 123,
"discountAmount": 123,
"discountPercentage": 123,
"distance": 123,
"trackingUrl": "<string>",
"awb": "<string>",
"orderNo": "<string>",
"bookingId": "<string>",
"pickupNumber": "<string>",
"paymentId": "<string>",
"paymentStatus": "<string>",
"statusCode": 123,
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"cancelledSource": "<string>",
"eventTimestamp": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Shipment not found"
}
}Shipments
Get shipment
Retrieve one shipment by ID.
GET
/
shipping
/
shipments
/
{id}
Get shipment
curl --request GET \
--url https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id}"
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/shipments/{id}', 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/shipments/{id}",
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/shipments/{id}"
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/shipments/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id}")
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": {
"id": "<string>",
"orderId": "<string>",
"providerLabel": "<string>",
"name": "<string>",
"fee": 123,
"currency": "<string>",
"serviceName": "<string>",
"selectedExpedition": "<string>",
"selectedDelivery": "<string>",
"courierGroup": "<string>",
"bikeFuelType": "<string>",
"pickupSchedule": "2023-11-07T05:31:56Z",
"storeLocationId": "<string>",
"sender": {
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": "<string>",
"notes": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"kecamatan": "<string>",
"kecamatanId": 123,
"kelurahan": "<string>",
"kelurahanId": 123,
"coordinates": {
"lat": 0,
"lng": 0
}
},
"delivery": {
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": "<string>",
"notes": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"kecamatan": "<string>",
"kecamatanId": 123,
"kelurahan": "<string>",
"kelurahanId": 123,
"coordinates": {
"lat": 0,
"lng": 0
}
},
"package": {
"weight": 123,
"length": 123,
"width": 123,
"height": 123,
"itemName": "<string>",
"itemType": "<string>",
"itemValue": 123,
"itemQty": 123,
"notes": "<string>"
},
"driver": {
"name": "<string>",
"phone": "<string>",
"photo": "<string>",
"licensePlate": "<string>"
},
"insurance": true,
"insuranceFee": 123,
"insuranceAmount": 123,
"discountAmount": 123,
"discountPercentage": 123,
"distance": 123,
"trackingUrl": "<string>",
"awb": "<string>",
"orderNo": "<string>",
"bookingId": "<string>",
"pickupNumber": "<string>",
"paymentId": "<string>",
"paymentStatus": "<string>",
"statusCode": 123,
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"cancelledSource": "<string>",
"eventTimestamp": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Shipment not found"
}
}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).
Path Parameters
Response
Successful response.
Show child attributes
Show child attributes
⌘I

