Skip to main content
OPLOG’s Receiving Order API enables you to initiate the receiving process for products to be sent to the warehouse. This guide covers the essential requirements, configurations, and examples for creating different types of receiving orders.

​
Integration Overview

The Receiving Order API is designed to handle multiple transfer methods:
  • Cargo Transfer - Shipment via cargo companies (FedEx, UPS, DHL)
  • Pickup Transfer - Pickup from your warehouse or location
  • Carriage Transfer - Courier delivery services
  • Multi-Product Shipments - Bulk receiving orders with multiple SKUs
All receiving orders must include unique reference numbers, line items with SKUs and expected quantities, and transfer type configuration. Products must be pre-registered in the system using the Product API.

​
Creating Receiving Orders

OPLOG’s Receiving Order POST endpoint has several required fields that you need to be aware of:

Quick Start Requirements

Essential Fields: Reference number, line items (SKU + expected quantity), and transfer type configuration are mandatory for all receiving orders.
1

Pre-register Products

Ensure all SKUs are registered in the system using the Product API
2

Set Reference Number

Define a unique identifier for tracking the receiving order
3

Configure Line Items

Specify SKUs and expected quantities for products to be received
4

Select Transfer Type

Choose appropriate delivery method and provide required details

​
Core Requirements

{
  "referenceNumber": "REC-CARGO-001"  // Unique receiving order identifier
}
Requirements:
  • Must be unique for each receiving order
  • Traceable and meaningful coding is recommended
  • Suggested format: REC-[TYPE]-[SEQUENCE]
Examples:
  • "REC-CARGO-001" ✅ (Cargo shipment)
  • "REC-PICKUP-002" ✅ (Pickup transfer)
  • "REC-COURIER-003" ✅ (Courier delivery)
{
  "lineItems": [
    {
      "sku": "LAPTOP-001",        // Product SKU
      "expectedQuantity": 5       // Expected quantity to receive
    },
    {
      "sku": "MOUSE-001",
      "expectedQuantity": 10
    }
  ]
}
Required Fields:
  • sku - SKU value of the product registered in the system
  • expectedQuantity - Number of units you plan to send
Requirements:
  • SKUs must be pre-registered in the system using Product API
  • Expected quantity must be a positive integer
  • Multiple products can be included in single order
Products must be created beforehand with OPLOG Product API before creating receiving orders.
{
  "transferType": "CargoTransfer"  // Delivery method
}
Available Transfer Types:“CargoTransfer” - Shipment via cargo companies
  • Requires: shipmentDate, cargoCompanyName, trackingNumber
  • Best for: Large shipments, long-distance delivery
“PickupTransfer” - Pickup from warehouse
  • Requires: pickupDate, pickupAddress
  • Best for: Local deliveries, direct handover
“CarriageTransfer” - Courier delivery
  • Requires: shipmentDate, carriageCompanyName, waybillNumber
  • Best for: Express delivery, valuable items

​
Transfer Type Configurations

{
  "transferType": "CargoTransfer",
  "cargoTransfer": {
    "shipmentDate": "2025-06-20T14:30:00.000Z",
    "cargoCompanyName": "FedEx",
    "trackingNumber": "726123456789"
  }
}
Required Fields:
  • shipmentDate - When the cargo will be shipped (ISO 8601 format)
  • cargoCompanyName - Name of the cargo company
  • trackingNumber - Cargo tracking number
Common Cargo Companies:
  • "FedEx", "UPS", "DHL", "USPS"
  • Local carriers like "Aras Kargo", "MNG Kargo"
{
  "transferType": "PickupTransfer",
  "pickupTransfer": {
    "pickupDate": "2025-06-18T09:00:00.000Z",
    "pickupAddress": "Main Street Industrial Complex, Block 1 No:23, Brooklyn/New York"
  }
}
Required Fields:
  • pickupDate - When the pickup will occur (ISO 8601 format)
  • pickupAddress - Complete address for pickup location
Best Practices:
  • Provide detailed address including building/unit numbers
  • Include contact information if needed
  • Schedule during business hours
{
  "transferType": "CarriageTransfer",
  "carriageTransfer": {
    "shipmentDate": "2025-06-17T16:00:00.000Z",
    "carriageCompanyName": "Express Courier",
    "waybillNumber": "EX123456789"
  }
}
Required Fields:
  • shipmentDate - When the courier will ship (ISO 8601 format)
  • carriageCompanyName - Name of the courier company
  • waybillNumber - Courier waybill/tracking number
