Quickstart - OPLOG.One Documentation

This quickstart guide intends to walk you through a few common scenarios to let you understand how to use the OPLOG.ONE API.

1. Get API key

Oplog.one verifies a user’s request by using a Auth2.0 token in the header. We call this method. On the Oplog.one dashboard, go to Integrations > OpenAPI to set up the integration. Once the integration is complete, you will be provided with an X-Tenant-Id and a StaticToken for Authorization. Copy and securely store this information, as we will use it in the next step. If you do not have an Oplog.one account yet, you can contact our support team to create a staging account.

2. Common scenarios

Basic Product Create

Here is a sample request to create a basic product:

Make sure to pass the X-Tenant-Id and StaticToken in the header.

{
  "sku": "BASIC-001",
  "barcodes": [
    "1234567890125",
    "9876543210983"
  ],
  "name": "Coffee Cup",
  "type": "Product"
}

Receiving Order Create

Below is a sample request to create a receiving order:

Make sure to pass the X-Tenant-Id and StaticToken in the header.

{
  "referenceNumber": "REC-CARGO-001",
  "lineItems": [
    {
      "sku": "LAPTOP-001",
      "expectedQuantity": 5
    },
    {
      "sku": "MOUSE-001",
      "expectedQuantity": 10
    }
  ],
  "transferType": "CargoTransfer",
  "cargoTransfer": {
    "shipmentDate": "2025-06-20T14:30:00.000Z",
    "cargoCompanyName": "FedEx",
    "trackingNumber": "726123456789"
  }
}

Sales Order Create

Here is a sample request to create a sales order:

Make sure to pass the X-Tenant-Id and StaticToken in the header.

{
  "referenceNumber": "ORD-2025-001",
  "salesChannel": "mystore.com",
  "orderCreatedAt": "2025-06-17T10:13:41.479Z",
  "customer": {
    "email": "customer@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "phone": "+12125551234"
  },
  "shippingAddress": {
    "addressFirstName": "John",
    "addressLastName": "Smith",
    "addressOne": "123 Main Street, Apt 45",
    "addressTwo": "Unit 8",
    "district": "Manhattan",
    "city": "New York",
    "country": "United States",
    "addressPhone": "+12125551234"
  },
  "billingAddress": {
    "addressFirstName": "John",
    "addressLastName": "Smith",
    "addressOne": "123 Main Street, Apt 45",
    "district": "Manhattan",
    "city": "New York",
    "country": "United States",
    "addressPhone": "+12125551234"
  },
  "lineItems": [
    {
      "amountInOrder": 2,
      "sku": "LAPTOP-001",
      "productSalePrice": 1200.00,
      "currency": "USD"
    }
  ],
  "payment": {
    "paymentOption": "Paid",
    "totalPaymentAmount": 2400.00,
    "currency": "USD"
  },
  "cargo": {
    "cargoType": "RegularDelivery"
  }
}