1. Changelog
Omisell Developer Portal | API Documentation & Integration Guides
  • Authentication
  • Common Errors
  • Overview
    • Introduction
    • Push Mechanism
    • Status overview
    • Accounting - API Call Flow
    • ERP Integration Flow
    • API Rate Limits
    • Guide: Direct Integration
    • MCP Server
    • Pagination
  • Changelog
    • ๐Ÿ” API Security Upgrade
    • Orders
    • Returns Order
    • Products
    • Shipments
    • Push mechanism
  • API Refference
    • Location
      • Get Country List
      • Get Province List By Country
      • Get District List By Province
      • Get SubDistrict List By District
    • Product
      • Get Product Category
      • Get Product List
      • Add Product
      • Get Product Detail
      • Update Product Detail
      • Get Product Detail by SKU
      • Update Product Detail by SKU
    • Inventory
      • Adjust Stock
      • Delisted Stock
      • Adjust Stock(Old)
    • Serial Number
      • Adjust Serial Number
    • Catalogue
      • Get Catalogue List
      • Get Catalogue Detail
    • Orders
      • Get Order List
      • Add Order
      • Update Document Order
      • Get Order Detail
      • Update Order
      • Cancel Order
      • Get Order Finance
      • Get Returns Receiving Note
      • Get Goods Receipts
    • Returns Order
      • Get Returns Order List
      • Add Order Return
      • Get Return Order Detail
    • Shipments
      • Get Shipment List
      • Add Shipment
      • Update Document Shipment
      • Update Shipment Status
      • Get Shipment Detail
    • Order Dropship
    • Pickup Address
      • Get Pickup List
      • Get WMS Pickup Map
    • Shop
      • Get Shop List
    • Finance
      • Get Order Revenue
      • Get Order Return Revenue
    • Customer
      • Get Customer Review List
    • Public
      • Get Seller by Partner
  • Webhooks
    • Order Status Push
    • Return Order Status Push
    • Shipment Status Push
    • Sale Invoice Request
  • eCommerce Platform
    • PrestaShop
    • Magento
    • Shopify
    • Woocommerce
    • Zalora
  1. Changelog

Returns Order

03/11/2026 ยท Add vendor_pickup_code and vendor_return_code#

New field Non-breaking
APINew field
Get Return Order Detail ยนreturn_inventory_items[].vendor_pickup_code
Get Return Order Detail ยนreturn_inventory_items[].vendor_return_code
ยน Also Add Order Return.
Each code sits right after its id: vendor_pickup_id โ†’ vendor_pickup_code, vendor_return_id โ†’ vendor_return_code.
Value
PK + (id + 100000), the same code GET /pickup/list shows. null when the id is null.
{ "vendor_pickup_id": 21, "vendor_pickup_code": "PK100021", "vendor_return_id": 22, "vendor_return_code": "PK100022" }

08/10/2026 ยท Add esku and unit_name to return inventory items#

New field Non-breaking
APINew fields
Get Return Order Detail ยนreturn_inventory_items[].esku, return_inventory_items[].unit_name
ยน Also Add Order Return.
FieldValue
eskuERP SKU of the inventory product. "" when the product has no ERP code.
unit_nameStock unit, e.g. Thรนng, Hแป™p. null when the product has no unit set.
NOTE
Both are null when the return line is not linked to an inventory product.
{ "order_item_id": 987654321, "inventory_sku": "SRM-100", "esku": "ERP-SRM-100", "unit_name": "Hแป™p", "quantity": 1 }

01/10/2026 ยท Add order_item_id to return catalogue and inventory items#

New field Non-breaking
The same catalogue_sku can sit on several lines of one order, so catalogue_sku alone cannot tell which return line an inventory row belongs to.
APINew fieldMeaning
Get Return Order Detail ยนreturn_catalogue_items[].order_item_idID of the original order line. null when the return line is not linked to an order line.
Get Return Order Detail ยนreturn_inventory_items[].order_item_idThe catalogue line this inventory row belongs to
ยน Also Add Order Return.
How to use
Match return_inventory_items to return_catalogue_items by order_item_id.
"return_catalogue_items": [
  { "order_item_id": 987654321, "catalogue_sku": "COMBO-01", "quantity": 1 },
  { "order_item_id": 987654322, "catalogue_sku": "COMBO-01", "quantity": 1 }
],
"return_inventory_items": [
  { "order_item_id": 987654321, "inventory_sku": "SRM-100" },
  { "order_item_id": 987654322, "inventory_sku": "SRM-100" }
]

02/09/2026 ยท Rename omisell_order_return_number to omisell_return_order_number#

Rename Breaking
APIBeforeAfter
Get Order Return Revenueorder_return.omisell_order_return_numberorder_return.omisell_return_order_number
The new name is the spelling every other returns endpoint already used (Get Returns Order List, Get Return Order Detail, Add Order Return, the returns webhook). The value is unchanged โ€” the Omisell return code, e.g. RTNVN26081234ABCDEF.
WARNING
This is a rename, not an alias: the old key is gone from the response. If your integration reads omisell_order_return_number from this endpoint, update it. Everywhere else the field was already named omisell_return_order_number, so nothing else changes.

03/09/2025 ยท Add shipment numbers and vendor_return_id#

New field Non-breaking
APINew fields
Get Return Order Detailreturn_inventory_items[].omisell_shipment_number, wms_order_number, vendor_return_id
{ "omisell_shipment_number": "string", "wms_order_number": "string", "vendor_return_id": 0 }

24/04/2025 ยท Add fail_reason_type#

New field Non-breaking
APINew fieldValues
Get Return Order Detailfail_reason_typeSee Return reason type
{ "fail_reason": "string", "fail_reason_type": "string" }
Modified atย 2026-11-03 04:42:23
Previous
Orders
Next
Products
Built with