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

Return order detail

GET
/api/v1/public/return-orders/detail/{{return_tracking_code}}
This API endpoint is used to retrieve detailed information about a specific return order, based on a unique return_tracking_code.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/return-orders/detail/{{return_tracking_code}}' \
--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

Header Params

Responses

🟢200OK
application/json
Body

Previous
List return order
Next
Create return order
Built with