API Docs
Home
References
  • Product API
  • Product Inventory API
Home
References
  • Product API
  • Product Inventory API
  1. API
  2. Order Return
  • Overview
  • Getting Started
  • Common Errors
  • API
    • Config
      • List Pickup Address
      • List Box Dimension
      • List vendor
      • List store
    • Product
      • Options
        • List category
        • List brand
      • Create Single Product
      • List product
      • Product detail
      • Create Product From Product Inventory
    • Product Inventory
      • Options
        • List Outbound Strategy
        • List Product Type
        • List Material
        • List Storage Method
      • List product inventory
      • Product inventory detail
      • Create single inventory product
    • Order
      • Shipping Service
        • Preview shipping prices
          • List available courier
          • List shipping service
        • List available courier from order
        • List shipping service of courier
      • Create order B2C
      • Create order B2B
      • List order
      • Order detail
      • Cancel order
    • Shipment
      • Create shipment auto
      • Cancel shipment
      • [Retail][Ship by self] Create shipment with item
    • Shipment Inbound
      • Create shipment inbound
      • List shipment inbound
      • Shipment inbound detail
      • Shipment inbound items
    • Courier
      • List courier service integrated
      • List courier operate
      • List courier integrated
    • Address Directory
      • Province
      • District
      • Ward
    • Order Return
      • List return order
        GET
      • Return order detail
        GET
      • Create return order
        POST
  • Status
    • SHIPMENT INBOUND
    • ORDER
    • SHIPMENT
    • RETURN
  • Webhooks
    • WebHook connection required
    • HOOK EVENT ORDER CREATED
    • HOOK EVENT ORDER UPDATE STATUS
    • HOOK EVENT SHIPMENT CREATED
    • HOOK EVENT SHIPMENT UPDATE STATUS
    • HOOK EVENT INBOUND UPDATE STATUS
    • HOOK EVENT INBOUND CREATED
    • HOOK EVENT STOCK UPDATE
  1. API
  2. Order Return

Return order detail

Developing
GET
/api/v1/public/return-orders/detail/{{return_tracking_code}}
Last modified:2025-04-05 01:54:40
This API endpoint is used to retrieve detailed information about a specific return order, based on a unique return_tracking_code.

Request

Header Params
Authorization
string 
optional
Default:
6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://stg-oms.nandh.vn/api/v1/public/return-orders/detail/{{return_tracking_code}}' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ=='

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
object 
optional
id
integer 
optional
Unique ID of the return order (334)
country
string 
optional
Country code (VN for Vietnam)
currency
string 
optional
Currency used (VND)
platform
string 
optional
Sales channel (retail)
group_platform
string 
optional
return_tracking_code
string 
optional
Internal tracking code for the return (NHRV1908341217)
partner_tracking_code
null 
optional
partner_id
null 
optional
courier_tracking_code
string 
optional
Courier tracking number (JXT09890-1)
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
Original order tracking code (NHOV1908761573)
use_insurance
boolean 
optional
can_check_content
boolean 
optional
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
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
}
Modified at 2025-04-05 01:54:40
Previous
List return order
Next
Create return order
Built with