Boxy API
  1. Guides
Boxy API
  • Getting Started
    • Introduction
    • Environments
    • Security & Authentication
    • Rate Limit
    • Postman Collections
    • Schemas
    • Webhooks
  • Guides
    • Order Flow (Statuses)
    • Provinces & Regions
  • API Reference
    • Merchant
      • Get Merchant Info
    • Orders
      • Create Order
      • Create Bulk Orders (Sync)
      • Create Bulk Orders (Async)
      • List Orders
      • Show Order By UID
      • Show Order By Custom ID
      • Get Label Single
      • Get Label Bulk
      • Cancel Order
      • Update Order
      • Delete Order
    • Pick-ups
      • Request Pick-up
      • Request Pick-up Bulk
      • List Pick-ups
      • Show Pick-up
      • Get Pick-up Labels
      • Cancel Pick-up
      • Cancel Bulk Pick-ups
    • Pick-up Locations
      • Create Pick-up Location
      • List Pick-up Locations
      • Show Pick-up Location
      • Show Cash Drop-off Location
      • Update Pick-up Location
      • Delete Pick-up Location
    • Regions
      • List Regions
  1. Guides

Order Flow (Statuses)

In the diagrams below you will find representations of the different possible flow of events you may receive assuming all possible events are subscribed to.
StatusDescription
newOrder created
scheduledOrder scheduled for pick-up
collectingPick-up agent heading to collect the order
collectedPick-up agent collected the order
in-transitOrder received at warehouse and in transit
on-holdUnexcpected event happended and order is on hold
out-for-deliveryOrder out for delivery to the customer
deliveredOrder delivered
partially-deliveredOrder partially delivered
returned-warehouseRTO received at warehouse from the last-mile carrier
returning-originRTO scheduled to delivery to merchant
returnedRTO returned to merchant
partially-returnedRTO partially returned to merchant
postponedOrder re-scheduled for another date for delivery
Modified at 2025-02-07 14:05:34
Previous
Webhooks
Next
Provinces & Regions
Built with