Skip to content
INTERACTIVE DEMO · SAMPLE DATA Sandbox documentation for the WAREX API. Keys and responses below are simulated; live endpoints ship with the platform. This page also serves llms.txt and a markdown mirror for AI agents.

Developer Portal

Organized around your goals, not our endpoints · the only Stripe-tier portal in logistics

Sandbox Keys

Generate a sandbox key and every code sample on this page rewrites itself to use it. Sandbox keys hit the simulator only — no real freight moves, ever.

wx_test_•••••••••••••••••••••

Simulated key theater — real key issuance ships with platform auth (R-Warex-03 gate).

Post an RFQ

One call puts a structured requirement on the board: location + radius, services, environment, certifications, units, dims, photos, constraints, urgency. The schema is the same intake that kills clarification ping-pong on the board — photos and dims are required at the gate, not discovered on round three.

  • Idempotent: resend with the same order_ref, get the same RFQ.
  • Versioned scope: amend a posted RFQ and quotes re-version instead of restarting.
  • Expiry built in: every RFQ carries expires_at — no ghost loads, by schema.

Track an Order

Orders expose the same unified record the control tower renders: lifecycle state, timeline events, ETA band, documents, and the accepted menu pricing line by line.

Deterministic Shipment Replay

The sandbox ships one deterministic shipment that replays its full lifecycle — same states, same order, every run. Wire your webhooks against it and your tests never flake.

SIMULATED
    # post an RFQ (sandbox)
    curl https://api.thewarex.ca/v1/rfqs \
      -H "Authorization: Bearer wx_test_…" \
      -d order_ref="WX-DEMO-1002" \
      -d services[]="rework" \
      -d urgency="rescue" \
      -d units[type]="pallet" -d units[count]=2 \
      -d window[end]="+6h"
    # → 201 { "id": "rfq-002", "sample": true,
    #         "expires_at": "+6h", "quotes_in": 1 }
    # track the sandbox shipment
    curl https://api.thewarex.ca/v1/shipments/shp-demo-001 \
      -H "Authorization: Bearer wx_test_…"
    # → 200 { "state": "IN_TRANSIT",
    #         "lifecycle": ["CREATED","IN_TRANSIT",
    #                       "DELAYED","IN_TRANSIT","DELIVERED"],
    #         "sample": true }