Use Cases:
  • High-value items requiring special handling
  • Express same-day or next-day delivery
  • Fragile or sensitive products

​
Date Format Requirements

All date fields must be in ISO 8601 format with timezone information.
Current Scheduling Requirements:For requests before June 17, 2025 1:00 PM (UTC+0):
  • Dates should be between June 18, 2025 6:00 AM and 2:00 PM
For requests after June 17, 2025 3:00 PM (UTC+0):
  • Dates should be between June 19, 2025 6:00 AM and 2:00 PM
Format Requirements:
  • Use ISO 8601 format: "2025-06-20T14:30:00.000Z"
  • Include timezone information (recommended)
  • Future dates should be used
  • Business hours are preferred (6:00 AM - 2:00 PM UTC)

​
Quantity Tracking

Use the GET Receiving Orders API to track accepted quantities vs. expected quantities.
Expected vs Accepted Quantities:
  • expectedQuantity - Number you plan to send
  • acceptedQuantity - Number OPLOG actually received (from GET API)
Usage:
{
  "lineItems": [
    {
      "sku": "LAPTOP-001",
      "expectedQuantity": 5    // What you're sending
    }
  ]
}
GET Response:
{
  "sku": "LAPTOP-001",
  "expectedQuantity": 5,
  "acceptedQuantity": 4      // What was actually received
}
The acceptedQuantity represents the number that will be added to sellable stocks for this product.

​
Receiving Order Examples

Standard cargo shipment with multiple products.
{
  "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"
  }
}
Pickup directly from your location.
{
  "referenceNumber": "REC-PICKUP-002",
  "lineItems": [
    {
      "sku": "PHONE-001",
      "expectedQuantity": 15
    },
    {
      "sku": "CASE-001",
      "expectedQuantity": 15
    }
  ],
  "transferType": "PickupTransfer",
  "pickupTransfer": {
    "pickupDate": "2025-06-18T09:00:00.000Z",
    "pickupAddress": "Main Street Industrial Complex, Block 1 No:23, Brooklyn/New York"
  }
}
Express courier delivery for valuable items.
{
  "referenceNumber": "REC-COURIER-003",
  "lineItems": [
    {
      "sku": "WATCH-001",
      "expectedQuantity": 3
    }
  ],
  "transferType": "CarriageTransfer",
  "carriageTransfer": {
    "shipmentDate": "2025-06-17T16:00:00.000Z",
    "carriageCompanyName": "Express Courier",
    "waybillNumber": "EX123456789"
  }
}
Large apparel shipment with multiple SKUs and sizes.
{
  "referenceNumber": "REC-MULTI-004",
  "lineItems": [
    {
      "sku": "TSHIRT-S",
      "expectedQuantity": 20
    },
    {
      "sku": "TSHIRT-M",
      "expectedQuantity": 25
    },
    {
      "sku": "TSHIRT-L",
      "expectedQuantity": 15
    },
    {
      "sku": "JEANS-30",
      "expectedQuantity": 10
    },
    {
      "sku": "JEANS-32",
      "expectedQuantity": 12
    }
  ],
  "transferType": "CargoTransfer",
  "cargoTransfer": {
    "shipmentDate": "2025-06-19T10:00:00.000Z",
    "cargoCompanyName": "UPS",
    "trackingNumber": "UPS987654321"
  }
}

​
TAG Management

OPLOG.ONE’s TAG management system provides flexible metadata tagging capabilities across various business entities. Organizations can attach custom labels to records, transforming basic data into actionable intelligence for better workflow optimization. The system proves valuable for both operational efficiency and analytics. Teams can quickly identify and process records based on specific criteria - staff can locate items requiring special handling, managers can prioritize high-value transactions, and leadership can analyze performance metrics across different categories. This flexible approach eliminates rigid classification systems, allowing businesses to evolve their tagging strategies as operational needs change.

​
TAG Best Practices for Receiving Orders

Priority Level

Tag by urgency: urgent, high-priority, standard, low-priority

Supplier Category

Categorize suppliers: priority-supplier, new-vendor, overseas

Product Type

Mark product categories: seasonal-stock, electronics, fragile

Processing Notes

Add handling instructions: quality-check, immediate-shelving
TAG Usage Examples:
  • Seasonal Tags: summer-collection,winter-stock,holiday-items
  • Supplier Tags: priority-supplier,new-vendor,trusted-partner
  • Product Tags: fragile,electronics,apparel,bulk-items
  • Process Tags: quality-check,immediate-processing,hold-for-review
TAG management for receiving orders helps streamline warehouse operations, supplier management, and inventory planning processes.