API Docs
Home
Home
  1. Home
  • Overview
  • Getting Started
  • Common Errors
  • API
    • Config
      • List Pickup Address
      • List Box Dimension
      • List vendor
      • List store
    • Online Product
      • Options
        • List category
        • List brand
      • Create Single Product
      • List product
      • Product detail
      • Create Product From Product Inventory
    • Product Inventory
      • Options
        • List Outbound Strategy
        • List Product Type
        • List Material
        • List Storage Method
      • List product inventory
      • Product inventory detail
      • Create single inventory product
    • Order
      • Shipping Service
        • Preview shipping prices
          • List available courier
          • List shipping service
        • List available courier from order
        • List shipping service of courier
      • Create order B2C
      • Create order B2B
      • List order
      • Order detail
      • Cancel order
    • Shipment
      • Create shipment auto
      • Cancel shipment
      • [Retail][Ship by self] Create shipment with item
    • Shipment Inbound
      • Create shipment inbound
      • List shipment inbound
      • Shipment inbound detail
      • Shipment inbound items
    • Courier
      • List courier service integrated
      • List courier operate
      • List courier integrated
    • Address Directory
      • Province
      • District
      • Ward
    • Order Return
      • List return order
      • Return order detail
      • Create return order
  • Status
    • SHIPMENT INBOUND
    • ORDER
    • SHIPMENT
    • RETURN
  • Webhooks
    • WebHook connection required
    • HOOK EVENT ORDER CREATED
    • HOOK EVENT ORDER UPDATE STATUS
    • HOOK EVENT SHIPMENT CREATED
    • HOOK EVENT SHIPMENT UPDATE STATUS
    • HOOK EVENT INBOUND UPDATE STATUS
    • HOOK EVENT INBOUND CREATED
    • HOOK EVENT STOCK UPDATE
  1. Home

Overview

Open API (version 1.0)
Welcome to N&H Logistics API Document
API OMS (Order Management System) refers to a set of application programming interfaces designed to interact with an order management system. An OMS is a digital system that facilitates and manages the order lifecycle from order creation to fulfillment. The APIs for an OMS provide a standardized way for different applications to communicate with the OMS, enabling automation, integration, and enhanced efficiency.
Here's an overview of what an API OMS typically involves:

Core Functions of API OMS#

1.
Order Creation and Management:
Create Order: Allows the creation of new orders.
Update Order: Modifies existing orders.
Cancel Order: Cancels orders that have not yet been fulfilled.
Get Order Details: Retrieves information about specific orders.
2.
Inventory Management:
Check Inventory Levels: Retrieves current stock levels for products.
Update Inventory: Adjusts inventory levels based on new stock or sales.
3.
Fulfillment and Shipping:
Create Shipment: Generates shipment details for an order.
Update Shipment Status: Updates the status of a shipment (e.g., shipped, delivered).
Track Shipment: Provides tracking information for shipped orders.
4.
Customer Management:
Create Customer: Adds new customer details to the system.
Update Customer: Modifies existing customer information.
Get Customer Details: Retrieves customer information.

Integration and Usage#

APIs allow different systems, such as e-commerce platforms, warehouses, and ERP systems, to integrate seamlessly with the OMS. This integration enables:
Automation: Automating order processing and inventory updates reduces manual work and errors.
Real-Time Data: Accessing real-time data for orders, inventory, and shipments ensures up-to-date information.
Scalability: Handling a large volume of orders and inventory efficiently.
Flexibility: Adapting to various business models and requirements through customizable workflows.

Security and Compliance#

When working with API OMS, it's crucial to ensure:
Authentication and Authorization: Secure access using methods like OAuth or API keys.
Data Encryption: Protecting data in transit and at rest.
Compliance: Adhering to industry standards and regulations, such as PCI DSS for payment processing.

Conclusion#

An API OMS is a powerful tool for businesses looking to streamline their order management processes. By providing a robust and flexible interface, it enables efficient integration, automation, and management of the entire order lifecycle.
Modified at 2024-07-30 07:00:56
Next
Getting Started
Built with