API Documentation

Everything you need to integrate with the 3PLGuys warehouse platform. Manage shipments, inventory, billing, and more through a simple REST API.

Getting Started

Set up authentication and understand the API environments.

Authentication

OAuth 2.0 flow, access tokens, and scopes

Environments

Production and sandbox API endpoints

Shipments

Create, track, and manage outbound and inbound shipments.

Overview

List and get shipments, status lifecycle, shipment types

Pick & Pack

Customer orders — pick units, repack, ship to an address

Small Parcel (SPD)

Ship full cartons as-is with labels for Amazon FBA and similar

Inventory

Products, cartons, stock levels, and warehouse locations.

Overview

How inventory is structured: products, cartons, and warehouses

Products

Create, update, and soft-delete products

Cartons

Carton types with contents, dimensions, and weight

Stock Levels

Real-time product and carton stock per warehouse

Warehouses

List warehouses with addresses and contact info

Billing

Invoices and account balance for warehouse operations.

Invoices

View invoices, line items, totals, and payment status

Balance

Current account balance and transaction history

Activity

Stay informed with notifications and AI-powered recommendations.

Notifications

Shipment updates, invoice alerts, and system events

Recommendations

AI-generated operational insights and suggestions

Account

Organization details and account management.

Organizations

Organization profile and settings

Reference

Error codes, pagination patterns, and the changelog.

Conventions

ID formats, timestamps, monetary values, and general patterns

Error Handling

HTTP status codes and error response format

Pagination

Skip/take pagination and response format

Changelog

API changes, new features, and deprecations

Tools

SDKs, AI integrations, and the OpenAPI spec.

AI Integrations (MCP)

Connect Claude and other AI assistants to your warehouse

SDKs & Libraries

Client libraries for popular languages

OpenAPI

Machine-readable API specification

Support

Get help and contact the team