API Reference
Complete MasonHub Order Management System API reference and documentation
Introduction
Comprehensive Order Management System API for inventory, orders, and fulfillment
The MasonHub REST API enables you to programmatically manage your entire supply chain operations, from catalog management to order fulfillment and everything in between.
Endpoints
Core Resources
- Catalog Management: SKU management, product information, and catalog operations
- Order Management: Order creation, updates, cancellation, and lifecycle management
- Inventory Management: Real-time inventory tracking, allocation, and availability
Fulfillment Operations
- Inbound Shipments: ASN management and receiving operations
- Shipments: Outbound shipment tracking and carrier information
Integration Tools
- Callbacks & Events: Real-time webhooks for order and shipment events
- DataFactory: Testing utilities for simulating operations and generating test data
Authentication
You can generate an API key through your MasonHub dashboard. API keys are associated with your account and provide access to all MasonHub API endpoints.
Bearer Token Authentication
The MasonHub API uses JWT Bearer tokens for authentication. Include your token in the Authorization header of all requests.
Bearer tokens begin with the eyJ
prefix and are used for all API operations. Keep your bearer tokens secret.
All API endpoints require HTTPS with a valid JWT Bearer token. Requests over HTTP or without authentication will be rejected.
Using Your Token
Include the bearer token in the Authorization header:
Base URLs
Use for development and testing
API Design Principles
The MasonHub API follows consistent design principles:
Search-First Design
GET methods use search parameters for composability and flexible data retrieval
Batch Operations
All methods accept/return arrays for efficient bulk operations
Flexible Responses
Use list_type=detail|summary
for appropriate response detail levels
RESTful Design
Standard GET, POST, PUT, DELETE operations (No PATCH)
Data Formats
Date and Time
All timestamps use RFC3339 format for consistency:
Pagination
Standard pagination parameters across all list endpoints:
Parameter | Type | Description | Default |
---|---|---|---|
limit | integer | Number of results [1..100] | 30 |
offset | integer | Pagination offset | 0 |
Response Format
All responses follow a consistent structure: