Split Order

post https://open.shopline.io/v1/orders/{id}/split

To split an order with open API
透過 open API 進行拆單

Responses

Response body

object

string

Order ID
訂單ID

order_number

string

Order Number
訂單號碼

system_order_number

string

系统生成的訂單號

merchant_order_number

string

店家自定義訂單號
(會根據rollout_key選擇用哪個order_number)

status

string

Order Status
訂單狀態
-
Status allows:
temp 暫存狀態
pending 處理中
removed 已刪除
confirmed 已確認
completed 已完成
cancelled 已取消

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

string

Payment Method
付款方式

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

name_translations

object

Payment Method Name
付款方式之名稱

status

string

Payment Status
付款狀態

Payment status allows:
pending 未付款
failed 付款失敗
expired 超過付款時間
completed 已付款
refunding 退款中
refunded 已退款

pending failed expired completed refunding refunded

payment_fee

object

Payment Fee
附加費

total

object

Payment Total
付款金額

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

Has additional fields

last_four_digits

string

Credit Card Last Four Digits.
信用卡後四碼

payment_slips_setting

object

Setting for payment slips.
付款明細設定

Has additional fields

shopline_payment_payment

string

expire_time

number

Expiry time of the payment, in days.
失效時間，以天作為單位。

order_delivery

object

Order Delivery Information
送貨資訊

string

Order Delivery ID
訂單配送ID

delivery_option_id

string

Delivery Option ID
送貨方式ID

platform

string

Delivery platform
送貨方式類別

status

string

Delivery Status
送貨狀態

Status allows:
pending 備貨中
shipping 發貨中
shipped 已發貨
arrived 已到達
collected 已取貨
returned 已退貨
* returning 退貨中

pending shipping shipped arrived collected returned returning

delivery_status

string

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 門市關閉

arrived collected expired failed pending request_accepted request_authorized request_submitted returned returning returning_store_closed shipped store_closed

name_translations

object

送貨方式名稱

total

object

Delivery fee
運費

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
是否需要顧客提供地址

delivery_address

object

Recipient Information
收件人基本資訊

country_code

string

Country Code
國家代碼

country

string

Country
國家

city

string

City
城市

district

string

City
地區

state

string

Stage or Region
州/省/地區

postcode

string

ZIP code
郵政編號

address_1

string

Address 1
地址 1

address_2

string

Address 1
地址 2
(這裡原則上會自動帶入地址所在行政區)

key

string

layer1

string

layer2

string

layer3

string

logistic_codes

array of strings

logistic_codes

recipient_name

string

Recipient Name
收件人姓名

recipient_phone

string

Recipient Phone
收件人電話號碼

recipient_phone_country_code

string

Recipient Phone Country Code
收件人電話號碼國碼

remarks

string

Remark
備註

delivery_data

object

Third-Party Delivery Information
第三方串接物流資訊

hk_sfplus_home_region

string

location_code

string

Store Code
便利商店店號

location_name

string

Store Code
便利商店店號

name_translations

object

store_address

string

Store Address
商店地址

url

string

Delivery Tracking url
貨件追蹤URL

tracking_number

string

Delivery Tracking Number
貨件追蹤號碼

scheduled_delivery_date

string

Scheduled Delivery Date
預計貨到時間

time_slot_key

string

Scheduled Delivery Time Slot
送貨時段
---
If delivery platform istcat
當送貨方式是黑貓時
1 = before 13:00 / 13:00 前
2 = 14:00 - 18:00
4 = any time slot / 任何時間

time_slot_translations

object

Scheduled Delivery Time Slot Name
送貨時段名稱

customer_id

string

Cutomer ID
顧客ID

customer_name

string

Customer's Name
顧客姓名

customer_email

string

Customer's Email
顧客Email

customer_phone

string

Customer's Phone
顧客電話

customer_phone_country_code

string

Customer's Phone Country Code
顧客電話國碼

customer_info

object

Customer's Information
顧客其他基本資訊

gender

string

Gender
性別

birthday

string

Birthday
生日

custom_data

array of objects

Custom Fields
客製化欄位

custom_data

object

value

string

name_translations

object

field_id

string

currency_iso

string

Currency ISO (ISO-4217)
ISO 4217 貨幣代碼

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

integer

Discounted by the points used
會員點數折抵金額

invoice

object

Invoice Info
發票資訊

tax_id

string

Tax ID Number
發票統一編號

mailing_address

string

Mailing Address
發票地址

invoice_type

string

Invoice Type
發票種類
-
0 電子發票
1 捐贈發票
*2 紙本發票（公司戶紙本發票/二聯式發票）
-
當 tax_id 有值時，為「公司戶紙本發票」；當 tax_id 沒有值時，則為「二聯式發票」

