Documentation

Status Code

Package status codes and their meanings from new packages to final delivery states including transit, attempt, and cancellation statuses

  1. New — The package has been created by the client and is waiting to be processed by the 3PL.
  2. Transit — The package is being processed by the 3PL and will be shipped according to the agreed SLA.
  3. Attempt — The package could not be delivered to the destination due to an issue (e.g., recipient unavailable, wrong address).
  4. Final — The package delivery process has ended (delivered, canceled, returned, or lost).

Status Flow

sequenceDiagram
    participant Client
    participant KiriminAja
    participant PG
    participant 3PL
    Client ->> KiriminAja: Request AWB (Both COD & Non-COD)
    KiriminAja -->> PG: Create Non-COD Payment (If Necessary)
    PG -->> KiriminAja: Confirm Payment (If any of Non-COD)
    KiriminAja -->> KiriminAja: Schedule Push AWB
    KiriminAja ->> 3PL: Create AWB (Pickup & Drop-Off)
    3PL ->> KiriminAja: Confirm AWB Created
    KiriminAja ->> Client: AWB Confirmed (Webhooks)

Entry State

Information

Entry State is the initial status when a new package is created by the client and waiting to be processed by the 3PL.

CodeDescription
100New package created by client
101Pickup requested
102Validated by pickup officer
103Picked up by KiriminAja driver
104Package received and validated at KiriminAja DC
105Waiting for 3PL pickup / waiting for AWB assignment

Shipment State

Information

Shipment State indicates that the package is in transit and being processed by the 3PL for delivery.

CodeDescription
106Package with courier / in transit
107Package reported by driver
110Pending direct pickup
152Re-delivery process / undelivery
210SOP violation / Over SLA
211Violation resolved
301Recipient refused the package
302Pickup canceled by seller
310Package rejected — recipient did not order
311Package rejected — recipient unwilling to pay
333Package destroyed by courier
350Pickup cancellation requested
401Return information from DC
402Arrived at KiriminAja warehouse
403Return request initiated
404Courier requested for return delivery to seller
405Return package rejected by seller
406Return package breach
500Package has issues
555Confiscated by Customs
701Package lost
702Package damaged
901Problematic package pickup
902Package issue at KiriminAja warehouse
903Issue on courier's side
904Return has issues
905Package data incomplete (Excel import)

Final State

Information

Final State indicates that the package delivery process has been completed or stopped due to various reasons.

CodeDescription
200Package delivered to recipient
300Package canceled by client
333Package destroyed by courier
400Package successfully returned
500Package has issues
555Confiscated by Customs
703Lost package claim resolved
704Damaged package claim resolved