--- title: "Get Affiliate Campaign Orders" method: GET path: "/affiliate_campaigns/{id}/orders" tags: ["Affiliate Campaigns"] --- # Get Affiliate Campaign Orders `GET /affiliate_campaigns/{id}/orders` To get affiliate campaign order.
獲取使用特定推薦活動代碼的訂單。 ## Path parameters - `id` string, required ## Query parameters - `previous_id` string - `limit` integer ## Response `200` OK - AffiliateCampaignOrders - `items` AffiliateCampaignOrder[] - `id` string — Order ID
訂單ID - `order_number` string — Order Number
訂單號碼 - `system_order_number` string — 系统生成的訂單號 - `merchant_order_number` string — 店家自定義訂單號
(會根據rollout_key選擇用哪個order_number) - `status` 'temp' | 'pending' | 'removed' | 'confirmed' | 'completed' | 'cancelled' — Order Status
訂單狀態
-
Status allows:
temp 暫存狀態
pending 處理中
removed 已刪除
confirmed 已確認
completed 已完成
cancelled 已取消 - `is_guest_checkout` boolean — 是否為訪客結帳 - `order_remarks` string — Order Remarks
訂單備註 - `order_payment` object — Order Payment Information
付款資訊 - `payment_method_id` string — Payment Method ID
付款方式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
付款方式 - `name_translations` object — Payment Method Name
付款方式之名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `status` 'pending' | 'failed' | 'expired' | 'completed' | 'refunding' | 'refunded' — Payment Status
付款狀態

Payment status allows:
pending 未付款
failed 付款失敗
expired 超過付款時間
completed 已付款
refunding 退款中
refunded 已退款 - `payment_fee` object — Payment Fee
附加費 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `total` object — Payment Total
付款金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `paid_at` string — Paid Time
付款完成時間
(UTC +0) - `updated_at` string — Updated Time related to change of payment
付款更新時間
(UTC +0) - `created_at` string — Created Date
訂單創造時間
(UTC +0) - `payment_data` object — Payment Details Info
付款詳細資訊
(如有串接第三方金流)

Please refer to the example below - `last_four_digits` string — Credit Card Last Four Digits.
信用卡後四碼 - `payment_slips_setting` object — Setting for payment slips.
付款明細設定 - `shopline_payment_payment` string - `expire_time` number — Expiry time of the payment, in days.
失效時間，以天作為單位。 - `customer_id` string — Customer ID
顧客ID - `customer_name` string — Customer Name
顧客名稱 - `customer_email` string — Customer Email
顧客 Email - `order_delivery` object — Order Delivery Information
送貨資訊 - `id` string — Order Delivery ID
訂單配送ID - `delivery_option_id` string — Delivery Option ID
送貨方式ID - `platform` string — Delivery platform
送貨方式類別 - `status` 'pending' | 'shipping' | 'shipped' | 'arrived' | 'collected' | 'returned' | 'returning' — Delivery Status
送貨狀態

Status allows:
pending 備貨中
shipping 發貨中
shipped 已發貨
arrived 已到達
collected 已取貨
returned 已退貨
* 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
配送狀態

