Consignly API Documentation
Consignly is a cloud-native warehouse management system (WMS) designed for both third-party logistics (3PL) and self-managed (2PL) warehouse operations. The platform connects warehouse operators with their freight carriers (Carrier Partners) and, when used in 3PL operations, their clients (Client Partners), enabling end-to-end management of inventory through receiving, storage, picking, and dispatch operations, and supporting seamless data exchange between connected organisations.
Key platform capabilities include:
- Inward Consignments - Receiving inventory into the warehouse from suppliers
- Outward Consignments - Dispatching inventory from the warehouse to customers
- Point-to-Point Consignments - Direct transfers that bypass warehouse storage
- Inventory Management - Real-time inventory tracking across warehouse locations
- Client Partner Portal - Self-service access for clients to view inventory and consignments
- Mobile Warehouse App - Barcode scanning for receiving, picking, and transfers
- Billing & Invoicing - Activity-based charging with rate cards and schedules
API Overview
The Consignly API provides programmatic access to Consignly's warehouse management and logistics platform. The API enables integration with Consignly for managing consignments, inventory, partners, and warehouse operations.
API Version: v1
Base URL: https://api.consignlyhq.com/v1
Key Concepts
Before working with the API, understand these core concepts:
Warehouses represent the physical operating site where inventory is received, stored, moved, and dispatched. It defines the operational context for consignments, inventory ownership, location structures, users, and localised settings such as time zone and charging rules.
Consignments represent movement of inventory, either inward (receiving inventory into a warehouse), outward (dispatching inventory from a warehouse for customer orders) or point to point (bypass warehouse).
Partners are external business entities that an organisation works with. There are two types, the Client Partners (whose inventory are stored in 3PL warehouses) or Carrier Partners (transport providers).
Partner Products are the catalogue of products stored in warehouses within an organisation. In a 2PL or self-managed warehouse they belong to the organisation itself, and in a 3PL environment they are held on behalf of a client partner. They define the stock-keeping identity, units, dimensions, and chargeable attributes used across consignments, inventory tracking, and billing.
Key Capabilities
The Consignly API enables the following capabilities:
- Consignment Management - Create, retrieve, update, and track consignments
- Inventory Management - Query inventory levels, product locations, and inventory items
- Partner Management - Access client and carrier information, products, and schedules
- Warehouse Operations - Manage warehouses, locations, and zones
- Reporting - Generate reports for charges, inventory, consignments, and more
- Document Generation - Generate and print PDFs for consignment documents, picking lists, and labels
- Webhook Subscriptions - Subscribe to events for real-time notifications
API Reference
Core Resources
| Resource | Description |
|---|---|
| Consignments | Manage inward and outward consignments |
| Consignment Import | Create consignments via import |
| Consignment Charges | Manage consignment charges |
| Consignment Notes | Add and manage notes on consignments |
| Consignment POD | Proof of delivery management |
| Consignment Tracking | Tracking information and events |
Inventory & Products
| Resource | Description |
|---|---|
| Inventory | Query inventory levels and inventory items |
| Partners | Client and carrier information |
| Partner Products | Product catalog management |
| Product Attributes | Custom product attributes |
Warehouse Operations
| Resource | Description |
|---|---|
| Warehouses | Warehouse locations and details |
| Jobs | Wave pick jobs management |
| Printer Bridges | Printer configuration |
Reference Data
| Resource | Description |
|---|---|
| Consumable Types | Consumable type definitions |
| Cost Centres | Cost centre lookup |
| Hazard Classes | Dangerous inventory classifications |
| Revenue Accounts | Revenue account lookup |
| Service Types | Service type definitions |
| Shipping Ports | Shipping port reference data |
| Task Types | Task type definitions |
| Tax Rates | Tax rate lookup |
Reporting & Integration
| Resource | Description |
|---|---|
| Reports | Generate various reports |
| Partner Schedules | Partner schedule management |
| Webhook Subscriptions | Event subscription management |
| Identity | Current user context |
Additional Resources
- Authentication - OAuth 2.0 setup and token management
- Error Handling - Error codes and troubleshooting
- Pagination - Working with paginated results
- Consignly Help Centre - User guides and platform documentation
Glossary
| Term | Definition |
|---|---|
| Client Partner | A business that has it's inventory stored in a 3PL warehouse |
| Carrier Partner | A freight carrier responsible for transporting inventory |
| Inward Consignment | Inventory being received into a warehouse |
| Outward Consignment | Inventory being dispatched from a warehouse |
| Point-to-Point | Direct transfer bypassing warehouse storage |
| Logistic Unit | A physical handling unit (package) used to group inventory/items for receiving, storage, picking, and shipping. In Consignly UI and warehouse terminology, these are commonly called "packages" (cartons, pallets, satchels, etc.). In the API, this entity is referred to as a logisticUnit. |
| Pickface | Forward pick locations for fast-moving items |
| Schedule | A collection of transactions grouped for invoicing |
| Rate Card | Pricing configuration for activities, freight, or storage |
| SSCC | Serial Shipping Container Code (GS1 barcode standard) |
Support
For API support, contact us at https://www.consignlyhq.com/contact