Developer API · updated 2026-08-22

    Orders endpoints: list and read orders

    Two endpoints expose your orders: a paginated list with filters, and a single-order lookup by order number. Fields mirror what the app shows, minus anything internal or sensitive.

    1. 1

      List orders

      GET /v1/orders

      Query parameters: status (one of placed, confirmed, scheduled, out_for_delivery, delivered, waiting_pickup, picked_up, completed, canceled, waiting_delivery, waiting_landfill), from and to (YYYY-MM-DD, filtering created_at), page (default 1) and per_page (default 25, max 100). Results come newest first.

      curl -H "Authorization: Bearer dc_live_..." \
        "https://gcwyoiihrupbfqqlcurh.supabase.co/functions/v1/api-v1/v1/orders?status=completed&from=2026-08-01&per_page=50"
    2. 2

      Read one order

      GET /v1/orders/{order_number}

      Order numbers are the same ones you see in the app (for example 1042). A number that does not exist in YOUR company returns 404, even if it exists elsewhere: data never crosses companies.

    3. 3

      The order object

      Each order carries: order_number, status, payment_status, delivery_date, pickup_date, rental_days, address (line1, city, state, zip), size (the dumpster size label), debris_type, total_price, base_price, landfill_cost, net_weight_tons, customer_ref (the customer id, joinable against /v1/customers), created_at and completed_at. All money fields are US dollars as decimal numbers, not cents.

    4. 4

      What is intentionally NOT exposed

      Internal identifiers, tracking tokens, profit figures, GPS coordinates, risk-review state and demo data never appear in API responses. Orders under fraud review are hidden entirely until released.

    5. 5

      Pagination pattern

      Loop pages while has_more is true:

      page 1 -> has_more true -> request page 2 -> ... -> has_more false, done.

      Keep per_page at 100 for backfills to minimize calls (relevant inside the free window).

    Related guides

    Still stuck? Talk to our team

    Open a support ticket inside the app and our team will answer there.

    Log in and open a support ticket

    Try it yourself, free

    The software is 100% free with unlimited orders. No credit card, no demo, no contract.

    Create your free account