Skip to main content
GET
/
shipping
/
shipments
List shipments
curl --request GET \
  --url https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments"

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', 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",
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"

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")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments")

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>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasNextPage": true
  }
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}

Authorizations

x-api-key
string
header
required

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).

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
type
enum<string>

Provider/courier code. gosend, kirimin_aja, and ride_blitz are externally integrated; jne is a passthrough placeholder; custom is for merchant-defined methods.

Available options:
gosend,
kirimin_aja,
ride_blitz,
jne,
custom
status
enum<string>

Unified shipping status. Some values are provider-specific (e.g. cancelled_by_blitz is RideBlitz, midmile_pickup_done is KiriminAja Express).

Available options:
confirmed,
allocated,
out_for_pickup,
picked,
out_for_delivery,
on_hold,
cancelled,
delivered,
rejected,
no_driver,
awaiting,
on_the_way_to_pickup,
delivering,
delivery_completed,
canceled,
processed_packages,
shipped_packages,
canceled_packages,
finished_packages,
returned_packages,
return_finished_packages,
created,
midmile_pickup_done,
midmile_pickup_failed,
arrived_blitz_hub,
allocation_failure,
pickup_started,
pickup_done,
pickup_failed,
pickup_failure,
dropoff_started,
dropoff_done,
dropoff_failed,
delivery_failure,
cancelled_by_blitz,
cancelled_by_business,
returned_to_business
orderId
string

Response

Successful response.

data
object[]
meta
object