---
title: "Get Orders"
method: GET
path: "/orders"
tags: ["Orders"]
---

# Get Orders

`GET /orders`

To get detailed information of couple orders sorted by time<br>利用時間範圍選取與排序獲取數筆訂單資料

## Query parameters

- `default_visible_channels` boolean
- `updated_after` string
- `updated_before` string
- `created_after` string
- `created_before` string
- `order_ids` string[]
- `previous_id` string
- `page` integer
- `per_page` integer
- `sort_by` 'asc' | 'desc'
- `customer_id` string
- `include_fields[]` string[]

## Response `200`

OK

- object
  - `items` Order[]
    - `id` string — Order ID<br>訂單ID
    - `order_number` string — Order Number<br>訂單號碼
    - `system_order_number` string — 系统生成的訂單號
    - `merchant_order_number` string — 店家自定義訂單號<br>(會根據rollout_key選擇用哪個order_number)
    - `status` 'temp' | 'pending' | 'removed' | 'confirmed' | 'completed' | 'cancelled' — Order Status<br>訂單狀態<br> -<br> 網店訂單 Status allows:<br> temp 暫存狀態<br> pending 處理中<br> removed 已刪除<br> confirmed 已確認<br> completed 已完成<br> cancelled 已取消<br> <br> POS 訂單 Status allows:<br> confirmed 已確認<br> completed 已完成<br> cancelled 已取消<br>
    - `is_guest_checkout` boolean — 是否為訪客結帳
    - `order_remarks` string — Order Remarks<br>訂單備註
    - `order_payment` object — Order Payment Information<br>付款資訊
      - `payment_method_id` string — Payment Method ID<br>付款方式ID
      - `ref_payment_id` string — 3rd party payment reference ID
      - `payment_type` 'ecpay' | 'bank_transfer' | 'cash_on_delivery' | 'custom tw_711_b2c_pay' | 'tw_711_pay' | 'sl_logistics_ninjavan_cod' | 'sl_logistics_kerry_th_cod' | 'sl_logistics_ghtk_cod' | 'sl_logistics_janio_cod' | 'sl_logistics_poslaju_cod' — Payment Method<br>付款方式
      - `name_translations` object — Payment Method Name<br>付款方式之名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `status` 'pending' | 'failed' | 'expired' | 'completed' | 'refunding' | 'refunded' — Payment Status<br>付款狀態<br><br> Payment status allows:<br> pending 未付款<br> failed 付款失敗<br> expired 超過付款時間<br> completed 已付款<br> refunding 退款中<br> refunded 已退款
      - `payment_fee` object — Payment Fee<br>附加費
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `total` object — Payment Total<br>付款金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `paid_at` string — Paid Time<br>付款完成時間<br>(UTC +0)
      - `updated_at` string — Updated Time related to change of payment<br>付款更新時間<br>(UTC +0)
      - `created_at` string — Created Date<br>訂單創造時間<br>(UTC +0)
      - `payment_data` object — Payment Details Info<br>付款詳細資訊<br>(如有串接第三方金流)<br><br>Please refer to the example below
      - `last_four_digits` string — Credit Card Last Four Digits.<br>信用卡後四碼
      - `payment_slips_setting` object — Setting for payment slips.<br>付款明細設定
      - `shopline_payment_payment` string
      - `expire_time` number — Expiry time of the payment, in days.<br>失效時間，以天作為單位。
    - `order_delivery` object — Order Delivery Information<br>送貨資訊
      - `id` string — Order Delivery ID<br>訂單配送ID
      - `delivery_option_id` string — Delivery Option ID<br>送貨方式ID
      - `platform` string — Delivery platform<br>送貨方式類別
      - `status` 'pending' | 'shipping' | 'shipped' | 'arrived' | 'collected' | 'returned' | 'returning' — Delivery Status<br>送貨狀態<br><br> Status allows:<br> pending 備貨中<br> shipping 發貨中<br> shipped 已發貨<br> arrived 已到達<br> collected 已取貨<br> returned 已退貨<br> * returning 退貨中
      - `delivery_status` 'arrived' | 'collected' | 'expired' | 'failed' | 'pending' | 'request_accepted' | 'request_authorized' | 'request_submitted' | 'returned' | 'returning' | 'returning_store_closed' | 'shipped' | 'store_closed' — Logistic Service Order Status<br>配送狀態<br><br> Status allows:<br> arrived 已到達<br> collected 已取貨<br> expired 已過出貨期限<br> failed 失敗<br> pending 未執行<br> request_accepted 可供出貨<br> request_authorized 待處理<br> request_submitted 處理中<br> returned 已退貨<br> returning 退貨中<br> returning_store_closed 退貨門市關轉<br> shipped 已出貨<br> * store_closed 門市關閉
      - `name_translations` object — 送貨方式名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `total` object — Delivery fee<br>運費
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `shipped_at` string — Shipped Time<br>已送貨時間<br>(UTC +0)
      - `arrived_at` string — Arrived Time<br>已到達時間<br>(UTC +0)
      - `collected_at` string — Collected Time<br>已取貨時間<br>(UTC +0)
      - `returned_at` string — Returned Time<br>已退貨時間<br>(UTC +0)
      - `updated_at` string — Updated Time<br>更新時間<br>(UTC +0)
      - `remark` string — Order remark<br>訂單出貨備註
      - `request_accepted_at` string — Logistic accepted shipment time<br>物流商收到出貨時間
      - `request_authorized_at` string — Logistic authorized shipment time<br>物流商接受出貨時間
      - `request_submitted_at` string — Logistic proceeded shipment time<br>物流商處理出貨時間
      - `requested_fmt_at` string — Shipment execution time (Family Mart)<br>執行出貨時間 (全家)
      - `return_order_id` string — Return order ID<br>退貨訂單編號
      - `store_closed_at` string — Pick up store closed time<br>訂單取貨門市關轉時間
      - `require_expired_upload` boolean — Check if delivery needs reupload and schedule aggregation upload
      - `require_storeclosed_upload` boolean — whether scheduled upload to 7-11 B2C FTP, SUP
      - `storeclosed_upload_at` string — prevent duplicated update storeclosed (EIN.36) for 7-11 B2C
      - `exp_type` string — exp type
      - `requires_customer_address` boolean — Whether the customer address is required<br>是否需要顧客提供地址
    - `delivery_address` object — Recipient Information<br>收件人基本資訊
      - `country_code` string, nullable — Country Code<br>國家代碼
      - `country` string, nullable — Country<br>國家
      - `city` string, nullable — City<br>城市
      - `district` string, nullable — City<br>地區
      - `state` string, nullable — Stage or Region<br>州/省/地區
      - `postcode` string, nullable — ZIP code<br>郵政編號
      - `address_1` string, nullable — Address 1<br>地址 1
      - `address_2` string, nullable — Address 1<br>地址 2<br>(這裡原則上會自動帶入地址所在行政區)
      - `key` string, nullable
      - `layer1` string, nullable
      - `layer2` string, nullable
      - `layer3` string, nullable
      - `logistic_codes` string[]
      - `recipient_name` string, nullable — Recipient Name<br>收件人姓名
      - `recipient_phone` string, nullable — Recipient Phone<br>收件人電話號碼
      - `recipient_phone_country_code` string, nullable — Recipient Phone Country Code<br>收件人電話號碼國碼
      - `remarks` string, nullable — Remark<br>備註
    - `delivery_data` object — Third-Party Delivery Information<br>第三方串接物流資訊
      - `hk_sfplus_home_region` string
      - `location_code` string — Store Code<br>便利商店店號
      - `location_name` string — Store Code<br>便利商店店號
      - `name_translations` Translatable
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `store_address` string — Store Address<br>商店地址
      - `url` string — Delivery Tracking url<br>貨件追蹤URL
      - `tracking_number` string — Delivery Tracking Number<br>貨件追蹤號碼
      - `scheduled_delivery_date` string — Scheduled Delivery Date<br>預計貨到時間
      - `time_slot_key` string — Scheduled Delivery Time Slot<br>送貨時段<br>---<br> If delivery platform istcat<br>當送貨方式是黑貓時<br> 1 = before 13:00 / 13:00 前<br>2 = 14:00 - 18:00<br> 4 = any time slot / 任何時間
      - `time_slot_translations` object — Scheduled Delivery Time Slot Name<br>送貨時段名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `customer_id` string — Cutomer ID<br>顧客ID
    - `customer_name` string — Customer's Name<br>顧客姓名
    - `customer_email` string — Customer's Email<br>顧客Email
    - `customer_phone` string — Customer's Phone<br>顧客電話
    - `customer_phone_country_code` string — Customer's Phone Country Code<br>顧客電話國碼
    - `customer_info` object — Customer's Information<br>顧客其他基本資訊
      - `gender` string — Gender<br>性別
      - `birthday` string — Birthday<br>生日
      - `custom_data` object[] — Custom Fields<br>客製化欄位
        - `value` string
        - `name_translations` Translatable
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `field_id` string
    - `currency_iso` string — Currency ISO (ISO-4217)<br>ISO 4217 貨幣代碼
    - `subtotal` object — Price total for all order items<br>訂單小計,包含商品總價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `order_discount` object — Order discount<br>優惠折扣
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `user_credit` object — Customer Credit<br>折抵購物金
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `total_tax_fee` object — Total Tax Fee<br>訂單稅費
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `total` object — Final price total, which includes payment fee and delivery fee<br>付款總金額,包含附加費與運費
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `order_points` integer — Points used<br>會員點數使用
    - `order_points_to_cash` object — Discounted by the points used<br>會員點數折抵金額
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `invoice` object — Invoice Info<br>發票資訊
      - `tax_id` string — Tax ID Number<br>發票統一編號
      - `mailing_address` string — Mailing Address<br>發票地址
      - `invoice_type` '0' | '1' | '2' — Invoice Type<br>發票種類<br>-<br> 0 電子發票<br> 1 捐贈發票<br> *2 紙本發票（公司戶紙本發票/二聯式發票）<br>-<br> 當 tax_id 有值時，為「公司戶紙本發票」；當 tax_id 沒有值時，則為「二聯式發票」
      - `buyer_name` string — Buyer Name<br>發票抬頭
      - `carrier_type` '0' | '1' | '2' — Carrier Type<br>載具類型<br>-<br> 0 會員載具<br> 1 手機條碼<br> *2 自然人憑證條碼
      - `carrier_number` string — Carrier Number<br>載具號碼
      - `n_p_o_b_a_n` string — 發票捐贈愛心碼
      - `invoice_tax_type` '1' | '2' | '5' — Invoice Tax Type<br>發票税別<br>-<br> 1 應稅<br> 2 零稅率-非經海關出口<br> *5 零稅率-經海關出口
      - `invoice_number` string — Invoice Number<br>發票號碼
      - `invoice_status` 'active' | 'cancel' — Invoice status<br>發票狀態<br>-<br> active 已開立<br> cancel 已作廢
      - `invoice_date` string — Invoice Date<br>發票開立日期
      - `invoice_cancelled_at` string — Invoice Cancelled Date<br>發票作廢日期
    - `invoices` object[] — Invoices Info<br>發票資訊（包含 EC、POS）
      - `tax_id` TaxId — unresolved $ref
      - `mailing_address` MailingAddress — unresolved $ref
      - `invoice_type` InvoiceType — unresolved $ref
      - `buyer_name` BuyerName — unresolved $ref
      - `carrier_type` CarrierType — unresolved $ref
      - `carrier_number` CarrierNumber — unresolved $ref
      - `n_p_o_b_a_n` NPOBAN — unresolved $ref
      - `invoice_tax_type` InvoiceTaxType — unresolved $ref
      - `invoice_number` InvoiceNumber — unresolved $ref
      - `invoice_status` InvoiceStatus — unresolved $ref
      - `invoice_date` InvoiceDate — unresolved $ref
    - `subtotal_items` OrderItem[] — Order Product Item Data<br>訂單商品資訊
      - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on) <br>系統自行創建訂單品項ID
      - `item_type` 'Product' | 'AddonProduct' | 'Gift' | 'CustomProduct' — Order item type:<br>Product 商品<br> AddonProduct 加購品<br>Gift 贈品<br>CustomProduct 自訂商品
      - `item_data` object — CartItem snapshot<br>在第三方合作夥伴下單之前,在購物車內時的資訊快照
        - `variation_data` object — Variation data of the item (if applicable), including price, weight and more <br>商品規格的數據(如適用)，包括價格、重量等
        - `affiliate_data` object — Affiliate data of the item (if applicable), including affiliate_percentage or affiliate_amount <br>商品分潤的資料(如適用)，包括分潤百分比或分潤金額
          - `affiliate_percentage` number, float
          - `affiliate_amount` object
      - `item_id` string — ID of Product/Addon Product/Gift<br>商品/加購品/贈品的ID<br> (Custom Product doesn't have a item_id)<br>(自訂商品沒有item_id)
      - `item_variation_id` string — (To-Be-Deprecated)<br>規格商品ID請使用下方item_variation_key欄位
      - `item_variation_key` string — Variation ID<br>規格商品的ID
      - `item_price` object — Sale price<br>特價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price` object — Price<br>原價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price_sale` object — Price Sale<br>特價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `cost` object — Cost<br>成本價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `item_points` integer — Points used for single item<br>兌換商品所需點數
      - `title_translations` object — Product name<br>商品名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `fields_translations` object — Product variation name<br>規格名稱
        - `en` string[] — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
      - `sku` string — Product SKU<br>商品貨號
      - `is_preorder` boolean — Is preorder<br>是否是預購商品
      - `preorder_note_translations` object — Preorder product note<br>商品預購提示
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `quantity` integer — Order item quantity<br>商品數量
      - `total` object — Order item price multiplied by quantity<br>商品總價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `order_discounted_price` object — Discount amount for discounts of all products<br> 該商品適用全單折扣之金額<br> (註：整筆訂單之折扣，會依金額比例分攤至不同的商品中)
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discounted_price` object — Discount amount for discounts of selected products<br>該商品適用指定商品折扣之金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discounted_total` object — Discounted total price after all discounts<br>該商品減去所有折扣與購物金後的總額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `total_points` integer — Total points cost on same product (item_points * quantity)<br><br>此商品的總點數
      - `media` object — Cover image of the order item<br>商品圖片
        - `id` string — Media ID
        - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
      - `product_subscription_id` string — ID of Product Subscription<br>定期購的ID<br>
      - `object_data` object — Object data <br>商品數據
        - `gender` Gender — unresolved $ref
        - `age_group` AgeGroup — unresolved $ref
        - `adult` Adult — unresolved $ref
        - `condition` Condition — unresolved $ref
        - `brand` Brand — unresolved $ref
        - `supplier` unknown
        - `weight` Weight — unresolved $ref
        - `barcode_type` BarcodeType — unresolved $ref
        - `location_id` LocationId — unresolved $ref
        - `max_order_quantity` MaxOrderQuantity — unresolved $ref
        - `gtin` Gtin — unresolved $ref
        - `mpn` Mpn — unresolved $ref
      - `child_products` object — The products in a product set<br>組合商品內的商品<br> Appear only when item_type is productSet<br>只有item_type是組合商品才會出現
        - `id` string — ID of Product/Addon Product/Gift<br>商品/加購品/贈品的ID<br> (Custom Product doesn't have a item_id)<br>(自訂商品沒有item_id)
        - `title_translations` object — Product name<br>商品名稱
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `fields_translations` object — Product variation name<br>規格名稱
          - `en` string[] — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
        - `variation_id` string — The variation ID<br>規格商品ID
        - `sku` string — Product SKU<br>商品貨號
        - `price` object — Price<br>原價格
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_sale` object — Price Sale<br>特價
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
    - `promotion_items` object — Promotion Item Data<br>訂單折扣資訊
      - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)<br> 系統自行創建訂單折扣ID
      - `discountable_amount` unknown
      - `discounted_amount` object — Discounted Amount<br>折扣金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `subtotal_after` object — Subtotal After Discount<br>折扣後訂單金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `promotion_data` object — Promotion Data<br>促銷資訊
      - `coupon_code` string — Promotion coupon code<br>促銷優惠代碼
      - `updated_at` string — Promotion Updated Time<br>此產品使用促銷更新時間
      - `created_at` string — Promotion Created Time<br>此產品使用促銷創造時間（通常與產品創造時間一致）
    - `custom_data` object[] — Customized Order Fields<br>客製化欄位<br>-<br>*欲使用此欄位請先至商店後台>訂單設定>自訂訂單欄位 進行設定
    - `custom_discount_items` object — Order Custom Discount Item Data
      - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on) <br>系統自行創建訂單品項ID
      - `item_type` 'Product' | 'AddonProduct' | 'Gift' | 'CustomProduct' — Order item type:<br>Product 商品<br> AddonProduct 加購品<br>Gift 贈品<br>CustomProduct 自訂商品
      - `item_data` object — CartItem snapshot<br>在第三方合作夥伴下單之前,在購物車內時的資訊快照
        - `variation_data` object — Variation data of the item (if applicable), including price, weight and more <br>商品規格的數據(如適用)，包括價格、重量等
        - `affiliate_data` object — Affiliate data of the item (if applicable), including affiliate_percentage or affiliate_amount <br>商品分潤的資料(如適用)，包括分潤百分比或分潤金額
          - `affiliate_percentage` number, float
          - `affiliate_amount` object
      - `item_id` string — ID of Product/Addon Product/Gift<br>商品/加購品/贈品的ID<br> (Custom Product doesn't have a item_id)<br>(自訂商品沒有item_id)
      - `item_variation_id` string — (To-Be-Deprecated)<br>規格商品ID請使用下方item_variation_key欄位
      - `item_variation_key` string — Variation ID<br>規格商品的ID
      - `item_price` object — Sale price<br>特價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price` object — Price<br>原價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price_sale` object — Price Sale<br>特價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `cost` object — Cost<br>成本價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `item_points` integer — Points used for single item<br>兌換商品所需點數
      - `title_translations` object — Product name<br>商品名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `fields_translations` object — Product variation name<br>規格名稱
        - `en` string[] — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
      - `sku` string — Product SKU<br>商品貨號
      - `is_preorder` boolean — Is preorder<br>是否是預購商品
      - `preorder_note_translations` object — Preorder product note<br>商品預購提示
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `quantity` integer — Order item quantity<br>商品數量
      - `total` object — Order item price multiplied by quantity<br>商品總價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `order_discounted_price` object — Discount amount for discounts of all products<br> 該商品適用全單折扣之金額<br> (註：整筆訂單之折扣，會依金額比例分攤至不同的商品中)
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discounted_price` object — Discount amount for discounts of selected products<br>該商品適用指定商品折扣之金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discounted_total` object — Discounted total price after all discounts<br>該商品減去所有折扣與購物金後的總額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `total_points` integer — Total points cost on same product (item_points * quantity)<br><br>此商品的總點數
      - `media` object — Cover image of the order item<br>商品圖片
        - `id` string — Media ID
        - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
      - `product_subscription_id` string — ID of Product Subscription<br>定期購的ID<br>
      - `object_data` object — Object data <br>商品數據
        - `gender` Gender — unresolved $ref
        - `age_group` AgeGroup — unresolved $ref
        - `adult` Adult — unresolved $ref
        - `condition` Condition — unresolved $ref
        - `brand` Brand — unresolved $ref
        - `supplier` unknown
        - `weight` Weight — unresolved $ref
        - `barcode_type` BarcodeType — unresolved $ref
        - `location_id` LocationId — unresolved $ref
        - `max_order_quantity` MaxOrderQuantity — unresolved $ref
        - `gtin` Gtin — unresolved $ref
        - `mpn` Mpn — unresolved $ref
      - `child_products` object — The products in a product set<br>組合商品內的商品<br> Appear only when item_type is productSet<br>只有item_type是組合商品才會出現
        - `id` string — ID of Product/Addon Product/Gift<br>商品/加購品/贈品的ID<br> (Custom Product doesn't have a item_id)<br>(自訂商品沒有item_id)
        - `title_translations` object — Product name<br>商品名稱
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `fields_translations` object — Product variation name<br>規格名稱
          - `en` string[] — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
        - `variation_id` string — The variation ID<br>規格商品ID
        - `sku` string — Product SKU<br>商品貨號
        - `price` object — Price<br>原價格
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_sale` object — Price Sale<br>特價
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
    - `ref_order_id` string — For third party custom order id<br>可供儲存第三方訂單ID
    - `ref_customer_id` string — For third party custom customer id<br>可供儲存第三方顧客ID
    - `agent` object — 員工資料<br>*只供POS商户使用
      - `email` string — Email of the agent<br>員工電郵
      - `name` string — Name of the agent<br>員工名稱
      - `phone` string — Phone of the agent<br>員工電話號碼
      - `status` 'active' | 'removed' — Status of the agent<br>員工狀態
    - `parent_order_id` string — Parent Order ID<br>拆單後之母訂單ID
    - `child_order_ids` string[] — Child Order ID<br>拆單後之子訂單ID
    - `split_at` string — Order Split Time<br>拆單時間
    - `confirmed_at` string — Order Confirmed Time<br>訂單確認時間<br>(如尚未確認則顯示null)
    - `updated_at` string — Order Updated Time<br>訂單更新時間<br>*UTC Time
    - `created_at` string — Order Created Time<br>訂單創造日期<br>*UTC Time
    - `edited_at` string — Order Edit Time<br>訂單修改日期<br>*UTC Time
    - `completed_at` string — Order Completed Time<br>訂單完成日期<br>*UTC Time
    - `skip_fulfillment` boolean — Is order skipping fulfillment?<br>訂單是否略過“扣減庫存”
    - `utm_data` object — UTM Data<br>UTM參數
      - `utm_source` string — UTM Source<br>標識哪個站點發送了流量，並且是必填參數。
      - `utm_campaign` string — UTM Campaign<br>標識特定的產品促銷或戰略活動。
      - `utm_medium` string — UTM Medium<br>標識所使用的鏈接類型，例如每次點擊或電子郵件的費用。
      - `utm_content` string — UTM Content<br>標識用於將用戶帶到網站的具體操作，例如橫幅廣告或文本鏈接。 它通常用於A / B測試和以內容定位的廣告。<br>textlink<br>logolink
      - `utm_term` string — UTM Term<br>標識搜索詞。
      - `utm_time` string — UTM Time
    - `ga_tracked` boolean — Is tracked by GA?<br>是否使用GA追蹤
    - `order_comments` object[] — Customer Comments<br>顧客通訊內容
      - `owner_type` 'Merchant' | 'User'
      - `value` string
      - `time` string
    - `order_notes` object[] — Order Notes<br>訂單備註
      - `owner_type` 'Merchant' | 'User'
      - `value` string
      - `time` string
    - `created_by` 'openapi' | 'admin' | 'shop' | 'shop_crm' | 'pos' | 'sc' | 'mc' | 'import' — Channel that created the order<br>建立訂單的渠道
    - `agent_id` string, nullable — Agent ID that created the order<br>代理建立訂單的操作者 ID<br> Only provided when include_fields contains 'agent_id'<br> 僅於include_fields傳入 'agent_id' 時提供
    - `affiliate_data` object — Affiliate Data<br>聯屬網絡營銷數據
    - `default_warehouse_id` string — The default warehouse ID of the created_by_channel of the order. If the created_by_channel is blank, this field will be the default warehouse ID of the online channel.<br> 訂單 created_by_channel 預設的倉庫 ID。如果 created_by_channel 為空，則此欄位將是 online channel 的 default_warehouse_id。
    - `channel` object — Channel<br>渠道
      - `created_by_channel_id` string
      - `created_by_channel_name` object
    - `applied_tax_info` object — Applied Tax Info<br>稅務信息
      - `sales` object
      - `delivery` object
    - `auto_reward_credit_summary` object — 訂單回饋購物金資訊
      - `auto_reward_rule_id` string
      - `accumulated_type` string
      - `is_accumulated` boolean
      - `credit_threshold` string
      - `credit_value` string
      - `triggered` boolean
      - `calculate_credit_value` string
      - `auto_reward_balance` string
    - `member_point_summary` object — 訂單回饋點數資訊
      - `pending_days` integer
      - `earned_points` integer
      - `order_created_by` string
      - `order_type` string
    - `payment_slips` object[] — Payment Slips<br>付款單
      - `text` string
      - `owner_id` string
      - `trackable_id` string
      - `trackable_type` string
      - `is_private` boolean
      - `is_last` boolean
      - `owner_type` string
      - `custom_data` object
    - `type` 'general' | 'preorder' | 'return' | 'exchange' — Order type<br>訂單類型<br> The field is only available for POS orders (created_by: pos)<br> 此欄位僅適用於POS訂單 (created_by: pos) - general: 一般訂單<br> - preorder: 預訂單<br> - return: 退貨單<br> - exchange: 換貨單<br>
    - `affiliate_campaign` object — Affiliate campaign associated with the order<br> 訂單對應的推薦活動<br> -<br> Only provided when include_fields contains 'affiliate_campaign'<br> 僅於include_fields傳入 'affiliate_campaign' 時提供
      - `id` string — Order Campaign Item ID<br>訂單推薦活動ID
      - `name_translations` object — Name of Campaign<br>推薦活動名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `type` 'affiliate_referral' | 'member_referral' — Campaign Type<br>推薦活動類型
      - `reward_type` 'percentage' | 'amount' — Campaign Reward Type<br>推薦活動獎勵類型
      - `reward_value` object — Reward Amount<br>獎勵金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `campaign_data` object — Campaign Data<br>推薦活動參數
      - `campaign_id` string — Campaign ID<br>推薦活動ID
      - `order_id` string — Order ID<br>訂單ID
      - `bonus_balance` object — Bonus Balance<br>結算金額
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
    - `order_source` object — Source of the order<br>訂單來源
      - `id` string — ID of the order source<br>訂單來源ID
      - `type` 'storefront' | 'offline_store' | 'offline_store_other' | 'fb' | 'fb_other' | 'shopline_live' | 'line' | 'shopee' | 'whatsapp' | 'lazada' | 'instagram' | 'zalo' | 'phone' | 'email' | 'other' — Type of the order source<br>訂單來源類型
      - `source_id` string — ID of the external source<br>外部來源id<br> Might be fb_fan_page_id / channel_id<br>可能是 fb_fan_page_id / channel_id
      - `name` object — Name<br>名字<br> Might be fb fan page name / channel name<br>可能是 fb 粉絲頁面名稱/頻道名稱
    - `tags` string[] — Order tags<br>商品標籤
    - `inclusive_tax_info` object — inclusive tax information<br>內含稅信息
    - `product_subscription_period` integer — Product Subscription Period<br>定期購期數
    - `allow_customer_cancel` boolean — Allow Customer Cancel<br>允許顧客取消訂單
    - `order_items_stock_tag` object[] — Order items stock tag to indicate increasing or reducing stock failed<br> If there is no stock error, the field value will be an empty array. The field is omitted in no-op cancellations (e.g. skip_fulfillment or already cancelled).<br> 訂單商品庫存標籤，用來標示庫存增加或減少失敗<br> 若沒有庫存錯誤，則此欄位值為空陣列；訂單未觸發庫存處理（如 skip_fulfillment 或已取消）時不會出現此欄位
      - `product_id` string — ID of the product
      - `sku_id` string — ID of the SKU
      - `order_item_id` string — ID of the order item
      - `stock_tag` 'REDUCE_FAILED' | 'INCREASE_FAILED' — Stock tag for the order item
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量

## Other responses

- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)