Getting Started

Overview

The OrbisCommerce API is a RESTful API that gives you programmatic access to shipment creation, label generation, real-time tracking, and carrier rate comparison across all supported carriers.

Base URL

https://api.orbiscommerce.com/v1

All requests must be made over HTTPS. HTTP requests will be rejected.

Request Format

• All request bodies must be JSON with Content-Type: application/json
• All responses are JSON
• Timestamps are ISO 8601 format in UTC: 2025-06-01T14:30:00Z
• Weights are in grams, dimensions in centimeters

Quick Start

1. Get your API key

Sign up at orbiscommerce.com or contact support@orbiscommerce.com.

2. Make your first request

curl https://api.orbiscommerce.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Create a shipment

curl -X POST https://api.orbiscommerce.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "usps",
    "service": "priority_mail",
    "from": {
      "name": "OrbisCommerce",
      "address1": "123 Shipping St",
      "city": "Los Angeles",
      "state": "CA",
      "zip": "90001",
      "country": "US"
    },
    "to": {
      "name": "John Doe",
      "address1": "456 Main St",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US"
    },
    "parcel": {
      "weight": 500,
      "length": 20,
      "width": 15,
      "height": 10
    }
  }'

Rate Limits

Rate limit headers are returned with every response:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 297
X-RateLimit-Reset: 1717257600

Errors

All errors follow a consistent format:

{
  "error": {
    "code": "invalid_address",
    "message": "The destination address could not be verified.",
    "field": "to.zip"
  }
}