0 1 2

buyer_name

string

Buyer Name
發票抬頭

carrier_type

string

Carrier Type
載具類型
-
0 會員載具
1 手機條碼
*2 自然人憑證條碼

0 1 2

carrier_number

string

Carrier Number
載具號碼

n_p_o_b_a_n

string

發票捐贈愛心碼

invoice_tax_type

string

Invoice Tax Type
發票税別
-
1 應稅
2 零稅率-非經海關出口
*5 零稅率-經海關出口

1 2 5

invoice_number

string

Invoice Number
發票號碼

invoice_status

string

Invoice status
發票狀態
-
active 已開立
cancel 已作廢

active cancel

invoice_date

string

Invoice Date
發票開立日期

invoice_cancelled_at

string

Invoice Cancelled Date
發票作廢日期

invoices

array of objects

Invoices Info
發票資訊（包含 EC、POS）

invoices

object

tax_id

string

Tax ID Number
發票統一編號

mailing_address

string

Mailing Address
發票地址

invoice_type

string

0 1 2

buyer_name

string

Buyer Name
發票抬頭

carrier_type

string

Carrier Type
載具類型
-
0 會員載具
1 手機條碼
*2 自然人憑證條碼

0 1 2

carrier_number

string

Carrier Number
載具號碼

n_p_o_b_a_n

string

發票捐贈愛心碼

invoice_tax_type

string

Invoice Tax Type
發票税別
-
1 應稅
2 零稅率-非經海關出口
*5 零稅率-經海關出口

1 2 5

invoice_number

string

Invoice Number
發票號碼

invoice_status

string

Invoice status
發票狀態
-
active 已開立
cancel 已作廢

active cancel

invoice_date

string

Invoice Date
發票開立日期

subtotal_items

object

Order Product Item Data
訂單商品資訊

string

Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單品項ID

item_type

string

Order item type:
Product 商品
AddonProduct 加購品
Gift 贈品
CustomProduct 自訂商品

Product AddonProduct Gift CustomProduct

item_data

object

CartItem snapshot
在第三方合作夥伴下單之前,在購物車內時的資訊快照

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
特價

price

object

Price
原價格

price_sale

object

Price Sale
特價

cost

object

Cost
成本價

item_points

integer

Points used for single item
兌換商品所需點數

title_translations

object

Product name
商品名稱

fields_translations

object

Product variation name
規格名稱

sku

string

Product SKU
商品貨號

is_preorder

boolean

Is preorder
是否是預購商品

preorder_note_translations

object

Preorder product note
商品預購提示

quantity

integer

Order item quantity
商品數量

total

object

Order item price multiplied by quantity
商品總價

order_discounted_price

object

Discount amount for discounts of all products
該商品適用全單折扣之金額
(註：整筆訂單之折扣，會依金額比例分攤至不同的商品中)

discounted_price

object

Discount amount for discounts of selected products
該商品適用指定商品折扣之金額

total_points

integer

Total points cost on same product (item_points * quantity)

此商品的總點數

media

object

Cover image of the order item
商品圖片

product_subscription_id

string

ID of Product Subscription
定期購的ID

object_data

object

Object data
商品數據

child_products

object

The products in a product set
組合商品內的商品
Appear only when item_type is productSet
只有item_type是組合商品才會出現

promotion_items

object

Promotion Item Data
訂單折扣資訊

string

Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單折扣ID

discountable_amount

string

discounted_amount

object

Discounted Amount
折扣金額

subtotal_after

object

Subtotal After Discount
折扣後訂單金額

promotion_data

object

Promotion Data
促銷資訊

Has additional fields

coupon_code

string

Promotion coupon code
促銷優惠代碼

updated_at

string

Promotion Updated Time
此產品使用促銷更新時間

created_at

string

Promotion Created Time
此產品使用促銷創造時間（通常與產品創造時間一致）

custom_data

array of objects

Customized Order Fields
客製化欄位
-
*欲使用此欄位請先至商店後台>訂單設定>自訂訂單欄位進行設定

custom_data

object

custom_discount_items

object

Order Custom Discount Item Data

string

Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單品項ID

item_type

string

Order item type:
Product 商品
AddonProduct 加購品
Gift 贈品
CustomProduct 自訂商品

Product AddonProduct Gift CustomProduct

item_data

object

CartItem snapshot
在第三方合作夥伴下單之前,在購物車內時的資訊快照

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
特價

price

object

Price
原價格

price_sale

object

Price Sale
特價

cost

object

Cost
成本價

item_points

integer

Points used for single item
兌換商品所需點數

title_translations

object

Product name
商品名稱

fields_translations

object

