API Reference

Welcome to OPLOG.ONE API

The OPLOG.ONE API provides comprehensive logistics and supply chain management capabilities through a RESTful interface. Our API enables businesses to integrate powerful logistics operations including product management, order processing, inventory tracking, and shipping coordination.

Products API

Manage your product catalog with comprehensive inventory control

Sales Orders API

Process orders with multiple payment methods and shipping options

Receiving Orders API

Handle incoming inventory with flexible transfer configurations

Returns API

Streamline return processing and customer service operations

Environments

OPLOG.ONE provides two separate environments. Each environment has its own base URL, credentials, and data — they are completely isolated from each other.

Production
Staging

Base URL

https://api.oplog.one/openapi/v1

The production environment is your live system. All API requests here affect real orders, shipments, and inventory.Example Request

curl -X GET "https://api.oplog.one/openapi/v1/Products" \
  -H "X-Tenant-Id: your-tenant-id" \
  -H "Authorization: Bearer your-static-token" \
  -H "Content-Type: application/json"

Only use production after you have fully tested your integration in the staging environment.

Base URL

https://api.staging.oplog.one/openapi/v1

The staging environment is a safe sandbox for development and testing. No real shipments are created and no live data is affected.Example Request

curl -X GET "https://api.staging.oplog.one/openapi/v1/Products" \
  -H "X-Tenant-Id: your-staging-tenant-id" \
  -H "Authorization: Bearer your-staging-static-token" \
  -H "Content-Type: application/json"

Don’t have a staging account yet? Contact our support team at [email protected] to get started. See the Staging Environment guide for full setup details.

Production and staging credentials are not interchangeable. Never use production credentials in staging or vice versa.

Authentication

OPLOG.ONE uses OAuth 2.0 authentication with tenant-specific tokens. Every API request must include the following headers:

X-Tenant-Id: your-tenant-id
Authorization: Bearer your-static-token
Content-Type: application/json

Header	Description
`X-Tenant-Id`	Your unique tenant identifier, provided during integration setup
`Authorization`	Bearer token using your StaticToken
`Content-Type`	Must be `application/json` for all requests

Ensure you include both X-Tenant-Id and Authorization headers in every request. Missing authentication will result in a 401 Unauthorized error.

Response Format

All API responses follow a consistent JSON structure:

Success Response

{
  "data": {
    // Response data
  },
  "status": "success"
}

Error Response

{
  "error": {
    "code": 400,
    "message": "Validation Errors",
    "errors": [
      {
        "property": "fieldName",
        "message": "Error description",
        "errorCode": "ErrorCode"
      }
    ]
  },
  "requestId": "unique-request-id",
  "timestamp": "2025-06-24T13:37:00.123Z"
}

For detailed error codes and descriptions, see our Error Reference documentation.

API Documentation

Endpoints

Welcome to OPLOG.ONE API

Products API

Sales Orders API

Receiving Orders API

Returns API

Environments

Authentication

Response Format

Success Response

Error Response

​Welcome to OPLOG.ONE API

Products API

Sales Orders API

Receiving Orders API

Returns API

​Environments

​Authentication

​Response Format

​Success Response

​Error Response

Welcome to OPLOG.ONE API

Environments

Authentication

Response Format

Success Response

Error Response