Developer Docs

Getting Started
  • Quick Start
  • Getting Started
  • Authentication
API Reference
  • Overview
  • Orders
  • Products
  • Inventory
  • Shipments
  • Customers
  • Returns
  • Tracking
Integrations
  • Shopify
  • WooCommerce
  • BigCommerce
  • Custom API
Webhooks
  • Overview
  • Webhook Events
Resources
  • Rate Limits
  • Error Codes
  • API Playground
  • SDK Libraries
  • Changelog
  • API Status
Support
  • Community
  • GitHub
  • Support
HomeDeveloper HubIntegrationsCustom
Developer Resources

Custom API Integration

Build bespoke fulfillment solutions with our comprehensive REST API. Perfect for custom platforms, headless commerce, and enterprise systems.

Perfect For

Headless Commerce

Build custom storefronts with any frontend framework connected to 3PL SHIP.

Multi-Platform Aggregation

Consolidate orders from multiple platforms into unified fulfillment workflows.

Custom ERP Integration

Connect your existing ERP or business management system to 3PL SHIP.

Mobile Apps

Build native iOS and Android apps with real-time fulfillment capabilities.

B2B Portals

Create wholesale ordering portals with direct fulfillment integration.

Subscription Platforms

Build recurring order systems with automated fulfillment scheduling.

Quick Start Guide

1

Get API Credentials

Sign up for a 3PL SHIP account and generate your API key and secret from the dashboard.

2

Authenticate Requests

Use Bearer token authentication with your API key in the Authorization header.

3

Create Your First Order

Make a POST request to /v1/orders with customer and product information.

4

Set Up Webhooks

Configure webhook endpoints to receive real-time updates for order status changes.

5

Go Live

Test thoroughly in sandbox mode, then switch to production when ready.

Code Examples

Get started quickly with examples in your preferred programming language:

JavaScript/Node.js
const API_KEY = 'your_api_key';
const API_URL = 'https://api.3plship.com/v1';

async function createOrder(orderData) {
  const response = await fetch(`${API_URL}/orders`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(orderData)
  });
  
  return await response.json();
}

// Create order
const order = await createOrder({
  customer: {
    name: 'John Doe',
    email: 'john@example.com',
    address: '123 Main St'
  },
  items: [
    { sku: 'PROD-001', quantity: 2 }
  ]
});
Python
import requests

API_KEY = 'your_api_key'
API_URL = 'https://api.3plship.com/v1'

def create_order(order_data):
    headers = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
    
    response = requests.post(
        f'{API_URL}/orders',
        json=order_data,
        headers=headers
    )
    
    return response.json()

# Create order
order = create_order({
    'customer': {
        'name': 'John Doe',
        'email': 'john@example.com',
        'address': '123 Main St'
    },
    'items': [
        {'sku': 'PROD-001', 'quantity': 2}
    ]
})

Key API Resources

Orders API

Create, update, and manage fulfillment orders

/v1/orders

Inventory API

Check stock levels and manage inventory

/v1/inventory

Shipping API

Get shipping rates and tracking information

/v1/shipping

Webhooks API

Configure real-time event notifications

/v1/webhooks

Returns API

Process returns and generate RMA labels

/v1/returns

Reports API

Access fulfillment analytics and reports

/v1/reports

Ready to Build?

Explore our complete API documentation and start building your custom integration today.

API ReferenceGet API Keys