> ## Documentation Index
> Fetch the complete documentation index at: https://developer.oplog.one/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with OPLOG.ONE API in minutes

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 an OAuth 2.0 token in the header.

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

<AccordionGroup>
  <Accordion title="Basic Product Create">
    Here is a sample request to create a basic product:

    <Note>
      Make sure to pass the `X-Tenant-Id` and `StaticToken` in the header.
    </Note>

    <CodeGroup>
      ```json POST /openapi/v1/products theme={null}
      {
        "sku": "BASIC-001",
        "barcodes": [
          "1234567890125",
          "9876543210983"
        ],
        "name": "Coffee Cup",
        "type": "Product"
      }
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Receiving Order Create">
    Below is a sample request to create a receiving order:

    <Note>
      Make sure to pass the `X-Tenant-Id` and `StaticToken` in the header.
    </Note>

    <CodeGroup>
      ```json POST /openapi/v1/receiving-orders theme={null}
      {
        "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"
        }
      }
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Sales Order Create">
    Here is a sample request to create a sales order:

    <Note>
      Make sure to pass the `X-Tenant-Id` and `StaticToken` in the header.
    </Note>

    <CodeGroup>
      ```json POST /openapi/v1/sales-orders theme={null}
      {
        "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"
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>

## 3. Use Cases

Get started with the OPLOG.ONE API with detailed guides for your use case.

<CardGroup cols="2">
  <Card title="Product Management" icon="box" href="/use-cases/products">
    Build your product inventory.
  </Card>

  <Card title="Receiving Order Management" icon="clipboard-list" href="/use-cases/receiving-orders">
    Manage incoming order processes.
  </Card>

  <Card title="Sales Order Management" icon="shopping-cart" href="/use-cases/sales-orders">
    Handle sales and order fulfillment.
  </Card>

  <Card title="Return Management" icon="undo" href="/use-cases/returns">
    Process returns and refunds.
  </Card>

  <Card title="Customer Management" icon="users" href="/use-cases/customers">
    Organize customer relationships.
  </Card>

  <Card title="Track Shipments" icon="chart-mixed" href="/use-cases/tracking">
    Monitor logistics operations.
  </Card>
</CardGroup>