Onflow Open API
    • Getting Started
    • Overall logic
    • Error code
    • API
      • Config
        • Get Warehouse
        • Get Brand
        • Get Province
        • Get District
        • Get Ward
        • Upload file
      • Product
        • Create Product
        • Assign Product
        • Get Product List
        • Get Product Detail
        • Get Stock
        • Deactivate Product
      • PO
        • Create PO
        • Get PO List
        • Get PO Bill
        • Get PO Detail
        • Get PO Inspection Detail
        • Cancel PO
      • Shipment
        • B2C Shipment
          • Create B2C Shipment
          • Get B2C Shipment List
          • Get B2C Shipment Detail
          • Cancel B2C Shipment
        • B2C Return shipment
          • Create Return B2C Shipment
          • Get Return B2C Shipment List
          • Get Return B2C Shipment Detail
          • Cancel Return B2C Shipment
    • Webhook
      • Shipment
        • Updated Shipment Status
      • Return
        • Updated Return Status
      • PO
        • Updated PO Status
      • Stock
        • Updated Stock

    Getting Started

    Getting Started – Open API#

    This guide walks you through the basic steps to start using the Open API.

    Step 1: Register an account#

    Go to: https://stg-oms.onflow.vn
    Register a new account.

    Step 2: Select API account type#

    During the registration process, choose Customer type = API User
    This account type is dedicated for system integration via Open API.

    Step 3: Contact Customer Support for approval#

    After successful registration, please contact Customer Support (CS) to:
    Verify your information
    Approve and enable API access for your account
    ⚠️ Note: Only approved accounts are allowed to access Open API.

    Step 4: Log in to OMS and obtain an access token#

    Log in to OMS using your approved API account
    Navigate to: Settings → Developer Tools
    Generate or retrieve your Access Token from the system
    Use this token in the request header when calling APIs
    Example:
    Base URL STG: https://stg-open-api.onflow.vn

    Important Notes#

    For Open API user, OMS is limited to the following functions:
    API Key management.
    Webhook configuration.
    Access to management portal for exporting reports.
    For optional fields, it is not required to include the field name in the request payload.
    For transitions from Open API user to OMS user, or vice versa, please contact Technical Team for system configuration support.
    Login is only permitted after the account has been approved by Customer Support team.
    Automatic API Key rotation is not supported. API Keys must be manually reset through the Developer Tools module when required.
    Rate limit: 600 request/minute -> 10 requests/second
    Modified at 2026-04-28 04:23:55
    Next
    Overall logic
    Built with