Get Archived Orders

📘

Get Archived Orders 使用場景

SHOPLINE 將依據訂單狀態封存超過一定期限的訂單資料（訂單封存條件可參考 FAQ 說明）

因此當使用 Get Order 、Get Orders 透過指定 訂單 ID 的方式抓取訂單資料，訂單資料標示如下時，則表示該訂單已封存，則需透過 Get Archived Orders 取得訂單資料

• Get Order - 收到 410 response (請參閱 Get Order)
• Get Orders - response 中標註已封存訂單 (請參閱 Get Orders)

如欲拿取超過兩年以上的訂單資料，也需要使用 Get Archived Orders 取得訂單資料

Function

To search archived orders with specific conditions.
利用條件搜尋冷區訂單，並且透過 Webhook 方式通知。
由於冷區匯出所需要的時間比較長，以下 API 會使用非同步的形式設計。
詳情可以參考流程圖

Sequence Diagram

Required API Auth

Get Archived Order

URL

POST https://open.shopline.io/v1/orders/archived_orders

Request Parameter

🚧

Callback_url 驗證

當封存訂單處理完成後，將透過 webhook 發送 Callback parameter 至對應的 callback_url。為確保 callback_url 正確性將會進行驗證，詳請參閱 Webhook Verification

Request example

curl -X POST https://open.shopline.io/v1/orders/archived_orders \
-H "Content-Type: application/json" \
-d '{
  "filters": {
    "start_date": "2024-07-29T16:00:00.000Z",
    "end_date": "2024-07-31T16:00:00.000Z"
  },
  "callback_url": "http://your-callback-url.com"
}'

Response fields

Response example

{
 	"message": [
    {
      "job_id": "66716227f0216707b1b9eaaa",
      "start_date": "2024-07-29T16:00:00.000Z",
      "end_date": "2024-07-31T16:00:00.000Z"
    },
    {
      "job_id": "66716227f0216707b1b9eabc",
      "start_date": "2024-07-31T16:00:00.000Z",
      "end_date": "2024-08-31T16:00:00.000Z"
    }
	]
}

Callback Method

We will use post method

Callback parameter

CSV Fields

csv 範例檔案請參考 csv sample file，可取用的欄位資訊說明如下：