API Reference

Build powerful integrations with our RESTful APIs

Getting Started with ShipFifty API

Our RESTful API provides programmatic access to ShipFifty's fulfillment platform. Use it to manage products, inventory, warehouse orders, clients, returns, and more.

Base URL

https://api.shipfifty.com/v1

Authentication

Authenticate by calling the login endpoint to receive a JWT token, then include it in subsequent requests:

Authorization: Bearer YOUR_JWT_TOKEN

Rate Limits

1000 requests per hour per account

Quick Start Example

# Step 1: Get JWT token
curl -X POST https://api.shipfifty.com/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "your@email.com", "password": "your_password"}'

# Step 2: Use token for API calls
curl https://api.shipfifty.com/v1/products/search \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

API Endpoints

Authentication

POST /auth/login Login, returns JWT token
POST /auth/signup Create new account
GET /auth/me Get current user info

Products

GET /products/search Search and list products
GET /products/:id Get product by ID
GET /products/:id/detail Get full product detail
GET /products/:id/inventory Get product inventory levels
POST /products Create a new product
GET /products/scan/:upc Scan product by UPC barcode

Inventory

GET /inventory List all inventory items
GET /inventory/:id Get inventory item by ID
GET /inventory/:id/history Get inventory item history
POST /inventory Create inventory item
POST /inventory/receive Receive inventory into warehouse
POST /inventory/:id/adjust Adjust inventory quantity
POST /inventory/:id/move Move inventory to new location
DELETE /inventory/:id Delete inventory item

Warehouse Orders

GET /warehouse-orders/search Search warehouse orders
GET /warehouse-orders/:id Get order by ID
GET /warehouse-orders/todays-receiving Today's receiving schedule
GET /warehouse-orders/receiving-history Receiving history
POST /warehouse-orders/:id/receive Receive against an order

Clients

GET /clients List all clients
GET /clients/:clientCode Get client by code
GET /clients/:clientCode/dashboard Get client dashboard data
GET /clients/:clientCode/inventory Get client inventory
GET /clients/:clientCode/products Get client products
POST /clients/:clientCode/warehouse-orders Create client warehouse order
GET /clients/:clientCode/warehouse-orders List client warehouse orders

Returns

GET /returns List all returns
GET /returns/pending List pending returns
GET /returns/:id Get return by ID
POST /returns Create a return
POST /returns/:id/ship Ship a return
POST /returns/:id/complete Complete a return

Additional Resources

SDKs & Libraries

Official SDKs for Python, JavaScript, PHP, and more

Postman Collection

Import our collection with JWT auth to test endpoints quickly

Webhooks Guide

Set up real-time event notifications

API Changelog

Stay updated with the latest API changes