Documentation

Cancel Order Instant

Cancel an instant delivery shipment that has not yet been picked up

DELETE

Request Example

curl --location --request DELETE 'https://tdev.kiriminaja.com/api/mitra/v4/instant/pickup/void/NBL2-1705636897084' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}'

Response

{
  "status": true,
  "text": "success",
  "code": 0,
  "method": null,
  "result": {
    "payment": {
      "payment_id": "PID-1705636897",
      "amount": 35000,
      "status_code": 0,
      "qr_content": "some-random-qr-string",
      "pay_time": "2024-01-19T04:01:38.450035Z"
    },
    "packages": [
      {
        "awb": "GK-11-3120092",
        "order_id": "NBL2-1705636897084",
        "service": "gosend",
        "service_type": "instant",
        "status": 105,
        "live_track_url": null,
        "polyline": "jasn@_xo`TPwD@WwEm@iDa@mFo@a@M}K{AgEe@wAQmEi@y@MyBSwBWiC[iCSaGw@qAKmCOKAFwALqBCmAWwAw@}BeAqC_@gAqCKaAEUIKu@o@sCUo@Wg@c@s@GAIIGKAEk@_@g@YsBeAaEkB[Iu@EsGIiCE}@@wEEyFK_KUkQYyJQsIMmUe@iEE}JQ}FKuXe@oP[oLOqEK}KKsEGeAC{AC_BCGPQRMBI?QCOKCGEQBQFOLGVw@`@_AjA_Ej@wBTc@l@aERgDP{BJsD`@eGh@cEj@cE`@qERoAf@yEx@iHHiA@o@IyAIsAEi@EeADmAB_@\\eBBOICXuAr@qC^aAd@kAjAmC`AwBj@_AbAwAb@g@dA{@Dc@ASGQOKeAq@sAm@w@e@{GcDaAa@eAk@eAg@kAk@mHqD_CgAkBaAgD}AeG_DmFoCgAa@gAe@eDeBwDoByAs@mB_AsAq@{CyAsAq@uAu@eIcE{EcCuBaAkBy@iDcBqB_AcD}AmB{@gEsB_Ak@_Bu@KEf@cANY`CiFr@mAZs@?MIo@Bk@PoAJa@BMFMTSPMPQ^]^g@B[DkALyCDg@L@f@BbDD|@?pBDv@BAg@C}@G]E_ADOn@k@DuAHu@@KqAMWCB[",
        "origin": {
          "name": "Arfian",
          "address": "Wirobrajan, Kota Yogyakarta, Daerah Istimewa Yogyakarta, Indonesia",
          "phone": "081280045616",
          "latitude": -7.8032616,
          "longitude": 110.350244
        },
        "destination": {
          "name": "Arfian",
          "address": "Minomartani, Kec. Ngaglik, Kabupaten Sleman, Daerah Istimewa Yogyakarta, Indonesia",
          "phone": "081280045616",
          "latitude": -7.7349434,
          "longitude": 110.405355
        }
      }
    ]
  }
}

Response Reference

ParamDataTypeRemark
statusBooleanRequest result status
textStringResponse message
codeIntegerInternal response code
methodStringAPI method name (can be null)
resultObjectCancel result details

Result Object

ParamDataTypeRemark
paymentObjectPayment information
packagesArray of ObjectList of canceled package orders

Payment Object

ParamDataTypeRemark
payment_idStringPayment identifier
amountIntegerTotal payment amount
status_codeIntegerPayment status code
qr_contentStringQR payload / reference
pay_timeStringPayment time (ISO 8601)

Package Object

ParamDataTypeRemark
awbStringAir waybill number
order_idStringMerchant order ID
serviceStringCourier / service provider code
service_typeStringService type name/code
statusIntegerShipment status code
live_track_urlStringReal-time tracking URL (can be null)
polylineStringRoute polyline from provider (can be empty)
originObjectOrigin location details
destinationObjectDestination location details

Origin / Destination Object

ParamDataTypeRemark
nameStringContact name
addressStringFull address
phoneStringContact phone
latitudeNumberLatitude value
longitudeNumberLongitude value