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 HubDocsApi ReferenceOrders
Developers/Docs/API Reference/Orders

Orders API

Create and manage fulfillment orders programmatically. Submit orders, track status, and receive real-time updates.

v1.0
8 Endpoints
REST API

Base URL

https://app.3plship.com/api/v1
POST/v1/orders

Create a new fulfillment order

Headers

Authorization: Bearer zl_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Body Parameters

order_numberrequiredstring

Your unique order identifier (maps to orders.order_number)

customer_idrequiredinteger

Customer ID from your customers table

shipping_address_idrequiredinteger

Address ID from addresses table

line_itemsrequiredarray

Array of order line items

product_id - Product ID (integer, required)
quantity - Quantity to fulfill (integer, required)
unit_price - Price per unit (decimal, required)
shipping_methodoptionalstring

Shipping carrier and service level (e.g., "usps_priority", "fedex_2day")

order_notesoptionalstring

Internal order notes (maps to orders.notes)

requires_cold_storageoptionalboolean

Whether order contains temperature-sensitive products (default: false)

GET/v1/orders

List all orders with optional filtering

Query Parameters

statusFilter by order status (pending, processing, shipped, delivered, cancelled)
customer_idFilter by customer ID
pagePage number for pagination (starts at 1, default: 1)
limitNumber of results per page (default: 50, max: 100)

Example Request

curl -X GET "https://app.3plship.com/api/v1/orders?status=pending&page=1&limit=10" \
  -H "Authorization: Bearer zl_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Additional Endpoints

GET/v1/orders/:idGet order details by ID
PATCH/v1/orders/:idUpdate order details
DELETE/v1/orders/:idCancel order
POST/v1/orders/:id/holdPut order on hold
POST/v1/orders/:id/releaseRelease order from hold
GET/v1/orders/:id/historyGet order status change history

Note: All endpoints use the base URL https://app.3plship.com/api/v1 and require the Authorization header with your API key.