본문으로 건너뛰기
Version: 3.0

Inventory API v2

Inventory API v2

Overview​

The Inventory API v2 is a comprehensive solution for managing inventory, orders, and related business operations. This RESTful API provides a wide range of functionalities to support inventory management, order processing, customer management, and more.

Key Features​

  • Inventory Management: Allows creation, updating, and tracking of inventory items, including stock levels and item attributes.
  • Location Operations: Supports stock transfers, adjustments, and bin locations.
  • Order Processing: Manages sales orders, purchase orders, and shipments.
  • Customer Management: Supports customer profile creation and management.
  • Vendor Management: Handles vendor relationships and catalogues.
  • Build Management: Manages product builds or assemblies.
  • Bill of Materials (BOM): Manages product structures and component relationships.
  • Reporting and Analytics: Provides data export capabilities for analysis.

Authentication​

This API supports API Key authentication method:

API Key Authentication: For developer access, users can request an API key. This key should be included in the request headers for authentication.

To use API key authentication, you need to generate API key first.

  • Login to ianaiERP
  • Click your name on the top right corner
  • Go to Settings -> Connections -> API Keys
  • Click + button and name it as you want.
  • Copy the API key and the secret to clipboard
  • Decode the secret in base64.
  • Use the API key and the decoded secret in the request header:

IANAI-API-KEY: <your_api_key> IANAI-SECRET: <your_secret_base64_decoded>

Rate Limiting​

Please note that rate limiting may be applied to protect our services from abuse. Specific limits are not detailed in this documentation, but clients should be prepared to handle rate limiting responses.

Environments​

The API is available in the following environments:

  • https://api-dev.ianai.co/v2
  • https://api.ianaierp.com/v2

Data Formats​

The API accepts and returns data in JSON format. Ensure that the Content-Type: application/json header is set for requests with a body.

Pagination​

List endpoints support pagination using limit and offset parameters. Default values may apply if not specified.

Error Handling​

The API uses standard HTTP status codes to indicate the success or failure of requests. Detailed error messages are provided in the response body for easier troubleshooting.

HTTP Status Codes and Error Responses​

  • 400 Bad Request

    • Custom Code: invalid_request
    • Description: Missing data, length issues, exceeded limits, or business logic errors
    • UI Message: Uses the description received from the server

  • 401 Unauthorized

    • Custom Code: login

    • Description: User not found or password mismatch

    • UI Message: "Email or password is incorrect"

    • Custom Code: invalid_token

    • Description: Token expired or invalid

    • UI Message: "Token is invalid or expired"

  • 403 Forbidden

    • Custom Code: no_permission

    • Description: User lacks required permission

    • UI Message: "You don't have a {permission} permission"

    • Custom Code: ip_ban

    • UI Message: "Network activity issues have been detected. Access from the same network may be restricted."

    • Custom Code: inactive

    • Description: Entity is inactive

    • UI Message: "{entity} is inactive"

  • 404 Not Found

    • Custom Code: no_content
    • Description: Requested entity not found
    • UI Message: "The requested {entity} could not be found"

  • 409 Conflict

    • Custom Code: duplicated
    • Description: Entity already exists
    • UI Message: Create appropriate error message where API was called

  • 429 Too Many Requests

    • Custom Code: rate_limit
    • Description: Rate limit exceeded
    • UI Message: "Rate limit exceeded"

  • 500 Internal Server Error

    • Custom Code: internal
    • Description: Server error
    • UI Message: Use default error message on the front end

  • 504 Gateway Timeout

    • Custom Code: timeout
    • Description: Request timed out
    • UI Message: "The request timed out. Please try again later."

Error responses will include detailed information in the response body to assist with debugging and error handling on the client side.

Support​

For additional support or questions about the API, please contact our developer support team.

License​

This API is provided under a commercial license. For full terms and conditions, please visit https://www.ianaierp.com.

We continuously strive to improve our API. Your feedback is valuable to us as we work on enhancing the functionality and user experience of our Inventory Management solution.

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

License

Commercial