Talk to an Expert
API Documentation - Grasshopper Labs API
v1 · Production

The logistics API built for big & bulky delivery.

Create orders, track items in real time, automate the entire last-mile workflow. One REST API for retailers, carriers, and 3PLs handling final-mile freight.

Get started Postman collection
create_order.sh 
# Create your first order
curl -X POST https://{licensee-url}/api/orders/ \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ref_order_number": "PO-12345",
    "service_level": "wg",
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "address": {
        "address1": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "zip": "78701"
      }
    },
    "line_items": [{
      "sku": "SOFA-001",
      "name": "3-Seat Sofa",
      "quantity": 1,
      "weight": 150
    }]
  }'

Everything you need to integrate

From your first authenticated request to production-grade webhook handling, every workflow available in the Grasshopper platform is available through the API.

Getting started

Six steps from zero to production. Authentication, your first order, webhooks, and POD retrieval.

Begin →

Authentication

Bearer token auth with refresh flows and revocation. Standard OAuth-style pattern.

Learn →

Orders

Create, retrieve, update, cancel. The core of the platform. Full CRUD with bulk operations.

View endpoints →

Webhooks

Real-time event subscriptions. 23 topics across order lifecycle, scheduling, items, and assets.

Subscribe →

Inventory & WMS

Stock management, fulfillment, and warehouse operations. Move, count, allocate.

View endpoints →

Shipping calculator

Cost and delivery time estimates. Origin, destination, service level, units in. Quote out.

View endpoint →
Search everything

Press ⌘K from anywhere

Instant search across every endpoint, status code, tracking event ID, webhook topic, and reference page. No more digging through tabs.

tracking event delivered
Reference
REF ITEM_DELIVERED (event 8)
REF ORDER_DELIVERED (event 44)

Reference data

Lookup tables for every numeric ID and code string you'll encounter in API responses and webhook payloads.

Order statuses

30 status IDs split into active, terminal, and temporary states.

Service levels

13 delivery service types — White Glove, Threshold, Curbside, and more.

Tracking events

204 event types emitted across the order lifecycle, with search.

Delivery status

The 4 scheduling states from Initialized through Window Confirmed.

Ready to build?

Get your production URL and credentials from the licensee you are integrating with, then walk through your first integration.