Status allows:
arrived 已到達
collected 已取貨
expired 已過出貨期限
failed 失敗
pending 未執行
request_accepted 可供出貨
request_authorized 待處理
request_submitted 處理中
returned 已退貨
returning 退貨中
returning_store_closed 退貨門市關轉
shipped 已出貨
* store_closed 門市關閉 - `name_translations` object — 送貨方式名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `total` object — Delivery fee
運費 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `shipped_at` string — Shipped Time
已送貨時間
(UTC +0) - `arrived_at` string — Arrived Time
已到達時間
(UTC +0) - `collected_at` string — Collected Time
已取貨時間
(UTC +0) - `returned_at` string — Returned Time
已退貨時間
(UTC +0) - `updated_at` string — Updated Time
更新時間
(UTC +0) - `remark` string — Order remark
訂單出貨備註 - `request_accepted_at` string — Logistic accepted shipment time
物流商收到出貨時間 - `request_authorized_at` string — Logistic authorized shipment time
物流商接受出貨時間 - `request_submitted_at` string — Logistic proceeded shipment time
物流商處理出貨時間 - `requested_fmt_at` string — Shipment execution time (Family Mart)
執行出貨時間 (全家) - `return_order_id` string — Return order ID
退貨訂單編號 - `store_closed_at` string — Pick up store closed time
訂單取貨門市關轉時間 - `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
是否需要顧客提供地址 - `subtotal` object — Price total for all order items
訂單小計,包含商品總價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `order_discount` object — Order discount
優惠折扣 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `user_credit` object — Customer Credit
折抵購物金 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `total_tax_fee` object — Total Tax Fee
訂單稅費 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `total` object — Final price total, which includes payment fee and delivery fee
付款總金額,包含附加費與運費 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `order_points` integer — Points used
會員點數使用 - `order_points_to_cash` object — Discounted by the points used
會員點數折抵金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `subtotal_items` object — Order Product Item Data
訂單商品資訊 - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單品項ID - `item_type` 'Product' | 'AddonProduct' | 'Gift' | 'CustomProduct' — Order item type:
Product 商品
AddonProduct 加購品
Gift 贈品
CustomProduct 自訂商品 - `item_data` object — CartItem snapshot
在第三方合作夥伴下單之前,在購物車內時的資訊快照 - `variation_data` object — Variation data of the item (if applicable), including price, weight and more
商品規格的數據(如適用)，包括價格、重量等 - `affiliate_data` object — Affiliate data of the item (if applicable), including affiliate_percentage or affiliate_amount
商品分潤的資料(如適用)，包括分潤百分比或分潤金額 - `affiliate_percentage` number, float - `affiliate_amount` object - `item_id` string — ID of Product/Addon Product/Gift
商品/加購品/贈品的ID
(Custom Product doesn't have a item_id)
(自訂商品沒有item_id) - `item_variation_id` string — (To-Be-Deprecated)
規格商品ID請使用下方item_variation_key欄位 - `item_variation_key` string — Variation ID
規格商品的ID - `item_price` object — Sale price
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price` object — Price
原價格 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price_sale` object — Price Sale
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `cost` object — Cost
成本價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `item_points` integer — Points used for single item
兌換商品所需點數 - `title_translations` object — Product name
商品名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `fields_translations` object — Product variation name
規格名稱 - `en` string[] — Merchant defined English name
店家定義英文名稱 - `zh-hant` string[] — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string[] — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string[] — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string[] — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string[] — Merchant defined Japanese name
店家定義日文名稱 - `th` string[] — Merchant defined Thai name
店家定義泰文名稱 - `id` string[] — Merchant defined Indian name
店家定義印度文名稱 - `de` string[] — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string[] — Merchant defined France name
店家定義法文名稱 - `sku` string — Product SKU
商品貨號 - `is_preorder` boolean — Is preorder
是否是預購商品 - `preorder_note_translations` object — Preorder product note
商品預購提示 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `quantity` integer — Order item quantity
商品數量 - `total` object — Order item price multiplied by quantity
商品總價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `order_discounted_price` object — Discount amount for discounts of all products
該商品適用全單折扣之金額
(註：整筆訂單之折扣，會依金額比例分攤至不同的商品中) - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `discounted_price` object — Discount amount for discounts of selected products
該商品適用指定商品折扣之金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `discounted_total` object — Discounted total price after all discounts
該商品減去所有折扣與購物金後的總額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `total_points` integer — Total points cost on same product (item_points * quantity)

此商品的總點數 - `media` object — Cover image of the order item
商品圖片 - `id` string — Media ID - `alt_translations` object — Content to display on ALT attribute
在圖片ALT上展示的內容 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `images` object — Object contains url of image in different dimensions
包含不同大小圖片的連絡 - `product_subscription_id` string — ID of Product Subscription
定期購的ID
- `object_data` object — Object data
商品數據 - `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
組合商品內的商品
Appear only when item_type is productSet
只有item_type是組合商品才會出現 - `id` string — ID of Product/Addon Product/Gift
商品/加購品/贈品的ID
(Custom Product doesn't have a item_id)
(自訂商品沒有item_id) - `title_translations` object — Product name
商品名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `fields_translations` object — Product variation name
規格名稱 - `en` string[] — Merchant defined English name
店家定義英文名稱 - `zh-hant` string[] — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string[] — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string[] — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string[] — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string[] — Merchant defined Japanese name
店家定義日文名稱 - `th` string[] — Merchant defined Thai name
店家定義泰文名稱 - `id` string[] — Merchant defined Indian name
店家定義印度文名稱 - `de` string[] — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string[] — Merchant defined France name
店家定義法文名稱 - `variation_id` string — The variation ID
規格商品ID - `sku` string — Product SKU
商品貨號 - `price` object — Price
原價格 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price_sale` object — Price Sale
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `promotion_items` object — Promotion Item Data
訂單折扣資訊 - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單折扣ID - `discountable_amount` unknown - `discounted_amount` object — Discounted Amount
折扣金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `subtotal_after` object — Subtotal After Discount
折扣後訂單金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `promotion_data` object — Promotion Data
促銷資訊 - `coupon_code` string — Promotion coupon code
促銷優惠代碼 - `updated_at` string — Promotion Updated Time
此產品使用促銷更新時間 - `created_at` string — Promotion Created Time
此產品使用促銷創造時間（通常與產品創造時間一致） - `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)
系統自行創建訂單品項ID - `item_type` 'Product' | 'AddonProduct' | 'Gift' | 'CustomProduct' — Order item type:
Product 商品
AddonProduct 加購品
Gift 贈品
CustomProduct 自訂商品 - `item_data` object — CartItem snapshot
在第三方合作夥伴下單之前,在購物車內時的資訊快照 - `variation_data` object — Variation data of the item (if applicable), including price, weight and more
商品規格的數據(如適用)，包括價格、重量等 - `affiliate_data` object — Affiliate data of the item (if applicable), including affiliate_percentage or affiliate_amount
商品分潤的資料(如適用)，包括分潤百分比或分潤金額 - `affiliate_percentage` number, float - `affiliate_amount` object - `item_id` string — ID of Product/Addon Product/Gift
商品/加購品/贈品的ID
(Custom Product doesn't have a item_id)
(自訂商品沒有item_id) - `item_variation_id` string — (To-Be-Deprecated)
規格商品ID請使用下方item_variation_key欄位 - `item_variation_key` string — Variation ID
規格商品的ID - `item_price` object — Sale price
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price` object — Price
原價格 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price_sale` object — Price Sale
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `cost` object — Cost
成本價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `item_points` integer — Points used for single item
兌換商品所需點數 - `title_translations` object — Product name
商品名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `fields_translations` object — Product variation name
規格名稱 - `en` string[] — Merchant defined English name
店家定義英文名稱 - `zh-hant` string[] — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string[] — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string[] — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string[] — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string[] — Merchant defined Japanese name
店家定義日文名稱 - `th` string[] — Merchant defined Thai name
店家定義泰文名稱 - `id` string[] — Merchant defined Indian name
店家定義印度文名稱 - `de` string[] — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string[] — Merchant defined France name
店家定義法文名稱 - `sku` string — Product SKU
商品貨號 - `is_preorder` boolean — Is preorder
是否是預購商品 - `preorder_note_translations` object — Preorder product note
商品預購提示 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `quantity` integer — Order item quantity
商品數量 - `total` object — Order item price multiplied by quantity
商品總價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `order_discounted_price` object — Discount amount for discounts of all products
該商品適用全單折扣之金額
(註：整筆訂單之折扣，會依金額比例分攤至不同的商品中) - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `discounted_price` object — Discount amount for discounts of selected products
該商品適用指定商品折扣之金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `discounted_total` object — Discounted total price after all discounts
該商品減去所有折扣與購物金後的總額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `total_points` integer — Total points cost on same product (item_points * quantity)

此商品的總點數 - `media` object — Cover image of the order item
商品圖片 - `id` string — Media ID - `alt_translations` object — Content to display on ALT attribute
在圖片ALT上展示的內容 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `images` object — Object contains url of image in different dimensions
包含不同大小圖片的連絡 - `product_subscription_id` string — ID of Product Subscription
定期購的ID
- `object_data` object — Object data
商品數據 - `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
組合商品內的商品
Appear only when item_type is productSet
只有item_type是組合商品才會出現 - `id` string — ID of Product/Addon Product/Gift
商品/加購品/贈品的ID
(Custom Product doesn't have a item_id)
(自訂商品沒有item_id) - `title_translations` object — Product name
商品名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `fields_translations` object — Product variation name
規格名稱 - `en` string[] — Merchant defined English name
店家定義英文名稱 - `zh-hant` string[] — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string[] — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string[] — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string[] — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string[] — Merchant defined Japanese name
店家定義日文名稱 - `th` string[] — Merchant defined Thai name
店家定義泰文名稱 - `id` string[] — Merchant defined Indian name
店家定義印度文名稱 - `de` string[] — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string[] — Merchant defined France name
店家定義法文名稱 - `variation_id` string — The variation ID
規格商品ID - `sku` string — Product SKU
商品貨號 - `price` object — Price
原價格 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price_sale` object — Price Sale
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `ref_order_id` string — For third party custom order id
可供儲存第三方訂單ID - `ref_customer_id` string — For third party custom customer id
可供儲存第三方顧客ID - `parent_order_id` string — Parent Order ID
拆單後之母訂單ID - `child_order_ids` string[] — Child Order ID
拆單後之子訂單ID - `split_at` string — Order Split Time
拆單時間 - `confirmed_at` string — Order Confirmed Time
訂單確認時間
(如尚未確認則顯示null) - `updated_at` string — Order Updated Time
訂單更新時間
*UTC Time - `created_at` string — Order Created Time
訂單創造日期
*UTC Time - `utm_data` object — UTM Data
UTM參數 - `utm_source` string — UTM Source
標識哪個站點發送了流量，並且是必填參數。 - `utm_campaign` string — UTM Campaign
標識特定的產品促銷或戰略活動。 - `utm_medium` string — UTM Medium
標識所使用的鏈接類型，例如每次點擊或電子郵件的費用。 - `utm_content` string — UTM Content
標識用於將用戶帶到網站的具體操作，例如橫幅廣告或文本鏈接。 它通常用於A / B測試和以內容定位的廣告。
textlink
logolink - `utm_term` string — UTM Term
標識搜索詞。 - `utm_time` string — UTM Time - `created_by` 'openapi' | 'admin' | 'shop' | 'shop_crm' | 'pos' | 'sc' | 'mc' | 'import' — Channel that created the order
建立訂單的渠道 - `affiliate_campaign` object — Affiliate campaign associated with the order
訂單對應的推薦活動
- `id` string — Order Campaign Item ID
訂單推薦活動ID - `name_translations` object — Name of Campaign
推薦活動名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `type` 'affiliate_referral' | 'member_referral' — Campaign Type
推薦活動類型 - `reward_type` 'percentage' | 'amount' — Campaign Reward Type
推薦活動獎勵類型 - `reward_value` object — Reward Amount
獎勵金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `campaign_data` object — Campaign Data
推薦活動參數 - `campaign_id` string — Campaign ID
推薦活動ID - `order_id` string — Order ID
訂單ID - `bonus_balance` object — Bonus Balance
結算金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `return_adjustment_amount` object — Custom Refund Amount
退貨調整項金額 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `inclusive_tax_info` object — inclusive tax information
內含稅信息 - `checkout_object_number` string — multi checkout object number
多購物車編號 - `limit` integer — Numbers of Orders - `last_id` string — The last ID of the orders ## Other responses - `422` — Unprocessable entity error - `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)