API Guides
Explore our API endpoints, request parameters, and response formats.
- Getting Started
- Authentication
- Token Management
- Build Your Own API
- Orders Management
- Inventory / WMS
- Shipping Calculator
- Regions & Coverage
- Web Hooks
- SDK's
- Types & Statuses
- Orders Management
- Inventory / WMS
- Shipping Calculator
- Regions & Coverage
- Web Hooks
- SDK's
- Types & Statuses
Orders Status
Orders Status
Active Delivery Statuses IDStatusDescription1Pending ArrivalThe order has not yet arrived at our last mile hub. This status is only applicable...
Service Levels
Service Levels
Delivery Service Types NameCodeDescriptionWhite GlovewgWhite Glove DeliveryRoom of Choice + AssemblyrocpaRoom of Choice + Debris Removal + AssemblyRoom of Choice...
Tracking Events
Tracking Events
Event Tracking Table Event NameEvent IDORDER_ASSIGNED_FOR_PICKUP1ITEM_PICKUP_FROM_ORIGIN2UNLOAD_MILKRUN3LOAD_LINE_HAUL4ITEM_UNLOAD_AND_FULFILLED5VERIFIED_BY_SUPERVISOR6ACCEPTED_BY_HOME_DELIVERY_DRIVER7ITEM_DELIVERED8ITEM_REJECTED9ITEM_REPORTED_AS_DAMAGED10ORDER_DELIVERY_FAILED11ITEM_PICKUP_REVERTED_AT_MFGER_FACILITY12RETURN_ORDER_PICKED_UP_AT_CUSTOMER_ADDRESS13ITEM_UNLOADED_FROM_HOME_DELIVERY14RETURN_ORDER_UNLOADED_FROM_HOME_DELIVERY15ITEM_REMOVED_FROM_MANIFEST16ITEM_SKIPPED_DURING_MILKRUN_UNLOAD17ITEM_SKIPPED_DURING_LINE_HAUL_UNLOAD18ITEM_SKIPPED_DURING_HOME_DELIVERY_UNLOAD19ITEM_ASSIGNED_TO_HOME_DELIVERY20ITEM_REMOVED_FROM_LINE_HAUL21ITEM_ASSIGNED_FOR_RETURN22ITEM_RELOCATED23ITEM_LOADED_ONTO_HOME_DELIVERY24ITEM_ADDED_TO_MILKRUN_MANIFEST25ITEM_ADDED_TO_HOME_DELIVERY_MANIFEST26ITEM_PICKUP_FAILED_FROM_MFGER27ITEM_CANCELLED28ITEM_STATUS_CHANGED29DAMAGED_ITEM_REMAIN_AT_CUSTOMER_UNTIL_REPLACEMENT_DELIVERED30ITEM_MARKED_AS_FUNDED31ITEM_PULLED_FOR_HOME_DELIVERY_MANIFEST32ITEM_ASSIGNED_FOR_MFGER_PICKUP33ITEM_PICKUP_FROM_CUSTOMER34ORDER_RETURNED_FROM_CUSTOMER35ORDER_FULFILLED36ORDER_DELIVERY_DATE_SCHEDULE_CONFIRMED37ORDER_DELIVERY_DATE_CLEARED38FAILED_TO_SCHEDULED_DELIVERY_LVM39FAILED_TO_SCHEDULED_DELIVERY_UNABLE_TO_LVM40ORDER_CREATED41ORDER_PENDING_ARRIVAL42ORDER_OUT_FOR_DELIVERY43ORDER_DELIVERED44ORDER_CANCELLED45ORDER_REJECTED46ORDER_DAMAGED47ORDER_RETURNED48ORDER_DELIVERY_DATE_CHANGED49ORDER_DELIVERY_WINDOW_CONFIRMED50ORDER_DELIVERY_WINDOW_REVERTED51ORDER_IN_TRANSIT52ORDER_REQUEST_TO_SCHEDULE_TEXT_SENT53ORDER_UNLOADED_AT_CONSOLIDATION_DOCK54ORDER_PICKUP_DATE_SCHEDULED55ORDER_PICKUP_DATE_CHANGED56ORDER_PICKUP_DATE_CLEARED57ORDER_ASSIGNED_FOR_PICKUP58ORDER_PICKUP_CANCELLED59ORDER_DELIVERY_DATE_PRE_SCHEDULED60ORDER_REQUEST_TO_SCHEDULE_EMAIL_SENT61ORDER_DRIVER_PRECALL62ORDER_REQUEST_TO_SCHEDULE_VOICE_CALL_PLACED63ITEM_UNLOADED_AND_MARKED_FOR_RETURN_CONSOLIDATION64ITEM_LOADED_ON_RETURN_FREIGHT65ORDER_MARKED_FOR_RETURN66ORDER_PICKED_UP67ITEM_DELUXED68ORDER_DISPOSED69ORDER_STATUS_REVERTED70ORDER_ESTIMATED_ARRIVAL_SET71ORDER_ESTIMATED_ARRIVAL_CLEARED72ITEM_FAILED_DELUX73ORDER_MARKED_FOR_INSPECTION74ITEM_PULLED_INTO_OUTBOUND_MANIFEST75ORDER_IN_TRANSIT_TO_X_DOCK76ORDER_IS_READY_FOR_SCHEDULE77NEW_LINE_ITEM_CREATED78ITEM_LOADED_ON_RETURN_LINE_HAUL79ITEM_REMOVED_FROM_ORDER80ITEM_MOVED81ORDER_SENT_TO_CARRIER_PARTNER82ORDER_SENT_TO_HOME_DELIVERY_PARTNER83ORDER_MARKED_AS_PAID84ORDER_REFUND_ISSUED85ORDER_HOLD_STATUS_EXPIRED86LABELS_SENT87FAILED_TO_SEND_LABELS88DELIVERY_CONFIRMATION_SENT89ORDER_CONFIRMATION_SENT90ITEM_ASSIGNED_FOR_PRE_INSPECTION91ITEM_PRE_INSPECTION_COMPLETED92ITEM_UPDATED93ORDER_REMOVED_FROM_MANIFEST94DELIVERY_APPOINTMENT_CONFIRMATION_SENT95TEXT_MESSAGE_SENT96TEXT_MESSAGE_FAILED_TO_SENT97TEXT_SURVEY_SENT_SUCCESSFULLY98TEXT_SURVEY_FAILED99PICKUP_DISPATCHED_TO_CARRIER100PICKUP_CONFIRMED_BY_CARRIER101PICKUP_CANCELLED_BY_CARRIER102PICKUP_SCHEDULED_BY_CARRIER103LINE_ITEM_ADDED_TO_LINE_HAUL_MANIFEST104DELIVERY_COST_CHANGED105FAILED_TO_PLACE_VOICE_CALL106ORDER_COMPLETED_BY_DELIVERY_PARTNER107DELIVERY_RESCHEDULED108CUSTOMER_INFORMATION_LOOKUP109PICKUP_CONFIRMATION_SENT110FAILED_TO_CONFIRM_DELIVERY_WINDOW_LVM111ORDER_DELIVERY_WINDOW_EMAIL_SENT112ORDER_DELIVERY_WINDOW_TEXT_SENT113ORDER_DELIVERY_WINDOW_CALL_MADE114DELIVERY_TIME_FRAME_CONFIRMED_VIA_EMAIL115DELIVERY_TIME_FRAME_CONFIRMED_VIA_TEXT116DELIVERY_TIME_FRAME_CONFIRMED_VIA_CALL117STORAGE_FEE_WARNING_SENT118EDI_COMMUNICATION_SENT119AGING_ORDER_PICKED_UP120AGING_ORDER_READY_FOR_PICKUP121AGING_ORDER_NOT_READY_FOR_PICKUP122AGING_ORDER_NOT_FOUND123ORDER_UPDATED_ACK_NUMBER124AGING_ORDER_SET_PICKUP_READY_DATE125DELIVERY_INVOICE_SENT126ORDER_MARKED_FOR_DISPOSITON127FAILED_TO_PLACE_VOICE_CALL_AFTER_BIZ_HOURS128STORAGE_FEE_CHARGE_SENT129FAILED_DELUX_EMAIL_SENT130ORDER_STORAGE_FEE_TOGGLED131REPAIR_QUOTE_EMAIL_SENT132REPAIR_APPROVED_EMAIL_SENT133REPAIR_AUTO_APPROVED_EMAIL_SENT134ORDER_ITEM_INSPECTION_COMPLETED135REPAIR_DENIED_EMAIL_SENT136CLAIM_CREATED137ORDER_UPDATED138EARLIER_DATE_AVAILABLE_EMAIL139EARLIER_DATE_AVAILABLE_TEXT140UNABLE_TO_SCHEDULE_ALERT141PAYMENT_STATUS_CHANGED142PAYMENT_TERMS_CHANGED143ORDER_NOT_PAID_SCHEDULING_SKIP144ORDER_SERVICE_LEVEL_CHANGED145LINE_ITEM_HAS_BEEN_PRE_RECEIVED146CERTIFICATE_OF_INSURANCE_EMAIL_SENT147CERTIFICATE_OF_INSURANCE_TEXT_SENT148REDELIVERY_CONFIRMED149REDELIVERY_DECLINED150REDELIVERY_REQUEST_EMAIL_SENT151EMAIL_SURVEY_SENT_SUCCESSFULLY152EMAIL_SURVEY_FAILED153REPAIR_COST_AUTO_ADDED154ITEM_MARKED_FOR_INSPECTION155REPAIR_APPROVED156REPAIR_AUTO_APPROVED157REPAIR_DENIED158ORDER_PARTNER_CHANGED159ASSET_REMOVED160ORDER_LINKED161ITEM_MOVED_TO_INVENTORY162INVENTORY_ITEM_CREATED163INVENTORY_ITEM_FULFILLED164INVENTORY_ITEM_MOVED_FROM_ORDER165INVENTORY_ITEM_RELOCATED166INVENTORY_ITEM_REMOVED167ORDER_APPROVED_TO_SHIP_AS_IS168ORDER_APPROVED_TO_SHIP_AS_IS168ORDER_RETAILER_ACCOUNT_CHANGED169CERTIFICATE_OF_INSURANCE_UPDATED170LINE_ITEM_UNLOADED_FROM_FREIGHT_CARRIER171LINE_ITEM_REPORTED_SHORTAGE172ORDER_REPORTED_SHORTAGE173ORDER_SET_ON_HOLD174ITEM_FREIGHT_INFO_CHANGED175ELECTRONIC_POD_SENT176ELECTRONIC_POD_RECEIVED177SURVEY_RECEIVED178OUTBOUND_CALL179INBOUND_CALL180ORDER_PICKED_BY_CUSTOMER181PICKUP_TIME_FRAME_CONFIRMED_VIA_EMAIL182PICKUP_TIME_FRAME_CONFIRMED_VIA_TEXT183PICKUP_TIME_FRAME_CONFIRMED_VIA_CALL184ORDER_PICKUP_WINDOW_CONFIRMED185ARRIVE_ON_SITE186ARRIVE_ON_SITE_CUSTOMER_NOT_AVAILABLE187REQUEST_CHANGE_OF_ADDRESS188CHANGE_OF_ADDRESS_REQUEST_APPROVED189ITEM_RELOCATION_FAILED190CHANGE_OF_ADDRESS_REQUEST_REJECTED191PRECALL_TEXT_TO_CUSTOMER192ORDER_UNLINKED193INVENTORY_ITEM_ASSIGNED_TO_ORDER194ORDER_ESTIMATED_ARRIVAL_SET_BY_CARRIER195ITEM_ACCEPTED_WITH_EXCEPTION196LINE_ITEM_UNLOADED_FROM_HOME_DELIVERY197BILLED198BILLING_ORDER_CREATED199LINE_ITEM_MARK_FOR_DOCK_SEARCH200LINE_ITEM_MARKED_FOR_IN_TRANSIT_BY_CARRIER201CUSTOMER_CONTACT_REQUEST202WEBHOOK_SENT203RETURN_INFORMATION_CHANGED204
Delivery Status
Delivery Status
IDNAMEDESCRIPTION0InitializedStarting state1Pre-ConfirmedOrder has been pre-scheduled for a delivery date (not confirmed)2Schedule ConfirmedDate has been confirmed with the customer3Window ConfirmedDelivery time-frame...