📚 Help Center
HomeAPI & Webhooks
← Back to Hub

API & Webhooks

Build custom integrations with the 3PL SHIP RESTful API and real-time webhooks

On This Page

Need More Help?

Contact SupportView FAQAPI Docs

Quick Navigation

API KeysAuthenticationAPI EndpointsWebhook ConfigurationTesting & DebuggingSecurity Best Practices

API Keys

Creating API Keys

  1. Navigate to Settings → Developer → API Keys
  2. Click Create New API Key
  3. Enter Key Name (descriptive name for your reference)
  4. Select Permissions:
    • • Read only - View data only
    • • Read & write - View and modify data
    • • Full access - Complete control
  5. Set IP Whitelist (optional but recommended for security)
  6. Click Create
  7. Copy API key immediately - It won't be shown again!

Production Keys

Format: 3pl_live_...

Use for production environments only

Test Keys

Format: 3pl_test_...

Use for sandbox/testing environments

Authentication

API Authentication Methods

The 3PL SHIP API uses Bearer token authentication. Include your API key in the Authorization header of every request.

Authorization: Bearer 3pl_live_your_api_key_here

Example cURL Request:

curl https://api.3plship.com/v1/orders \
  -H "Authorization: Bearer 3pl_live_your_api_key" \
  -H "Content-Type: application/json"

Security Notes:

  • Never expose API keys in client-side code
  • Store keys securely in environment variables
  • Use test keys for development
  • Rotate keys if compromised

API Endpoints

Base URL

https://api.3plship.com/v1

Orders Endpoints

  • GET /orders - List all orders
  • POST /orders - Create new order
  • GET /orders/:id - Get order details
  • PATCH /orders/:id - Update order
  • DELETE /orders/:id - Cancel order

Inventory Endpoints

  • GET /inventory - List inventory
  • POST /inventory - Add inventory
  • PATCH /inventory/:sku - Update inventory

Products Endpoints

  • GET /products - List products
  • POST /products - Create product
  • GET /products/:id - Get product
  • PATCH /products/:id - Update product

Webhook Configuration

Setting Up Webhooks

  1. Go to Settings → Developer → Webhooks
  2. Click Add Webhook Endpoint
  3. Enter details:
    • • Endpoint URL - Your server URL
    • • Events to receive - Select event types
    • • Webhook version - v1 or v2
    • • Signing secret - For HMAC verification
  4. Set Retry Policy:
    • • Number of retries: 3, 5, or 10
    • • Retry interval: Exponential backoff
  5. Click Save

Available Webhook Events

Order Events
  • • order.created
  • • order.shipped
  • • order.delivered
  • • order.cancelled
Inventory Events
  • • inventory.low_stock
  • • inventory.updated
  • • inventory.received
Shipment Events
  • • shipment.created
  • • shipment.in_transit
  • • shipment.exception
Return Events
  • • return.created
  • • return.received
  • • return.processed

Testing & Debugging

Testing Webhooks

  • • Use Send Test Event button
  • • View delivery logs
  • • Check response codes
  • • Debug failures

API Testing Tools

  • • Use Postman or Insomnia
  • • Check API response codes
  • • Validate request/response format
  • • Test error scenarios

Security Best Practices

Keeping Your Integration Secure

API Key Management

  • Rotate API keys regularly (every 90 days)
  • Use separate keys for different environments
  • Never commit keys to version control
  • Store keys in environment variables or secrets manager

Network Security

  • Use IP whitelisting when possible
  • Always use HTTPS endpoints
  • Implement rate limiting on your side
  • Monitor for unusual API activity

Webhook Security

  • Verify webhook signatures (HMAC)
  • Use HTTPS webhook endpoints only
  • Implement idempotency checks
  • Log all webhook deliveries

API Documentation

Explore our complete API reference with interactive examples and code samples

View API DocsContact Support
← Back to Help CenterContact Support →