Product variation name
規格名稱

sku

string

Product SKU
商品貨號

is_preorder

boolean

Is preorder
是否是預購商品

preorder_note_translations

object

Preorder product note
商品預購提示

quantity

integer

Order item quantity
商品數量

total

object

Order item price multiplied by quantity
商品總價

order_discounted_price

object

Discount amount for discounts of all products
該商品適用全單折扣之金額
(註：整筆訂單之折扣，會依金額比例分攤至不同的商品中)

discounted_price

object

Discount amount for discounts of selected products
該商品適用指定商品折扣之金額

total_points

integer

Total points cost on same product (item_points * quantity)

此商品的總點數

media

object

Cover image of the order item
商品圖片

product_subscription_id

string

ID of Product Subscription
定期購的ID

object_data

object

Object data
商品數據

child_products

object

The products in a product set
組合商品內的商品
Appear only when item_type is productSet
只有item_type是組合商品才會出現

ref_order_id

string

For third party custom order id
可供儲存第三方訂單ID

ref_customer_id

string

For third party custom customer id
可供儲存第三方顧客ID

agent

object

員工資料
*只供POS商户使用

string

Email of the agent
員工電郵

name

string

Name of the agent
員工名稱

phone

string

Phone of the agent
員工電話號碼

status

string

Status of the agent
員工狀態

active removed

parent_order_id

string

Parent Order ID
拆單後之母訂單ID

child_order_ids

array of strings

Child Order ID
拆單後之子訂單ID

child_order_ids

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

edited_at

string

Order Edit Time
訂單修改日期
*UTC Time

skip_fulfillment

boolean

Is order skipping fulfillment?
訂單是否略過“扣減庫存”

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

ga_tracked

boolean

Is tracked by GA?
是否使用GA追蹤

order_comments

array of objects

Customer Comments
顧客通訊內容

order_comments

object

owner_type

string

Merchant User

value

string

time

string

order_notes

array of objects

Order Notes
訂單備註

order_notes

object

owner_type

string

Merchant User

value

string

time

string

created_by

string

Channel that created the order
建立訂單的渠道

openapi admin shop shop_crm pos sc mc import

agent_id

string | null

Agent ID that created the order
代理建立訂單的操作者 ID
Only provided when include_fields contains 'agent_id'
僅於include_fields傳入 'agent_id' 時提供

affiliate_data

object

Affiliate Data
聯屬網絡營銷數據

Has additional fields

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.
訂單 created_by_channel 預設的倉庫 ID。如果 created_by_channel 為空，則此欄位將是 online channel 的 default_warehouse_id。

channel

object

Channel
渠道

created_by_channel_id

string

created_by_channel_name

object

Has additional fields

applied_tax_info

object

Applied Tax Info
稅務信息

sales

object

Has additional fields

delivery

object

Has additional fields

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

array of objects

Payment Slips
付款單

payment_slips

object

text

string

owner_id

string

trackable_id

string

trackable_type

string

is_private

boolean

is_last

boolean

owner_type

string

custom_data

object

Has additional fields

type

string

Order type
訂單類型
The field is only available for POS orders (created_by: pos)
此欄位僅適用於POS訂單 (created_by: pos) - general: 一般訂單
- preorder: 預訂單
- return: 退貨單
- exchange: 換貨單

general preorder return exchange

affiliate_campaign

object

Affiliate campaign associated with the order
訂單對應的推薦活動
-
Only provided when include_fields contains 'affiliate_campaign'
僅於include_fields傳入 'affiliate_campaign' 時提供

string

Order Campaign Item ID
訂單推薦活動ID

name_translations

object

Name of Campaign
推薦活動名稱

type

string

Campaign Type
推薦活動類型

affiliate_referral member_referral

reward_type

string

Campaign Reward Type
推薦活動獎勵類型

percentage amount

reward_value

object

Reward Amount
獎勵金額

campaign_data

object

Campaign Data
推薦活動參數

Has additional fields

campaign_id

string

Campaign ID
推薦活動ID

order_id

string

Order ID
訂單ID

bonus_balance

object

Bonus Balance
結算金額

order_source

object

Source of the order
訂單來源

string

ID of the order source
訂單來源ID

type

string

Type of the order source
訂單來源類型

storefront offline_store offline_store_other fb fb_other shopline_live line shopee whatsapp lazada instagram zalo phone email other

source_id

string

ID of the external source
外部來源id
Might be fb_fan_page_id / channel_id
可能是 fb_fan_page_id / channel_id

name

object

Name
名字
Might be fb fan page name / channel name
可能是 fb 粉絲頁面名稱/頻道名稱

Has additional fields

200OK

422Unprocessable Entity

500Server error