HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Return Order

Fields Summary

FieldTypeDescriptionExample
idStringReturn Order ID
退貨單ID
60d587097f9f98004407864e
return_order_numberString退貨單號2021060212182917
statusStringStatus
狀態
totalMoney
order_idStringOrder ID
訂單ID
delivery_addressDelivery Address
inspect_status
customer_idStringCustomer Id
顧客ID
customer_nameStringCustomer Name
顧客名字
customer_emailStringCustomer Email
顧客電郵
[email protected]
order_deliveryOrder DeliveryOrder Delivery Information
送貨資訊
Please check the link on the left
delivery_dataDelivery DataThird-Party Delivery Information
第三方串接物流資訊
Please check the link on the left
order_paymentOrder PaymentOrder Payment Information
付款資訊
Please check the link on the left
order_payment_statusStringOrder Payment Status
訂單支付狀態
order_delivery_statusStringOrder Delivery Status
訂單物流狀態
itemsArray
promotion_itemsArray
order
returned_byStringReturned By
發起退貨人
admin
max_return_totalMoney
created_atArrayReturn Order Created At
退貨單創建時間
2021-01-01T00:00:00.000+00:00
updated_atArrayReturn Order Updated At
退貨單更新時間
2021-06-02T12:18:29.606+00:00

Response Sample

{
   "created_at" : "2021-06-02T12:18:29.606+00:00",
   "customer_email" : "[email protected]",
   "customer_id" : "5f86b66201afcd0c83557f18",
   "customer_name" : "asd",
   "delivery_address" : {
      "address_1" : "",
      "address_2" : "",
      "city" : "",
      "country" : "",
      "country_code" : "",
      "district" : null,
      "key" : null,
      "layer1" : null,
      "layer2" : null,
      "layer3" : null,
      "logistic_codes" : null,
      "postcode" : "",
      "recipient_name" : "asd",
      "recipient_phone" : "+12345677",
      "remarks" : null,
      "state" : null
   },
   "delivery_data" : {
      "hk_sfplus_home_region" : null,
      "location_code" : null,
      "location_name" : null,
      "name_translations" : {},
      "scheduled_delivery_date" : null,
      "store_address" : null,
      "time_slot_key" : null,
      "tracking_number" : null,
      "url" : 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" : null,
   "order_id" : "6049dff0647ad00045eed112",
   "order_payment" : null,
   "order_payment_status" : null,
   "promotion_items" : [],
   "return_order_number" : "2021060212182917",
   "returned_by" : "admin",
   "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"
}