DispatchOne Solution

Order API

5min

Overview

The Order API allows users to create and manage orders in the logistics system. It provides endpoints to create new orders and retrieve existing order details. This API is designed for integration with applications requiring order management functionalities.

Feature List

  • Order Creation: Ability to create new orders with essential details like origin, destination, and order items.
  • Order Management : Features to update existing orders, change status, and manage order lifecycle.
  • Order Tracking: Real-time tracking of orders from creation to delivery.
  • Order Prioritization: Ability to set and manage order priorities (e.g., High, Medium, Low).
  • Line Item Management: Detailed management of line items within an order, including quantities, weights, and volumes.
  • Callback URL: Option to specify a callback URL for notifications related to order status updates.

Use Cases : Learn Why you should use Order API

  • E-commerce Fulfillment: Managing customer orders from placement to delivery in an e-commerce platform.
  • Supply Chain Management: Streamlining the order handling process for suppliers and manufacturers.
  • Logistics Coordination: Coordinating shipments and deliveries based on customer orders and logistics constraints.
  • Emergency Response: Prioritizing orders during emergencies or urgent situations for rapid response.

Base URL

JS


Replace {domain} with the assigned tenant-specific domain.

Authentication

The Order API requires authentication via specific headers:

  • X-COREOS-REQUEST-ID: Unique request identifier (required).
  • X-COREOS-TID: Tenant ID (required).
  • X-COREOS-ACCESS: Core-OS access token (required).
  • X-COREOS-USERINFO: Core-OS user info token (required).