Skip to content

WMS Portal API Documentation

The WMS Portal API provides comprehensive warehouse management capabilities through RESTful endpoints. This API enables integration with external systems across inbound receiving, inventory management, outbound dispatch, and system recovery operations.

Each section documents both directions of communication: Host → WMS (endpoints the host system calls on the WMS) and WMS → Host (notifications the WMS sends to host systems).

Base URL: Your WMS Portal instance URL

Authentication: Bearer token required

  1. Authentication - Learn how to authenticate with the API
  2. Health Check - Verify service connectivity
  3. API Reference - Browse the complete endpoint documentation below

Inbound

GIA processing, cross-dock ASN, and return receipts. Outbound notifications for GIA receipts, status updates, and returns.

Inventory

Product notifications, stock status updates, expected sales, and stock owners. Outbound notifications for stock adjustments, redline exceptions, and supplier non-compliance.

Outbound

Shipment receiving, cancellations, consignment labels, courier allocation, manifests, and SSCC pallets. Outbound notifications for shipment acknowledgements, dispatch, B2B packing, short shipments, and status reports.

Replay & Recovery

Event replay capabilities for dispatch, GIA receipts, stock adjustments, and returns.