UOS - Unified Order Service API

CI/CD Pipeline & Key Features

Branch	Status	Environment
dev	Passing	UOS - Vanilla Dev
main	Passing	UOS - Co-op Stage
production	Passing	UOS - Co-op Prod

Multi-Channel IntegrationSeamlessly integrate orders from Amazon, Salesforce, Uber Eats, and other enterprise sales channels

Comprehensive Order ManagementComplete lifecycle management with advanced workflows, versioning, and real-time tracking

Enterprise-Ready InfrastructureBuilt for scale with OAuth 2.0 security, webhook notifications, and WebSocket updates

Platform Overview

The Unified Order Service (UOS) provides a robust, enterprise-grade platform for managing orders across multiple sales channels. Built to handle complex workflows and high-volume transactions, UOS delivers the reliability and scalability required by industry leaders.

Core API

Complete order lifecycle management, channel configuration, webhook orchestration, and administrative operations

Explore Core API →

Drone API

Optimized endpoints for in-store operations, including picking workflows, fulfillment processes, and real-time inventory management

Explore Drone API →

Core Capabilities

Authentication & SecurityIndustry-standard authentication supporting both API keys for service integrations and OAuth 2.0/MSAL for user-based access with granular permission controls

Real-Time NotificationsWebSocket connections and webhook integrations deliver instant updates for order events, status changes, and inventory modifications

Advanced WorkflowsSophisticated status transition management with validation rules, metadata requirements, and comprehensive audit logging

Channel AdaptabilityExtensible architecture supporting custom channel adapters with schema validation and transformation capabilities

Getting Started

Prerequisites

• Valid API credentials (contact Naveo Support: gsd@maginus.atlassian.net)
• HTTPS endpoint for webhook notifications (optional)
• Understanding of RESTful API principles

Quick Start

1. Authentication - Configure API keys or OAuth 2.0 credentials
2. Channel Setup - Create and configure your sales channel
3. Order Integration - Begin processing orders through the API
4. Webhook Configuration - Set up real-time notifications (recommended)

Documentation Structure

For Developers

• System Architecture Overview
• Asynchronous Architecture Explained
• Authentication Methods
• Core API Reference
• Drone API Reference

For Integration Engineers

• Order Management Guide
• Channel Configuration
• Webhook Implementation
• Status Workflow Management

For System Administrators

• API Key Management
• Place & Storage Location Setup
• FCM Notification Configuration

Recent Updates

Operation-Type Oriented Webhooks

Enhanced order:failed webhooks now provide operation-specific failure information (order_create, order_status_update, etc.) for improved error handling and system integration. View details →

Advanced Status Workflows

Comprehensive status transition system with validation rules, required metadata specifications, and picking app scope restrictions for improved order lifecycle management.

OAuth 2.0 Webhook Authentication

Enterprise-grade webhook security with OAuth 2.0 client credentials flow, automatic token management, and HMAC signature verification.

Support & Resources

For technical support, integration assistance, or questions about the UOS platform, consult the following resources:

• API Status & Service Health
• Technical support contact: gsd@maginus.atlassian.net
• Integration documentation: Available throughout this documentation portal