Get Return Orders

Get Return Order API

Request Params

Field	Type	Description	Example
status_filter	`String`	Status (optional) 狀態	`confirmed`
payment_status_filter	`String`	Payment Status (optional) 支付狀態	`pending`
delivery_status_filter	`String`	Delivery Status (optional) 物流狀態	`returning`
created_before	`String`	filter return order by before specific created time 篩選指定時間前創建的退貨單	`2020-01-01`
created_after	`String`	filter return order by after specific created time 篩選指定時間後創建的退貨單	`2020-01-01`
updated_before	`String`	filter return order by before specific updated time 篩選指定時間前更新的退貨單	`2020-01-01`
updated_after	`String`	filter return order by after specific updated time 篩選指定時間後更新的退貨單	`2020-01-01`

Response Fields

Field	Type	Description	Example
items	Return Order	Return Order 退單單資訊	Please checkout the link on the left
pagination	Pagination	Pagination Data 頁面訊息	Please checkout the link on the left

Response Example

{
   "items" : [
      {
         "created_at" : "2021-06-02T12:18:29.606+00:00",
         "customer_email" : "[email protected]",
         "customer_id" : null,
         "customer_name" : "asd",
         "delivery_address" : null,
         "delivery_data" : null,
         "id" : "60b77715808cd8004387c6ed",
         "inspect_status" : null,
         "items" : [],
         "max_return_total" : {
            "cents" : 0,
            "currency_iso" : "HKD",
            "currency_symbol" : "HK$",
            "dollars" : 0,
            "label" : "HK$0.00"
         },
         "order" : null,
         "order_delivery" : null,
         "order_delivery_status" : "returning",
         "order_id" : "6049dff0647ad00045eed112",
         "order_payment" : null,
         "order_payment_status" : "pending",
         "promotion_items" : [],
         "return_order_number" : "2021060212182917",
         "returned_by" : null,
         "status" : "confirmed",
         "total" : {
            "cents" : 120502,
            "currency_iso" : "HKD",
            "currency_symbol" : "HK$",
            "dollars" : 1205.02,
            "label" : "HK$1,205.02"
         },
         "updated_at" : "2021-06-02T12:18:29.813+00:00"
      },
      ...
   ],
   "pagination" : {
      "current_page" : 1,
      "per_page" : 24,
      "total_count" : 11,
      "total_pages" : 1
   }
}

Request Sample

curl --location --request GET '<<api_domain>>/v1/return_orders/' \
--header 'Authorization: Bearer ${token}'