1. Webhooks
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
      POST
    • Return Order Status Push
      POST
    • Shipment Status Push
      POST
    • Sale Invoice Request
      POST
  • eCommerce Platform
    • PrestaShop
    • Magento
    • Shopify
    • Woocommerce
    • Zalora
  1. Webhooks

Return Order Status Push

POST
/webhook-url
This is the cus payload format (HookCus.format_type = "cus", the default). A subscription created with a different format_type receives a different, much larger payload — ask Omisell before assuming this shape.
Delivery: POST with Content-Type: application/json and Authorization: <client secret> (the raw secret, no scheme prefix). request_id is generated per delivery attempt. Redirects are not followed — answer 2xx directly. Retries: up to 5, exponential backoff starting at 5 minutes.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Header Params

Body Params application/json

Examples

Responses

🟢200Your endpoint answers 2xx
application/json
Your endpoint must return exactly 200. deliver_hook_cus treats every other code — including 201, 202 and 204 — as a FAILURE and retries it (5 attempts: 5 / 10 / 20 / 40 / 80 minutes). Note that the hook health monitor counts any 2xx as a success, so an endpoint returning 204 is retried and still reported as healthy. Redirects are not followed — a 3xx is recorded as a response, not followed.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.omisell.com/webhook-url' \
--header 'Seller-ID;' \
--header 'Country;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "omisell_return_order_number": "RTNVN2606030D62FE4C",
        "return_order_number": "RTNVN2606030D62FE4C",
        "order_number": "EMP2_F230_SDALazada13",
        "shop_id": 11305,
        "status_id": 800,
        "status_name": "Returned",
        "created_time": 1780478979.0,
        "updated_time": 1780479063.0
    },
    "shop_id": 11305,
    "seller_id": 27001999,
    "platform": "retail",
    "event": "order_return.refund_paid",
    "timestamp": 1788315800,
    "request_id": "68b6f1c4a90c3e7f2d41b9e7"
}'
Response Response Example
{}
Modified at 2026-11-03 04:22:17
Previous
Order Status Push
Next
Shipment Status Push
Built with