Key features

The Swagger/OpenAPI documentation provides complete API definition schemas, organized API groups, and powerful search functionality to help developers quickly find and understand Sterling™ Order Management System Software REST APIs.

Complete API definition schemas

Every API includes comprehensive schema information.

Request schema

  • Field names: All input parameters are clearly labeled.
  • Data types: String, number, boolean, array, and object.
  • Required fields: Visual "required" tags on mandatory fields.
  • Descriptions: Business context for each field.
  • Constraints: Length limits, patterns, and allowed values.
  • Nested structures: Complex objects with multiple levels.

Response schema

  • Complete structure: Full response object definition.
  • Data types: Accurate type information for all fields.
  • Descriptions: Meaning of each response field.
  • Examples: Sample response payloads.

Organized API groups

APIs are divided into logical groups for easy navigation.

Table 1. Available API groups
Group Description Example APIs
YCP - Application Platform Core platform APIs for order management, inventory, and customers. getOrderDetails, checkInventory, manageCustomer
YCD - Application Add-in Additional application features and competitor management. getCompetitor, postCompetitor
OMP - Distributed Order Management Multi-node order orchestration and promising. promiseOrder, allocateOrder
INV - Global Inventory Visibility Cross-enterprise inventory visibility. getInventoryAvailability, reserveInventory
WMS - Warehouse Management Warehouse operations and fulfillment. createReceipt, createPickTicket, confirmShipment
YSC - Supply Chain Management Supply chain planning and execution. getSupplyChain, updateSupplyPlan
YCM - Catalog Management Product catalog and item management. getItem, updateItem, manageCategory
YDM - Delivery Management Delivery scheduling and tracking. scheduleDelivery, trackDelivery
YPM - Pricing Management Pricing rules and calculations. getPrice, applyPricing
VAS - Value Added Services Additional services and customizations. getService, executeService
MISC - Miscellaneous Other utility and helper APIs. getSystemInfo, healthCheck

Powerful search functionality

The documentation includes a powerful search feature that works across all API groups simultaneously.

Search capabilities

  • Search by API name: Find APIs by their operation name. For example, type "shipment" to find createShipment, getShipmentDetails, and updateShipment.
  • Search across all modules: One search covers all API groups. You do not need to search each group separately.
  • Method-based filtering: Results show HTTP method with color coding.
    • GET: Green badge (retrieve data)
    • POST: Blue badge (create or submit data)
    • PUT: Yellow badge (update data)
    • PATCH: Light red badge (partial update)
    • DELETE: Red badge (remove data)
  • Instant navigation: Click a result to load the correct API group, scroll directly to the selected API, and highlight it for easy identification.

How to use the search feature

  1. Type at least 2 characters in the search box.
  2. Results appear instantly as you type.
  3. Click any result to navigate directly to that API.

Search features

  • Keyboard shortcuts: Press ESC to clear the search.
  • Auto-complete: Results update as you type.
  • No minimum wait: Instant results.
  • Clear button: Click ✕ to clear the search text.
  • Click outside: Click anywhere to close the results dropdown.