v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Orders

Search Orders

To search orders with specific conditions. 利用特殊條件搜尋訂單列表。

get/orders/search

Query parameters

pageinteger

Page 頁數（第n頁） (Default: 1)

per_pageinteger

Numbers of Orders per page 每頁顯示 n 筆資料 (Default: 24, Max: 999) - *If there're many orders, it's suggested to set per_page number to 50 如果訂單眾多，建議per_page至多設定50

order_numberstring

訂單號碼 (order_number, merchant_order_number)

customer_idstring

顧客 ID

customer_emailstring

顧客電郵

namestring

顧客、收件人名稱 (customer_name, delivery_address.recipient_name, delivery_data.recipient_name)

phone_numberstring

電話號碼 (customer_phone, delivery_data.recipient_phone)

delivery_data_tracking_numberstring

配送資料追蹤編號

promotion_idstring

促銷活動 ID

item_idstring

訂單項目 ID

previous_idstring

To fetch data for the next page, include the ID of the last order from the previous page. 用於拿取下一分頁資料，請帶入前一分頁的最後一筆訂單 ID When fetching orders for the first page, this parameter is not required. 拿取第一頁訂單時，可以不用帶此參數

querystring

Support query order fields 支援搜尋以下欄位 product_name order_number customer_id customer_name customer_phone customer_email delivery_address.recipient_name delivery_data.recipient_name delivery_data.recipient_phone delivery_data.tracking_number promotion_id item_id*

search_fieldsstring

Targeted search fields 搜尋欄位 Default to 'default' Values allow default Support query order fields 支援搜尋以下欄位 product_name order_number customer_id customer_name customer_phone customer_email delivery_address.recipient_name delivery_data.recipient_name delivery_data.recipient_phone delivery_data.tracking_number promotion_id item_id* phone_number Support query order fields 支援搜尋以下欄位 customer_phone delivery_data.recipient_phone order_number Support query order fields 支援搜尋以下欄位 order_number merchant_order_number customize_customer_info Support query order fields 支援搜尋以下欄位 customer_info.value social_user_name Support query order fields 支援搜尋以下欄位 social_user_name

shipped_beforestring

Filter orders by those shipped before specific time. 取得 shipped_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

shipped_afterstring

Filter orders by those shipped after specific time. 取得 shipped_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

arrived_beforestring

Filter orders by those arrived before specific time. 取得 arrived_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

arrived_afterstring

Filter orders by those arrived after specific time. 取得 arrived_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

collected_beforestring

Filter orders by those collected before specific time. 取得 collected_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

collected_afterstring

Filter orders by those collected after specific time. 取得 collected_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

returned_beforestring

Filter orders by those returned before specific time. 取得 returned_at 小於指定時間的訂單(包含指定時間) - should use UTC time Note: Will only show returned status updated after 2019-06-01 在2019/06/01之後產生的退貨狀態才能被搜尋出來

returned_afterstring

Filter orders by those returned after specific time. 取得 returned_at 大於指定時間的訂單(包含指定時間) - should use UTC time Note: Will only show returned status updated after 2019-06-01 在2019/06/01之後產生的退貨狀態才能被搜尋出來

cancelled_beforestring

Filter orders by those cancelled before specific time. 取得 cancelled_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

cancelled_afterstring

Filter orders by those cancelled after specific time. 取得 cancelled_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

paid_beforestring

Filter orders by those paid before specific time. 取得 paid_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

paid_afterstring

Filter orders by those paid after specific time. 取得 paid_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

updated_beforestring

Filter orders by those updated before specific time. 取得 updated_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

updated_afterstring

Filter orders by those updated after specific time. 取得 updated_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

status'pending' | 'removed' | 'confirmed' | 'completed' | 'cancelled'

Status 訂單狀態 - Status allow pending 處理中 removed 已刪除 confirmed 已確認 completed 已完成 cancelled 已取消

statuses[]string[]

Statuses 多個訂單狀態 - Status allow pending 處理中 removed 已刪除 confirmed 已確認 completed 已完成 cancelled 已取消

payment_idstring

Payment Method ID 付款方式ID

Payment Status 付款狀態 - Payment status allows pending 未付款(包含 temp 暫存狀態) failed 付款失敗 expired 超過付款時間 completed 已付款 refunding 退款中 refunded 已退款 partially refunded 已部分退款

delivery_option_idstring

Delivery Option ID 物流方式ID

Delivery Status 物流狀態 - Delivery status allows pending 備貨中 shipping 發貨中 shipped 已發貨 arrived 已到達 collected 已取貨 returned 已退貨 * returning 退貨中

delivery_statuses[]string[]

Delivery Statuses 多個物流狀態 - Delivery status allows pending 備貨中 shipping 發貨中 shipped 已發貨 arrived 已到達 collected 已取貨 returned 已退貨 returning 退貨中

affiliate_data[affiliate_source]string

Keys allow to search: * affiliate_source(String)訂單來源 (第三方夥伴適用)

created_beforestring

Filter orders by those updated before specific time. 取得 created_at 小於指定時間的訂單(包含指定時間) - *should use UTC time

created_afterstring

Filter orders by those created after specific time. 取得 created_at 大於指定時間的訂單(包含指定時間) - *should use UTC time

created_bystring

Filter orders by those created by specific channel. 取得特定由渠道建立的訂單

order_by'asc' | 'desc'

Order responses items by created time in ascending/descending order. 訂單按訂單創造日期順序或倒序排序。 If sort_by is passed, Order the record by the sort_by value in asc/desc order. 如果傳入sort_by，則按照sort_by的參數順序或倒序排序。

sort_by'created_at' | 'total'

Sort responses items by created_at or total. 訂單按訂單創造日期或商品總價排序。 If order_by is not passed, by default showing records in descending order. 如果沒有傳入order_by, 則按倒序排序。

include_fields[]string[]

Provide additional attributes in the response 結果添加哪些參數

v1

Search Orders

Query parameters

Response