Developer previewAPI v1 (draft reference)

Shipmexi Shipping API

Automate multichannel fulfillment, fetch discounted carrier rates, generate shipping labels, and subscribe to tracking webhooks—the same patterns trusted across modern logistics SaaS platforms.

View request examplesTalk to API specialistHelp center

Overview

The Shipmexi API is a JSON-first REST interface designed for operators building custom storefronts, internal ERP tools, and marketplace workflows. Full interactive explorer and OpenAPI assets will ship alongside production keys—this page establishes the surface area your architects can plan against today.

  • Versioned endpoints

    Breaking changes roll forward under explicit version prefixes—no silent surprises in production.

  • Tenant isolation

    Keys are scoped to environments with audit trails suitable for PCI-adjacent shipping flows.

  • Event-driven webhooks

    Subscribe to label purchases, delivery scans, and integration health alerts with retry-aware signatures.

  • Carrier breadth

    Designed for the same multi-carrier orchestration patterns used across enterprise shipping stacks.

Authentication

Shipmexi uses Bearer API keys provisioned per workspace. Rotate keys without downtime by issuing a secondary credential first—mirroring patterns developers expect from category-leading shipping APIs.

Never embed secret keys in browser bundles. Proxy requests through your backend or edge worker so credentials stay server-side.

Header

Authorization: Bearer YOUR_API_KEY
X-Shipmexi-Workspace: ws_live_xxxx

Core resources

Logical surface area comparable to shipping APIs from major fulfillment platforms—names may adjust slightly before GA.

OpenAPI 3.1 bundle — coming soon

Orders

REST

Import, query, and transition orders from connected channels or custom payloads.

  • GET /orders
  • POST /orders
  • GET /orders/:id

Shipments & labels

REST

Purchase labels, void shipments, and retrieve printable artifacts.

  • POST /shipments
  • POST /shipments/:id/void
  • GET /shipments/:id/label

Rates

REST

Compare carrier services with dimensional weight, zones, and delivery promises.

  • POST /rates/query

Tracking

REST

Normalize milestone events and expose buyer-ready timelines.

  • GET /tracking/:id
  • GET /tracking/events

Addresses

REST

Validate and normalize domestic or international addresses prior to label purchase.

  • POST /addresses/validate

Batch jobs

REST

Long-running bulk operations for peak-season throughput.

  • POST /batches
  • GET /batches/:id

Request examples

Illustrative snippets—final paths and schemas will match the published OpenAPI document.

rate quotePOST
curl -s https://api.shipmexi.com/v1/rates/query \
  -H "Authorization: Bearer $SHIPMEXI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ship_from": { "country": "US", "postal_code": "75201" },
    "ship_to": { "country": "US", "postal_code": "10001" },
    "parcel": {
      "weight_oz": 16,
      "length_in": 12,
      "width_in": 9,
      "height_in": 4
    }
  }'
create shipmentPOST
curl -s https://api.shipmexi.com/v1/shipments \
  -H "Authorization: Bearer $SHIPMEXI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ord_9xk2",
    "service_code": "usps_priority",
    "label_format": "PDF_4x6"
  }'

Rate limits & errors

Protective defaults keep carrier upstreams stable during spikes. Exact quotas ship with your contract tier.

Plan tierBurst (req / min)Notes
Starter60Ideal for single-store automation.
Professional300Warehouse batches & webhook fan-out.
EnterpriseCustomDedicated throughput & SLA-backed queues.

Errors use structured JSON with code, message, and optional details for field-level validation—same ergonomics developers expect from mature logistics APIs.

Webhooks

Register HTTPS endpoints to receive signed delivery events. Retry policies follow exponential backoff with dead-letter visibility in the dashboard—aligned with how leading shipping platforms keep integrations observable.

  • shipment.label_purchased — payload includes carrier, service, tracking number, and label URLs.
  • tracking.updated — normalized milestones for buyer notifications.
  • integration.health_changed — proactive alerts when store tokens expire.

Verification header (conceptual)

X-Shipmexi-Signature: t=1735689600,v1=a1b2c3...
X-Shipmexi-Delivery-Id: evt_8kLmNoPq

Implement idempotent handlers using delivery_id so retried webhooks never double-apply business logic.

SDKs & tooling

Official clients and Postman collections will publish alongside stable authentication. Until then, integrate directly via HTTPS—your stack, your control plane.

Node.js

Planned

Python

Planned

PHP

Planned

Go

Roadmap

Ready to prototype against Shipmexi?

Request sandbox credentials, review mutual TLS options for enterprise environments, or walk through a joint architecture session with our solutions engineers.

Request API accessCompare plans