API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Order Return
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
      GET
    • Return order detail
      GET
    • Create return order
      POST
    • Cancel Return Order
      PATCH
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Order Return

List return order

GET
/api/v1/public/return-orders/list
This API endpoint is used to fetch a list of return orders from the system. Return orders are typically orders that customers have returned or requested to return for various reasons, such as dissatisfaction with the product, shipping errors, or other return policies.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/return-orders/list?page=1&page_size=50&created_from={{$date.timestamp|addDays(-30)}}&created_to={{$date.timestamp}}' \
--header 'Authorization;'
Response Response Example
{
    "status_code": 0,
    "data": [
        {
            "id": 0,
            "country": "string",
            "currency": "string",
            "platform": "string",
            "group_platform": "string",
            "return_tracking_code": "string",
            "partner_tracking_code": null,
            "partner_id": null,
            "courier_tracking_code": "string",
            "partner_created_time": 0,
            "partner_updated_time": 0,
            "partner_reason_type": null,
            "return_warehouse_provider": "string",
            "return_fulfillment_provider": "string",
            "tax_paid_by": "string",
            "fee_paid_by": "string",
            "status": 0,
            "status_update_time": 0,
            "is_seller_own_fleet": true,
            "is_platform_own_fleet": true,
            "shipping_provider": "string",
            "reason": "string",
            "reason_type": "string",
            "refund_amount": "string",
            "order_partner_tracking_code": "string",
            "use_insurance": true,
            "can_check_content": true,
            "note": null,
            "order_shipping_provider": "string",
            "push_3pl_success": true,
            "push_3pf_success": true,
            "created_time": 0,
            "updated_time": 0,
            "user": 0,
            "business": 0,
            "updated_by": 0,
            "created_by": 0,
            "return_address": {
                "id": 0,
                "pickup_name": "string",
                "contact_name": "string",
                "phone": "string",
                "address": "string",
                "pickup_code": "string",
                "fulfillment_provider_name": "string",
                "warehouse_provider_name": "string",
                "is_fulfill_self": true,
                "is_fulfill_3pf": true
            },
            "store": {
                "id": 0,
                "name": "string",
                "logo": null,
                "platform": "string",
                "platform_logo": "string"
            },
            "courier_integration": 0,
            "courier": {
                "id": 0,
                "prefix": "string",
                "name": "string",
                "description": "string",
                "logo": "string",
                "tracking_url": null,
                "rating": 0,
                "is_fulfill_now": true,
                "is_seller_own_fleet": true,
                "use_lib": null,
                "is_platform_own_fleet": true
            },
            "courier_service": {
                "name": "string",
                "estimate_time": "string",
                "is_fulfill_now": true
            },
            "courier_ship": {
                "id": 0,
                "prefix": "string",
                "name": "string",
                "description": "string",
                "logo": "string",
                "tracking_url": null,
                "rating": 0,
                "is_fulfill_now": true,
                "is_seller_own_fleet": true,
                "use_lib": null,
                "is_platform_own_fleet": true
            },
            "order_tracking_code": "string",
            "status_display": "string",
            "reason_type_display": "string",
            "platform_logo": "string",
            "status_css": "string",
            "can_confirm": true,
            "can_cancel": true,
            "can_edit": true,
            "is_retail": true,
            "is_marketplace": true,
            "can_confirm_complaint_completed": true,
            "order_return_items": [
                0
            ],
            "order_return_pickup": {
                "country": "string",
                "fullname": "string",
                "email": "string",
                "phone": "string",
                "address": "string",
                "address2": null,
                "zipcode": null,
                "lat": null,
                "lng": null,
                "order_return": 0,
                "province": 0,
                "district": 0,
                "ward": 0
            },
            "total_sku": 0,
            "total_qty_items": 0,
            "total_sent_quantity": 0,
            "total_return_quantity": 0,
            "total_received_quantity": 0,
            "total_damaged_quantity": 0,
            "total_lost_quantity": 0,
            "total_images": 0
        }
    ],
    "error": true,
    "error_code": null,
    "log_id": null,
    "messages": "string",
    "total": 0
}

Request

Query Params
page
string 
optional
Example:
1
page_size
string 
optional
Example:
50
created_from
integer 
optional
Example:
{{$date.timestamp|addDays(-30)}}
created_to
integer 
optional
Example:
{{$date.timestamp}}
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
array [object {64}] 
optional
id
integer 
optional
Return order ID: 334
country
string 
optional
Country: VN (Vietnam)
currency
string 
optional
Currency used: VND
platform
string 
optional
Sales platform: retail
group_platform
string 
optional
Internal tracking code for the return: NHRV1908341217
return_tracking_code
string 
optional
Courier tracking number: JXT09890-1
partner_tracking_code
null 
optional
Original order tracking: NHOV1908761573
partner_id
null 
optional
courier_tracking_code
string 
optional
partner_created_time
integer 
optional
partner_updated_time
integer 
optional
partner_reason_type
null 
optional
return_warehouse_provider
string 
optional
return_fulfillment_provider
string 
optional
tax_paid_by
string 
optional
fee_paid_by
string 
optional
status
integer 
optional
status_update_time
integer 
optional
is_seller_own_fleet
boolean 
optional
is_platform_own_fleet
boolean 
optional
shipping_provider
string 
optional
reason
string 
optional
reason_type
string 
optional
refund_amount
string 
optional
order_partner_tracking_code
string 
optional
use_insurance
boolean 
optional
false — Insurance not used
can_check_content
boolean 
optional
false — Content inspection not allowed
note
null 
optional
order_shipping_provider
string 
optional
push_3pl_success
boolean 
optional
push_3pf_success
boolean 
optional
created_time
integer 
optional
updated_time
integer 
optional
user
integer 
optional
business
integer 
optional
updated_by
integer 
optional
created_by
integer 
optional
return_address
object 
optional
store
object 
optional
courier_integration
integer 
optional
courier
object 
optional
courier_service
object 
optional
courier_ship
object 
optional
order_tracking_code
string 
optional
status_display
string 
optional
reason_type_display
string 
optional
platform_logo
string 
optional
status_css
string 
optional
can_confirm
boolean 
optional
can_cancel
boolean 
optional
can_edit
boolean 
optional
is_retail
boolean 
optional
is_marketplace
boolean 
optional
can_confirm_complaint_completed
boolean 
optional
order_return_items
array[integer]
optional
order_return_pickup
object 
optional
total_sku
integer 
optional
total_qty_items
integer 
optional
total_sent_quantity
integer 
optional
total_return_quantity
integer 
optional
total_received_quantity
integer 
optional
total_damaged_quantity
integer 
optional
total_lost_quantity
integer 
optional
total_images
integer 
optional
error
boolean 
optional
error_code
null 
optional
log_id
null 
optional
messages
string 
optional
total
integer 
optional
Previous
Shipment inbound items
Next
Return order detail
Built with