List shipments
Lists your shipments, newest first, with filters and per-status counts. Unpaid shipments are never listed. Use it for an order dashboard, or to find a shipment after a timeout.
data.count covers all your shipments in the startDate–endDate range and ignores the other
filters. count.RTS adds up RTS_CONFIRMED and RTS_TRANSIT.
Requires the READ_ORDER permission.
bearerAuthAuthorizationBearer <token>An access token from the OAuth2 client-credentials grant. Exchange your API key
(client_id + client_secret) at the token endpoint and send
Authorization: Bearer <access_token>.
search?stringMatches shipment code, airway bill, order code, or receiver name or phone (partial, case-insensitive).
length <= 100orderCode?stringOnly shipments of this order (partial match).
length <= 50courierCode?stringOnly shipments with this courier. Case-insensitive.
courierServiceId?integerOnly shipments with this courier service (id from List courier services).
1 <= valuestatus?stringOnly shipments in this status.
"WAITING_FOR_PAYMENT""CONFIRMED""PENDING_PICKUP""PENDING_DROPOFF""IN_TRANSIT""PROBLEM_SHIPMENT""DELIVERED""CANCELLED""RTS_CONFIRMED""RTS_TRANSIT""RTS_PROBLEM_SHIPMENT""RTS_DELIVERED"startDate?stringCreated at or after this time. ISO 8601; include an offset, for example 2026-11-01T00:00:00+07:00.
date-timeendDate?stringCreated at or before this time. ISO 8601; include an offset.
date-timesource?stringOnly shipments created through this channel. API orders are B2B; dashboard orders are CLIENT_DASHBOARD.
"B2B""CLIENT_DASHBOARD""WEB""ANDROID""IOS""SHOP"limit?integerItems per page. Values above 100 are capped at 100.
1 <= value <= 10025cursor?stringThe nextCursor from the previous page. Omit for the first page.
One page of shipments.
application/json- response
statusCode*integermessage*stringdata*curl -X GET 'https://sandbox-api.fastrac.example/b2b/shipments'{ "statusCode": 200, "message": "Shipments retrieved.", "data": { "count": { "PENDING_PICKUP": 3, "PENDING_DROPOFF": 1, "IN_TRANSIT": 12, "DELIVERED": 248, "CANCELLED": 7, "RTS": 2 }, "shipments": [ { "id": 18452, "code": "SHP-261120-K9M2Q7", "orderId": 9021, "orderCode": "FSO-261120-A1B2C3", "source": "B2B", "userId": 512, "userEmail": "[email protected]", "airwayBill": "CM12345678901", "trackingUrl": null, "courierCode": "JNE", "courierName": "JNE", "courierServiceId": 12, "courierServiceCode": "REG", "courierServiceName": "JNE Reguler", "status": "IN_TRANSIT", "createdAt": "2026-11-20T02:05:11.000Z", "recipient": { "name": "Rina Kartika", "phoneNumber": "081298765432", "fullAddress": "Jl. Braga No. 8, Braga, Sumur Bandung, Kota Bandung" }, "cursor": "MTg0NTI=" } ], "nextCursor": "MTg0NTI=" }}Was this page helpful?
Cancel an order POST
Cancels every shipment of an order and refunds what was paid for each. Shipments that are already cancelled are skipped. Shipments not yet handed to the courier are cancelled immediately; for dispatched shipments the courier is asked to cancel first, and a courier refusal is returned as an error. The order is refused as a whole if any shipment is already `DELIVERED`. Shipments are cancelled one by one, so if an error occurs part-way, earlier shipments stay cancelled. To cancel a single shipment, use **Cancel a shipment**. Requires the `READ_ORDER` permission.
Retrieve a shipment GET
Returns everything about one shipment: status, courier service, airway bill, sender and receivers with their region names, packages (with measured weight once the courier reweighs), status history and driver details. This reads stored data; to ask the courier for the latest status, use **Track a shipment**. Requires the `READ_ORDER` permission. You can only read your own shipments.