Standard Order API

# Standard Order Experience API

**Version:** v1.0.0

**Status:** Production Ready

**API Type:** Experience Layer

**Protocol:** REST/HTTPS

**Last Updated:** June 15, 2026

------

## Table of Contents

- [Overview](#overview)
- [API Architecture](#api-architecture)
- [API Endpoints](#api-endpoints)
    - [POST /order](#post-order) - Create an order using Basic Authentication
    - [POST /orderUpdate](#post-orderupdate) - Receive order status updates from backend systems
    - [POST /v2/order](#post-v2order) - Create an order using OAuth 2.0 Authentication
- [Data Models](#data-models)
- [Field Specifications](#field-specifications)
- [Schema Validation Rules](#schema-validation-rules)
- [Error Handling](#error-handling)
- [Authentication](#authentication)

------

## Overview

### General Information

| Property | Value |
|----------|-------|
| **API Name** | standard-order-api |
| **Version** | v1 |
| **Base URL** | `https://muleqc.diam.compucom.com` |
| **Base URI** | `/api/standard-order/` |
| **Full Endpoint** | `https://muleqc.diam.compucom.com/api/standard-order/` |
| **Protocol** | HTTPS |
| **Format** | JSON |

### Environment URLs

| Environment | Base URL |
|-------------|----------|
| **QC (Quality Control)** | `https://muleqc.diam.compucom.com` |
| **Production** | `https://muleprod.diam.compucom.com` |

> **📝 Note:** This documentation uses the QC environment (`https://muleqc.diam.compucom.com`) in all examples. Replace with the appropriate environment URL for your specific needs.

### Purpose

The **Standard Order Experience API** serves as a centralized integration layer for managing device and inventory orders across multiple enterprise clients. It provides a unified interface for order processing, status updates, and workflow orchestration between client systems and backend order management platforms.

### Key Features

#### 📝 Order Creation

Accept and process orders from various client portals with comprehensive validation, transformation, and intelligent routing to backend systems such as DIMS or LCAM.

#### 🔄 Status Updates

Receive real-time order status updates from backend systems and propagate them to the appropriate client applications, ensuring seamless communication throughout the order lifecycle.

#### 🔀 Client Routing

Intelligent routing based on client identifiers with support for client-specific data transformations, business rules, and processing workflows.

#### 🛡️ Error Handling

Comprehensive error handling with automatic retry mechanisms in the Mule runtime. Errors are returned to customers for the order creation flow, and to backend systems for order updates, enabling graceful recovery and retry capabilities.

### Use Cases

- **Multi-Client Integration:** Single API endpoint serving multiple client organizations with customized requirements and workflows
- **Order Lifecycle Management:** End-to-end order tracking from creation through fulfillment
- **System Orchestration:** Seamless integration between client portals and backend order management systems
- **Real-Time Status Updates:** Bi-directional communication for order status changes

------

## API Architecture

### High-Level Architecture

```
┌──────────────────────────────────────────┐
│         Client Systems & Portals         │
│      (Web, Mobile, ERP Systems)          │
└────────────────┬─────────────────────────┘
                 │ HTTPS/REST
                 │
┌────────────────▼──────────────────────────────────┐
│      Standard Order Experience API                │
│   ┌──────────────────────────────────────────┐    │
│   │   APIKit Router (RAML Validation)        │    │
│   └─────────────┬────────────────────────────┘    │
│                 │                                 │
│   ┌─────────────▼────────────────────────────┐    │
│   │   Client Identification & Routing        │    │
│   │   • Parent Customer Number Resolution    │    │
│   │   • Dynamic Client Configuration         │    │
│   └─────────────┬────────────────────────────┘    │
│                 │                                 │
│   ┌─────────────▼────────────────────────────┐    │
│   │   Data Transformation Layer              │    │
│   │   • Schema Validation                    │    │
│   │   • Field Mapping & Truncation           │    │
│   │   • Client-Specific Transformations      │    │
│   │   • Sales Reference Number Generation    │    │
│   └─────────────┬────────────────────────────┘    │
└─────────────────┼────────────────────────────────┘
                  │
         ┌────────┴────────┐
         │                 │
    ┌────▼─────────┐  ┌────▼─────────┐
    │ DIMS System  │  │ LCAM System  │
    │ (Backend)    │  │ (Backend)    │
    └──────────────┘  └──────────────┘
```

### Integration Points

| Component | Purpose | Protocol | Authentication |
|-----------|---------|----------|----------------|
| **Backend Systems** | Core order processing and inventory management | REST/HTTPS | Basic Auth / OAuth 2.0 |
| **Database** | Sales reference number generation and configuration storage | JDBC | Username/Password |
| **Object Store** | OAuth token caching and session management | MuleSoft Runtime | N/A |

> **ℹ️ Architecture Pattern**
> This API follows the **MuleSoft API-Led Connectivity** approach as an **Experience Layer** API. It abstracts client-specific complexities and provides a consistent, easy-to-use interface while delegating core business processing to backend system APIs.

------

## API Endpoints

The API exposes three main endpoints for order creation and status management. All endpoints are prefixed with `/api/standard-order/`

------

### POST /order

**Flow Type:** Synchronous

**Response Code:** 201 Created

**Response Time:** ~2-5 seconds (typical)

**Authentication:** Basic Auth

#### Description

Creates a new order with synchronous processing. This endpoint provides immediate validation, processes the order, and returns confirmation upon successful submission to the backend system (DIMS or LCAM).

#### Features

- **Comprehensive Field Validation:** Enforces backend system field length and format requirements
- **Intelligent Client Routing:** Automatic routing based on parent customer number
- **Sales Reference Number Generation:** Auto-generates unique order reference numbers if not provided
- **Real-Time Processing:** Synchronous order creation with immediate confirmation

#### Request Example

**Endpoint:** `POST https://muleqc.diam.compucom.com/api/standard-order/order`

**Headers:**

`Content-Type: application/json`

`Authorization: Basic <base64-encoded-credentials>`

#### Response Example

**201 Created - Success Response**

```json
{
  "status": "Success",
  "salesRefNumber": "M0047665"
}
```

**400 Bad Request - Validation Error**

```json
{
    status : "Error",
    message: error description
}
```

------

### POST /orderUpdate

**Flow Type:** Synchronous

**Response Code:** 200 OK

**Retry Attempts:** 3 attempts with exponential backoff

**Authentication:** Client-Specific (Basic Auth or OAuth 2.0)

#### Description

Receives order status updates from backend systems (DIMS or LCAM) and routes them to the appropriate client systems. This endpoint handles various order lifecycle events including shipment notifications, invoice generation, and order completion.

#### Features

- **Automatic Retry Logic:** Built-in retry mechanism with exponential backoff for transient failures
- **OAuth Token Refresh:** Automatic token refresh for expired OAuth credentials
- **Multi-Client Routing:** Intelligent routing based on parent customer number
- **Comprehensive Status Updates:** Supports order status, shipment tracking, invoice details, and serial numbers

------

### POST /v2/order

**Flow Type:** Synchronous

**Response Code:** 201 Created

**Version:** 2.0

**Authentication:** OAuth 2.0

#### Description

This endpoint provides the same order creation functionality as `/order` but uses OAuth 2.0 authentication instead of Basic Auth.

------

## Data Models

### Create Order Request Schema

```json
{
  "order": [{
    "customerNumber": "string (optional, max 9)",
    "parentCustomerNumber": "string (required, max 14)",
    "entryDate": "string (required, format: MM/DD/YY)",
    "requestedDate": "string (required, format: MM/DD/YY)",
    "customerPONumber": "string (required, max 25)",
    "shipCustomerName": "string (required, max 35)"
  }]
}
```

------

## Authentication

The API supports two authentication methods to accommodate different client requirements and security policies.

### Supported Authentication Methods

#### 🔐 Basic Authentication

Traditional username and password authentication where credentials are base64-encoded in the `Authorization` header.

**Use Case:** Suitable for server-to-server integrations with secure credential storage.

#### 🎫 OAuth 2.0

Token-based authentication with automatic token refresh. Provides enhanced security with time-limited access tokens and refresh capabilities.

**Use Case:** Recommended for client applications, web portals, and integrations requiring enhanced security.

------

**Standard Order Experience API** | Version 1.0.0

Last Updated: June 15, 2026

Overview

🔍 View API Spec

The Standard Order Experience API serves as a centralized integration layer for managing device and inventory orders across multiple enterprise clients. It provides a unified interface for order processing, status updates, and workflow orchestration between client systems and backend order management platforms.

Key Capabilities

📝 Order Creation

Accept and process orders with comprehensive validation and intelligent routing to DIMS or LCAM backends

🔄 Status Updates

Real-time order status updates from backend systems propagated to client applications

🔀 Client Routing

Intelligent routing with client-specific data transformations and business rules

🛡️ Error Handling

Comprehensive error handling with automatic retry mechanisms for graceful recovery

Use Cases

Multi-Client Integration: Single API endpoint serving multiple client organizations
Order Lifecycle Management: End-to-end order tracking from creation through fulfillment
System Orchestration: Seamless integration between client portals and backend systems
Real-Time Status Updates: Bi-directional communication for order status changes

Architecture

The API follows the MuleSoft API-Led Connectivity approach as an Experience Layer, abstracting client-specific complexities and providing a consistent interface.

graph LR A["🖥️ Client Systems"] B["📡 Standard Order API"] C["🔍 APIKit Router"] D["🔀 Client Routing"] E["🔄 Data Transform"] F["⚙️ DIMS"] G["⚙️ LCAM"] A -->|HTTPS| B B --> C C --> D D --> E E --> F E --> G F -->|Updates| B G -->|Updates| B B -->|Response| A style A fill:#f0f9ff,stroke:#000099,stroke-width:2px style B fill:#fce7f3,stroke:#c12e6b,stroke-width:2px style C fill:#fce7f3,stroke:#c12e6b,stroke-width:2px style D fill:#fce7f3,stroke:#c12e6b,stroke-width:2px style E fill:#fce7f3,stroke:#c12e6b,stroke-width:2px style F fill:#fed7aa,stroke:#f98b1c,stroke-width:2px style G fill:#fed7aa,stroke:#f98b1c,stroke-width:2px

Environment URLs

Environment	Base URL
QC (Quality Control)	`https://muleqc.diam.compucom.com/api/standard-order/`
Production	`https://muleprod.diam.compucom.com/api/standard-order/`

Authentication

The API supports two authentication methods to accommodate different client requirements and security policies.

Basic Authentication

Traditional username and password authentication where credentials are base64-encoded in the Authorization header.

Use Case: Suitable for server-to-server integrations with secure credential storage.

Authorization: Basic <base64-encoded-credentials>

Supported Endpoints: POST /order, POST /orderUpdate

OAuth 2.0

Token-based authentication with automatic token refresh. Provides enhanced security with time-limited access tokens.

Use Case: Recommended for client applications, web portals, and integrations requiring enhanced security.

Authorization: Bearer <oauth-access-token>

Supported Endpoints: POST /v2/order, POST /orderUpdate

📋 Important: For username, password, client_id, and client_secret, contact the Compucom MuleSoft Team.

API Endpoints

The API exposes three main endpoints for order creation and status management:

📤 POST /order

POST Basic Auth

Synchronous order creation with immediate validation and confirmation.

Response: 201 Created | Time: ~2-5 seconds

curl -X POST \
  https://muleqc.diam.compucom.com/api/standard-order/order \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic YXBpX3VzZXI6YXBpX3Bhc3N3b3Jk" \
  -d '{
    "order": [{
      "parentCustomerNumber": "799249461",
      "entryDate": "08/26/20",
      "requestedDate": "08/26/20",
      "customerPONumber": "PO-2020-08-001",
      "shipCustomerName": "John Doe",
      "shipAddress1": "123 Main St",
      "shipCity": "New York",
      "shipState": "NY",
      "shipZipCode": "10001",
      "shipCountry": "US",
      "orderDetails": [
        {
          "orderLine": 1,
          "quantityOrdered": 1,
          "price": 100.00,
          "itemNumber": "ITEM001",
          "description": "Test Product"
        }
      ]
    }]
  }'

✓ Success Response (201 Created)

{
  "status": "Success",
  "salesRefNumber": "M0047665"
}

📤 POST /v2/order

POST OAuth 2.0

Same as /order but with OAuth 2.0 authentication for enhanced security.

Response: 201 Created | Maintained for API versioning

curl -X POST \
  https://muleqc.diam.compucom.com/api/standard-order/v2/order \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -d '{
    "order": [{
      "parentCustomerNumber": "799249461",
      "entryDate": "08/26/20",
      "requestedDate": "08/26/20",
      ...
    }]
  }'

# Same request body structure as /order endpoint above

🔄 POST /orderUpdate

POST Basic Auth / OAuth 2.0

Bi-directional status updates from backend systems to client applications.

Response: 200 OK | Retries: 3 with exponential backoff

Receives order status, shipment tracking, invoice details, and serial numbers from DIMS or LCAM backends.

📋 Note: View detailed request/response examples in the API Specification.

Error Handling & Retry Logic

Automatic Retry: Failed requests are automatically retried up to 3 times with exponential backoff (1s, 2s, 4s intervals)
Connectivity Issues: Automatic recovery for network failures
OAuth Token Refresh: Automatic token refresh for expired credentials
Timeout Handling: 30-second timeout per attempt with automatic retry

Error Response Example:

{
  "status": "Error",
  "message": "Missing required field: parentCustomerNumber"
}
            

Support & Resources

Documentation: Full API specifications, data models, and field validation rules available in the API Specification
Support Email: CompucomMuleSoftSupport@compucom.com
MuleSoft Portal: Anypoint Exchange

View API Specification

Standard Order API 2.0

Overview

Key Capabilities

Use Cases

Architecture

Environment URLs

Authentication

Basic Authentication

OAuth 2.0

API Endpoints

📤 POST /order

📤 POST /v2/order

🔄 POST /orderUpdate

Error Handling & Retry Logic

Support & Resources