OPLOG’s Returns API provides comprehensive return management capabilities for tracking and processing product returns. This guide covers the essential requirements, query methods, and examples for managing different types of return scenarios.

​
Integration Overview

The Returns API is designed to handle the complete return lifecycle:
  • Return Tracking - Query return status and processing stages
  • Warehouse Integration - Real-time updates when packages arrive
  • State Management - Track returns from creation to completion
  • Reference Matching - Connect returns to original sales orders
All return operations use GET endpoints since the return process begins when packages physically arrive at the warehouse. The system tracks real-world return events and provides query capabilities for status monitoring.

​
Return Process Flow

Important Note: Return Endpoint UsageIn the OPLOG system, in real life, the return process begins when the package physically arrives at the warehouse. Therefore, the GET endpoint should be used for return operations.
1

ReturnCreated (Return Created)

  • Warehouse staff requested a return
  • arrivedToWarehouseAt and completedAt fields are null
2

ArrivedToWarehouse (Arrived at Warehouse)

  • Package arrived at warehouse
  • Warehouse staff processed package entry
  • arrivedToWarehouseAt field was populated
  • Return processing started
3

Completed (Completed)

  • Return process completed
  • Product was inspected and restocked/disposed
  • completedAt field was populated

​
Return States

The return process follows these states:

ReturnCreated

Return record created in the system

ArrivedToWarehouse

Package arrived at warehouse facility

Completed

Return process completed successfully

​
Query Methods

For querying actual return statuses, always use the GET endpoint as returns are processed based on physical package arrivals.

​
Basic Return Query

Query all returns in the system: 
GET /openapi/v1/Returns

​
Query by Sales Order Reference

Find returns for a specific sales order: 
GET /openapi/v1/Returns?salesOrderReferenceNumber=RSO100490909

​
Query by Return Reference Number

Find a specific return by its reference number: 
GET /openapi/v1/Returns?returnReferenceNumber=Return-14844

​
Query by State

Find returns in a specific processing state: 
GET /openapi/v1/Returns?state=ArrivedToWarehouse

​
Query by Tracking ID

Find a return using its tracking ID: 
GET /openapi/v1/Returns?trackingId=1201450414625470014100902000010011

​
Response Fields

Date Format: All dates are in ISO 8601 format with timezone information.

​
Common Use Cases

​
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 Returns

Return Reason

Tag by reason: defective, wrong-size, customer-change, damaged

Processing Priority

Mark urgency: urgent-refund, priority-return, standard

Product Category

Categorize items: electronics, apparel, fragile, bulk-return

Action Required

Next steps: refund-pending, exchange-requested, investigate
TAG Usage Examples:
  • Reason Tags: defective-product,wrong-size,customer-dissatisfaction,damaged-shipping
  • Priority Tags: urgent-refund,priority-return,vip-customer,high-value
  • Category Tags: electronics,apparel,cosmetics,books,fragile-item
  • Process Tags: quality-check-required,refund-approved,exchange-pending
  • Analysis Tags: frequent-returner,seasonal-return,promotion-related
TAG management for returns enables detailed return analysis, automated workflows, and improved customer service through categorized processing.