OTEP JSON Home

Codebook

The complete OTEP coding standard — every status code, phase, internal bridge and external-standard mapping. Generated directly from the implementation, so it is always complete and accurate.

otep_version 0.1 · profile parcel

Phases

pre_shipmentpreparingpickupinboundin_custodytransitout_for_deliverydeliveredexceptionreturn

Source types & time types

self_deliverythird_party_deliverycarrier_label   actualestimatedscheduled

Status codes & external mappings

codephaseterminalpod EPCIS bizStepEPCIS dispositionONE RecordUN/CEFACT
information_submitted pre_shipment commissioning active BKD order_received
booking_confirmed pre_shipment commissioning active BKD booked
awaiting_pickup pre_shipment staging_outbound in_progress FOH ready_for_pickup
out_for_pickup pickup departing in_progress FOH pickup_en_route
picked_up pickup receiving in_progress RCS picked_up
pickup_failed exception receiving in_progress DIS pickup_failed
pickup_rescheduled exception staging_outbound in_progress FOH pickup_rescheduled
received inbound receiving in_progress RCF received_at_facility
arrival_scan inbound arriving in_transit ARR arrived_at_facility
in_transit transit departing in_transit DEP in_transit
package_outbound transit staging_outbound in_transit DEP departed
removed_from_route exception holding in_progress DIS in_transit
route_cancelled exception holding in_progress DIS in_transit
out_for_delivery out_for_delivery departing in_transit NFD out_for_delivery
delivered delivered receiving received DLV delivered
delivery_failed exception holding in_progress AWD delivery_failed
delivery_rescheduled exception holding in_progress AWD delivery_rescheduled
return_to_sender return shipping returned RTS returned
rejected_by_recipient return shipping returned RTS refused
cancelled return void_shipping inactive CNL cancelled

Incident reasons

carrier_damaged_parcelcarrier_sorting_errorcarrier_address_not_foundcarrier_parcel_lostcarrier_not_enough_timecarrier_vehicle_issuecarrier_capacity_exceededcarrier_mechanical_delayretailer_cancelledretailer_incorrect_dataretailer_not_readyretailer_incorrect_parcelretailer_incorrect_dimensionsretailer_packaging_issueconsignee_refusedconsignee_business_closedconsignee_not_availableconsignee_not_homeconsignee_cancelledconsignee_verification_failedconsignee_incorrect_addressconsignee_access_restrictedconsignee_safe_place_unavailablecustoms_delaycustoms_documentationcustoms_duties_unpaidcustoms_prohibitedcustoms_inspectionweather_delaynatural_disasterforce_majeureparcel_being_researchedsecurity_issueregulatory_holdunknown