SHshoplineapp
Orders

Get Order

Changed on

To get detailed information for a specific order with its ID<br>使用訂單ID獲取特定一筆訂單的詳細資料

get/orders/{id}

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/orders/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Order ID<br>訂單ID

Query parameters

include_fields[]string[]

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

fields[]string[]

Only return the provided fields in the responses<br>結果只包含輸入的參數 <br> This parameter will override include_fields[]<br>此參數會覆蓋include_fields[]。

[
  "fields[]=id"
]

Response

OK

idstring

Order ID<br>訂單ID

order_numberstring

Order Number<br>訂單號碼

system_order_numberstring

系统生成的訂單號

merchant_order_numberstring

店家自定義訂單號<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_checkoutboolean

是否為訪客結帳

order_remarksstring

Order Remarks<br>訂單備註

customer_idstring

Cutomer ID<br>顧客ID

customer_namestring

Customer's Name<br>顧客姓名

customer_emailstring

Customer's Email<br>顧客Email

customer_phonestring

Customer's Phone<br>顧客電話

customer_phone_country_codestring

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

currency_isostring

Currency ISO (ISO-4217)<br>ISO 4217 貨幣代碼

order_pointsinteger

Points used<br>會員點數使用

custom_dataobject[]

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

metafieldsobject

Metafields<br>額外資訊欄位<br> -<br> Only provided when include_fields contains 'metafields'<br> 僅於include_fields傳入 'metafields' 時提供

is_product_reviewedboolean

Whether any product in the order has been reviewed<br> 訂單中的商品是否已被評論<br> -<br> Only provided when include_fields contains 'is_product_reviewed'<br> 僅於include_fields傳入 'is_product_reviewed' 時提供

ref_order_idstring

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

ref_customer_idstring

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

parent_order_idstring

Parent Order ID<br>拆單後之母訂單ID

child_order_idsstring[]

Child Order ID<br>拆單後之子訂單ID

split_atstring

Order Split Time<br>拆單時間

combined_to_order_idstring nullable

The ID of the order this order was combined into<br> 此訂單被合併後，對應的合併訂單ID<br> -<br> Only provided when include_fields contains 'combined_to_order_id'<br> 僅於include_fields傳入 'combined_to_order_id' 時提供

combined_from_order_idsstring[]

IDs of the orders that were combined into this order<br> 合併至此訂單的來源訂單ID列表<br> -<br> Only provided when include_fields contains 'combined_from_order_ids'<br> 僅於include_fields傳入 'combined_from_order_ids' 時提供

confirmed_atstring

Order Confirmed Time<br>訂單確認時間<br>(如尚未確認則顯示null)

updated_atstring

Order Updated Time<br>訂單更新時間<br>*UTC Time

created_atstring

Order Created Time<br>訂單創造日期<br>*UTC Time

edited_atstring

Order Edit Time<br>訂單修改日期<br>*UTC Time

completed_atstring

Order Completed Time<br>訂單完成日期<br>*UTC Time

skip_fulfillmentboolean

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

ga_trackedboolean

Is tracked by GA?<br>是否使用GA追蹤

created_by'openapi' | 'admin' | 'shop' | 'shop_crm' | 'pos' | 'sc' | 'mc' | 'import'

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

agent_idstring nullable

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

affiliate_dataobject

Affiliate Data<br>聯屬網絡營銷數據

default_warehouse_idstring

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。

credit_reward_campaign_summaryobject

訂單回饋購物金活動資訊<br> -<br> Only available on the Get Order endpoint, only provided when include_fields contains 'credit_reward_campaign_summary'<br> 僅限 Get Order endpoint 提供，且需於include_fields傳入 'credit_reward_campaign_summary' 時才提供

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>

tagsstring[]

Order tags<br>商品標籤

inclusive_tax_infoobject

inclusive tax information<br>內含稅信息

product_subscription_periodinteger

Product Subscription Period<br>定期購期數

allow_customer_cancelboolean

Allow Customer Cancel<br>允許顧客取消訂單

allow_customer_returnboolean

Allow Customer Return<br>允許顧客退貨<br> -<br> Only available on the Get Order endpoint, only provided when include_fields contains 'allow_customer_return'<br> 僅限 Get Order endpoint 提供，且需於include_fields傳入 'allow_customer_return' 時才提供

return_expiry_datestring

Return Expiry Date<br>退貨期限<br> -<br> Only available on the Get Order endpoint, only provided when include_fields contains 'return_expiry_date'<br> 僅限 Get Order endpoint 提供，且需於include_fields傳入 'return_expiry_date' 時才提供

Changes

  • d2518391b149Revision changes
    • info

      added the enum value allow_customer_return to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value combined_from_order_ids to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value combined_to_order_id to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value credit_reward_campaign_summary to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value is_product_reviewed to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value metafields to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value return_expiry_date to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value supplier to the property items/ of the query request parameter include_fields[]

    • info

      added the enum value type to the property items/ of the query request parameter include_fields[]

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status