Skip to main content
GET
List shipments

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