Skip to main content
PATCH
/
shipping
/
shipments
/
{id}
curl --request PATCH \
  --url https://api.bitbybit.studio/customer/api/open/v1/shipping/shipments/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "shippingStatus": "delivered",
  "awb": "MANUAL-001"
}
'
{
  "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": "VALIDATION_ERROR",
    "message": "origin.districtId is required for KiriminAja Express"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Shipment not found"
  }
}

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

Path Parameters

​
id
string
required

Body

application/json

All fields optional — patch semantics.

​
name
string
Maximum string length: 255
​
fee
number<double>
Required range: x >= 0
​
shippingStatus
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
​
serviceName
string
​
serviceType
enum<string>

Service category. INSTANT = on-demand intra-city; EXPRESS = scheduled inter-city.

Available options:
INSTANT,
EXPRESS
​
selectedExpedition
string
​
selectedDelivery
string
​
courierGroup
string
​
vehicleType
enum<string>

Vehicle requested for the pickup. TWO_WHEEL = motorcycle, FOUR_WHEEL = car.

Available options:
TWO_WHEEL,
FOUR_WHEEL
​
bikeFuelType
enum<string>

RideBlitz fuel preference. green = electric fleet (lower emissions, may have limited availability).

Available options:
regular,
green
​
packageHandover
enum<string>

How the merchant hands the package to the carrier. PICKUP = courier picks up from the store, DROPOFF = merchant drops off at carrier hub.

Available options:
PICKUP,
DROPOFF
​
pickupSchedule
string<date-time>
​
sender
object
​
delivery
object
​
package
object
​
insurance
boolean
​
insuranceFee
number<double>
Required range: x >= 0
​
insuranceAmount
number<double>
Required range: x >= 0
​
discountAmount
number<double>
Required range: x >= 0
​
discountPercentage
number<double>
Required range: 0 <= x <= 100
​
distance
number<double>
Required range: x >= 0
​
trackingUrl
string<uri>
​
awb
string
​
orderNo
string
​
bookingId
string
​
pickupNumber
string
​
paymentId
string
​
paymentStatus
enum<string>
Available options:
unpaid,
paid,
failed
​
statusCode
integer
​
cancellationReason
string
​
triggerBooking
boolean

When true, request pickup with the carrier after persisting this update. Same outcome as creating the shipment with autoBook: true.

Response

Updated.

​
data
object