Order

/v1/Order/Query

訂單查詢,可依據不同的條件查詢訂單列表

Request parameters

Parameter	Value	Description
OrderType	string(20/Require)	訂單類型 All:全部 NonShipping:未出貨 Shipping:已出貨 NonClose:未結案 Closed:已結案
ShippingType	string(20/Require)	配送方式 HomeDelivery:宅配 StoreDelivery:超商 ESD:電子下載
DateType	string(20/Require)	日期條件 TransferDate:轉單日 LastShippingDate:最晚出貨日 OrderCloseDate:訂單結案日
StartDate	date(Require)	起始日期第一種格式（yyyy/mm/dd）第二種格式（yyyy/mm/dd hh:mm:ss）
EndDate	date(Require)	迄止日期第一種格式（yyyy/mm/dd）第二種格式（yyyy/mm/dd hh:mm:ss） EndDate-StartDate 要小於等於7天
Position	int(Require)	由第幾筆開始拿資料
Count	int(Require)	資料筆數 Count=1~100

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/Query?OrderType=All&ShippingType=HomeDelivery&DateType=TransferDate&StartDate=2010/01/01&EndDate=2010/01/02&Position=1&Count=1&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
TransactionList	包含符合查詢條件的Transaction List，屬性： Count：資料筆數
TotalCount	符合查詢條件的總資料筆數
Transaction (string/15)	包含一筆Transaction的資料，屬性： Id ：交易序號
Order (string/20)	訂單編號 Id: 訂單編號

Sample response

JSON sample

{
  "Response": {
    "@Status": "ok",
    "TransactionList": {
      "@Count": 3,
      "@TotalCount": 10,
      "Transaction": [
        {
          "@Id": "12345",
          "Order": [
            {
              "@Id": "YM1234567"
            },
            {
              "@Id": "YM1234568"
            },
            {
              "@Id": "YM1234569"
            }
          ]
        },
        {
          "@Id": "12346",
          "Order": [
            {
              "@Id": "YM1234511"
            },
            {
              "@Id": "YM1234512"
            },
            {
              "@Id": "YM1234513"
            }
          ]
        },
        {
          "@Id": "123488",
          "Order": [
            {
              "@Id": "YM1234599"
            },
            {
              "@Id": "YM1234566"
            },
            {
              "@Id": "YM1234533"
            }
          ]
        }
      ]
    }
  }
}

Errors

/v1/Order/QueryNonPayment

查詢未付款完成的訂單

Request parameters

Parameter	Value	Description
StartOrderDate	date(Require)	訂購起始日期（yyyy/mm/dd）
EndOrderDate	date(Require)	訂購迄止日期（yyyy/mm/dd） EndOrderDate-StartOrderDate必須小於等於3天
ShippingType	string (Require/20)	配送方式 HomeDelivery：宅配 StoreDelivery：超商 ESD：電子下載
OrderStatus	String (Require/20)	訂單狀態 ALL:全部 NEW:未結案 CANCEL:取消
Position	int(Require)	由第幾筆開始拿資料
Count	int(Require)	資料筆數 Count=1~100

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/QueryNonPayment?ShippingType=HomeDelivery&StartOrderDate=2010/01/01&EndOrderDate=2010/01/02&OrderStatus=ALL&Position=1&Count=1&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
TransactionList	包含符合查詢條件的Transaction List，屬性： Count：資料筆數
TotalCount	符合查詢條件的總資料筆數
Transaction (string/15)	包含一筆Transaction的資料，屬性： Id：交易序號
BuyerName (string/20)	訂購人姓名
PayType (string/20)	此筆交易使用的付款方式 CreditCard：信用卡 ATM：ATM StorePay：超商繳費（IBON） StoreDelivery：超商付款取貨
ShippingType (string/20)	此筆交易使用的配送方式 HomeDelivery：宅配 StoreDelivery：超商 ESD：ESD
Order (string/20)	包含ㄧ筆Order的資料，屬性： Id：訂單編號
OrderStatus (string/20)	訂單狀態 NEW：未結案 CANCEL：取消
DeliverType (string/30)	交寄方式
OrderNote (string/150)	訂單備註
OrderStatusDesc (string/30)	訂單狀態描述
OrderDate	訂購日
OrderProductList	包含OrderList，屬性： Count：資料筆數
Product (string/16)	包含一筆訂購的商品資料，屬性： Id：商品編號
SaleType (string/20)	SaleType Normal：一般方式(現貨銷售) PreSaleByShipDate：DATE 預購 by shipDate(指定出貨日期) PreSaleByShipdays：DAYS 預購 by shipdays(訂購後多少天出貨)
CustomizedProductId (string/30)	自訂貨號
ProductName (string/150)	商品名稱
Spec (string/50)	商品規格
Amount (int)	數量
Subtotal (int)	金額小計(折扣後價格)

Sample response

JSON sample

{
    "Response":
    {
        "@Status":"ok",
        "TransactionList":
        {
            "@Count":2,
            "@TotalCount":10,
            "Transaction":
            [
                {
                    "@Id":"5473347",
                    "_BuyerName":"\u6e38\u6587\u516d",
                    "PayType":"StorePay(IBON)",
                    "ShippingType":"HomeDelivery",
                    "OrderList":
                    [
                        {
                            "Order":
                            [
                                {
                                    "@Id":"YM1008020000007",
                                    "OrderStatus":"NEW",
                                    "_OrderStatusDesc":"\u672a\u7d50\u6848",
                                    "OrderDate":"1900/01/01",
                                    "OrderProductList":
                                    {
                                         "@Count":"1",
                                         "Product":
                                         [
                                             {
                                                 "@Id":"1020623",
                                                 "SaleType":"Normal",
                                                 "_CustomizedProductId":"",
                                                 "_ProductName":"\u7269\u6d41\u670d\u52d9\u8cbb",
                                                 "_Spec":"",
                                                 "Amount":"1",
                                                 "Subtotal":"80"
                                             }
                                         ]
                                    }
                                },
                                {
                                    "@Id":"YM1008020000008",
                                    "OrderStatus":"NEW",
                                    "_OrderStatusDesc":"\u672a\u7d50\u6848",
                                    "OrderDate":"1900/01/01",
                                    "OrderProductList":
                                    {
                                        "Product":
                                        [
                                            {
                                                "@Id":"100_1",
                                                "SaleType":"Normal",
                                                "_CustomizedProductId":"A0001\u4e3b\u4ef6100_1",
                                                "_ProductName":"\u4e3b\u4ef6\u4e00",
                                                "_Spec":"",
                                                "Amount":"2",
                                                "Subtotal":"1590"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    ]
                },
                {
                    "@Id":"5473348",
                    "_BuyerName":"\u6e38\u6587\u516d",
                    "PayType":"CreditCard",
                    "ShippingType":"HomeDelivery",
                    "OrderList":
                    [
                        {
                            "Order":
                            [
                                {
                                    "@Id":"YM1008020000007",
                                    "OrderStatus":"NEW",
                                    "_OrderStatusDesc":"\u672a\u7d50\u6848",
                                    "OrderDate":"1900/01/01",
                                    "OrderProductList":
                                    {
                                        "@Count":"1",
                                        "Product":
                                        [
                                            {
                                                "@Id":"1020623",
                                                "SaleType":"Normal",
                                                "_CustomizedProductId":"",
                                                "_ProductName":"\u7269\u6d41\u670d\u52d9\u8cbb",
                                                "_Spec":"",
                                                "Amount":"1",
                                                "Subtotal":"80"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "@Id":"YM1008020000009",
                                    "OrderStatus":"Cancel",
                                    "_OrderStatusDesc":"\u53d6\u6d88-\u5584\u610f-\u4e0d\u7f70",
                                    "OrderDate":"1900/01/01",
                                    "OrderProductList":
                                    {
                                        "Product":
                                        [
                                            {
                                                "@Id":"1020623",
                                                "SaleType":"Normal",
                                                "_CustomizedProductId":"",
                                                "_ProductName":"\u7269\u6d41\u670d\u52d9\u8cbb",
                                                "_Spec":"",
                                                "Amount":"1",
                                                "Subtotal":"80"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "@Id":"YM1008020000010",
                                    "OrderStatus":"CANCEL",
                                    "_OrderStatusDesc":"\u53d6\u6d88-\u5584\u610f-\u4e0d\u7f70",
                                    "OrderDate":"1900/01/01",
                                    "OrderProductList":
                                    {"Product":
                                        [
                                            {
                                                "@Id":"100_1",
                                                "SaleType":"Normal",
                                                "_CustomizedProductId":"A0001\u4e3b\u4ef6100_1",
                                                "_ProductName":"\u4e3b\u4ef6\u4e00",
                                                "_Spec":"",
                                                "Amount":"2",
                                                "Subtotal":"1590"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

Errors

ErrorCode	ErrorMessage
2101	為物流處理費
2102	訂單非未出貨狀態
2103	非宅配訂單
2109	無資料
2110	物流商代碼不存在

其他錯誤請參閱共用錯誤表

/v1/Order/GetStatus

查詢訂單狀態

Request parameters

Parameter

Value

Description

TransactionId

string (Require/15)

交易序號

OrderId

string (Require/20)

訂單編號

一次可select同一個TransactionId下的多個OrderId，最大接受100個

ex：TransactionId=23000&OrderId=2300001&OrderId=2300002

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/GetStatus?TransactionId=23000&OrderId=2300001&OrderId=2300002&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
Transaction (string/15)	交易序號
SuccessList	包含成功的Order資料
OrderList	包含Order List，屬性： Count：資料筆數
Order (string/20)	包含一筆Order的資料，屬性： Id：訂單編號
OrderStatus (string/20)	訂單狀態 NEW:未結案 CANCEL:取消 SHIPPED:完成出貨
OrderStatusDesc (string/30)	訂單狀態描述
FailList	包含失敗的Order資料
OrderList	包含Order List，屬性： Count：資料筆數
Order (string/20)	包含一筆Order的資料，屬性： Id：訂單編號

Sample response

JSON sample

{
  "Response": {
    "@Status": "ok",
    "Transaction": {
      "@Id": 123456,
      "FailList": {
        "@Count": 3,
        "OrderList": {
         "Order": [
            {
              "@Id": "YM1234577"
            },
            {
              "@Id": "YM1234588"
            },
            {
              "@Id": "YM1234599"
            }
          ]
        }
      },
      "SuccessList": {
        "@Count": 3,
        "OrderList": {
          "Order": [
            {
              "@Id": "YM1234567",
               "OrderStatus": "NEW",
               "OrderStatusDesc": "未結案"
            },
            {
              "@Id": "YM1234568", 
              "OrderStatus": "SHIPPED",
              "OrderStatusDesc": "完成出貨"
            },
            {
              "@Id": "YM1234569",
               "OrderStatus": "CANCEL",
               "OrderStatusDesc": "取消-缺貨"
            },
            {
              "@Id": "YM1234560",
               "OrderStatus": "CANCEL",
               "OrderStatusDesc": "取消-門市刷退"
            }
          ]
        }
      }
    }
  }
}

Errors

/v1/Order/GetMaster

取得購物車資料

Request parameters

Parameter	Value	Description
TransactionId	string (Require) (Require/15)	交易序號

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/GetMaster?TransactionId=21410239&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
TransactionId (string/15)	交易序號
BuyerName (string/20)	訂購人姓名
BuyerPhone (string/30)	訂購人電話
IsActivity	此筆交易是否有符合活動有活動：Yes 無活動：No
IsUseCoupon	此筆交易是否有使用電子折價券有使用：Yes 未使用：No
PayType (string/20)	此筆交易使用的付款方式 CreditCard:信用卡 ATM:ATM StorePay:超商繳費(IBON) StoreDelivery:超商付款取貨
Installment (int)	分期期數
ShippingType (string/20)	此筆交易使用的配送方式 HomeDelivery：宅配 StoreDelivery：超商 ESD：ESD
StoreType (string/20)	超商種類當ShippingType=StoreDelivery時，此欄位才有值 7-11：7-11(統一超商) None：未使用超商
StoreShippingType (string/30)	物流方式(由商店設定供Buyer使用的物流方式)
TransactionRemark (string/150)	此筆交易的備註
TransactionPrice (int)	此筆交易的總金額
OrderList	包含此筆交易的Order List，屬性： Count：資料筆數
Order (string/20)	包含一筆Order的資料，屬性： Id：訂單編號
OrderStatus (string/20)	訂單狀態 NEW:未結案 CANCEL:取消 SHIPPED:完成出貨
OrderStatusDesc (string/30)	訂單狀態描述
OrderCloseDate	訂單結案日
OrderPackageDate	包裝確認日

Sample response

JSON sample

{
  "Response": {
    "@Status": "ok",
    "Transaction": {
      "@Id": 123456,
      "IsActivity": "Yes",
      "IsUseCoupon": "Yes",
      "OrderList": {
        "Order": [
          {
            "@Id": "YM1511020082581",
            "OrderCloseDate": "2010/11/12",
            "OrderPackageDate": "2010/11/11",
            "OrderStatus": "NEW",
            "OrderStatusDesc": "未結案"
          },
          {
            "@Id": "YM1511020082582",
            "OrderCloseDate": "2010/11/12",
            "OrderPackageDate": "2010/11/11",
            "OrderStatus": "SHIPPED",
            "OrderStatusDesc": "完成出貨"
          },
          {
            "@Id": "YM1511020082583",
            "OrderCloseDate": "2010/11/12",
            "OrderPackageDate": "2010/11/11",
            "OrderStatus": "Cancel",
            "OrderStatusDesc": "取消-缺貨"
          }
        ]
      },
      "PayType": "CreditCard",
      "Installment": "6",
      "ShippingType": "HomeDelivery",
      "StoreType": "None",
      "TransactionPrice": 300,
      "_BuyerName": "\u9673\u7f8e\u7f8e",
      "_BuyerPhone": "0911111111",
      "_TransactionRemark": "\u8acb\u8ddf\u6211\u806f\u7d61"
    }
  }
}

Errors

/v1/Order/GetDetail

取得購物車中訂單明細資料

Request parameters

Parameter

Value

Description

TransactionId

string (Require/15)

交易序號

OrderId

string (Require/20

訂單編號

一次可select同一個TransactionId下的多個OrderId，最大接受100個

ex：TransactionId=23000&OrderId=2300001&OrderId=2300002

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/GetDetail?TransactionId=21410239&OrderId=2300001&OrderId=2300002&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
TransactionId (string/15)	交易序號
Receiver	包含此筆交易的收件者資料
ReceiverName (string/20)	收件者姓名
ReceiverPhone (string/30)	收件者電話
ReceiverMobile (string/30)	收件者手機
ReceiverZipcode (string/5)	收件者郵遞區號
ReceiverAddress (string/150)	收件者地址
SuccessList	包含成功的Order資料
OrderList	包含Order List，屬性： Count：資料筆數
Order (string/20)	包含一筆Order的資料，屬性： Id：訂單編號
OrderStatus (string/20)	訂單狀態 NEW:未結案 CANCEL:取消 SHIPPED:完成出貨
OrderStatusDesc (string/30)	訂單狀態描述
TransferDate	轉單日
LastShippingDate	最晚出貨日
OrderShippingDate	店家出貨日
OrderCloseDate	訂單結案日
BuyerConfirmDate	買家確認日
EntryAccountDate	入帳日
PickingDate	揀貨日
OrderPackageDate	包裝確認日
LastDeliveryDate	最晚送貨日
OrderShippingId (string/25)	出貨單號
InvoiceNo (string/20)	發票號碼
InvoiceDate	發票日期
DeliverType (string/30)	交寄方式
OrderNote (string/150)	訂單備註
OrderProductList	包含此筆訂單的Order Product List，屬性： Count：資料筆數
Product (string/16)	包含一筆訂購的商品資料，屬性： Id：商品編號
ProductType (string/10)	商品型態 Main：主商品 Addon：加購品 Freebie：贈品
SaleType (string/20)	SaleType Normal：一般方式(現貨銷售) PreSaleByShipDate：DATE 預購 by shipDate(指定出貨日期) PreSaleByShipdays：DAYS 預購 by shipdays(訂購後多少天出貨)
CustomizedProductId (string/30)	自定貨號
ProductName (string/150)	商品名稱注意:當ProductName=物流服務費,此訂單不需要執行出貨確認
Spec (string/50)	商品規格
Amount (int)	數量
OriginalPrice (int)	購物車內商品單價
ListPrice (int)	商品頁銷售價格
PromotionCampaignId (int)	折扣碼活動編號
PromotionReduction (int)	折扣碼折抵金額
PromotionCode (string/50)	折扣碼
UsedPoint (int)	超贈點點數
BasicPointDiscount (int)	超贈點折抵金額
UsedOpenpoint (int)	OPENPOINT點數
OpenpointDiscount. (int)	OPENPOINT折抵金額
Subtotal (int)	金額小計(折扣後的價格)
TaxType (string/10)	稅別 Taxable：應稅 TaxFree：免稅 NoInv：免發票
FailList	包含失敗的Order資料
OrderList	包含Order List，屬性： Count：資料筆數
Order (string/20)	包含一筆Order的資料，屬性： Id：訂單編號

Sample response

JSON sample

{
   "Response":{
      "@Status":"ok",
      "Transaction":{
         "@Id":"123456789",
         "Receiver":{
            "ReceiverName":{
               "#cdata-section":"李雯雯"
            },
            "ReceiverPhone":{
               "#cdata-section":"04-26391111#"
            },
            "ReceiverMobile":{
               "#cdata-section":"0976123456"
            },
            "ReceiverZipcode":{
               "#cdata-section":"434"
            },
            "ReceiverAddress":{
               "#cdata-section":"台中市434龍井區麗麗里隆隆路1巷1號"
            }
         },
         "SuccessList":{
            "@Count":"1",
            "OrderList":{
               "Order":{
                  "@Id":"YM1812120012345",
                  "OrderProductList":{
                     "Product":{
                        "@Id":"p0120458812_1",
                        "SaleType":"Normal",
                        "ProductType":"Main",
                        "CustomizedProductId":{
                           "#cdata-section":"190405"
                        },
                        "ProductName":{
                           "#cdata-section":"測試抗皺面膜(20片／盒)"
                        },
                        "Spec":{
                           "#cdata-section":"-"
                        },
                        "Amount":"2",
                        "OriginalPrice":"440",
                        "ListPrice":"440",
                        "ProductCostAmount":"0",
                        "PromotionCampaignId":"1234",
                        "PromotionReduction":"43",
                        "PromotionCode":"4321",
                        "UsedPoint":"0",
                        "BasicPointDiscount":"0",
                        "UsedOpenpoint":"0",
                        "OpenpointDiscount":"0",
                        "ProductDiscountDetail":"0",
                        "Subtotal":"345",
                        "TaxType":"Taxable"
                     }
                  },
                  "DeliverType":{
                     "#cdata-section":"郵局包裹(7)"
                  },
                  "OrderNote":{
                     "#cdata-section":""
                  },
                  "TransferDate":"2018/12/12 12:55",
                  "LastShippingDate":"2018/12/26",
                  "OrderShippingDate":"2018/12/13 14:04",
                  "OrderCloseDate":"2018/12/13",
                  "BuyerConfirmDate":"1900/01/01 00:00",
                  "EntryAccountDate":"1900/01/01",
                  "PickingDate":"1900/01/01",
                  "OrderPackageDate":"1900/01/01",
                  "InvoiceNo":"JZ94431234",
                  "InvoiveDate":"2018/12/13",
                  "LastDeliveryDate":"1900/01/01",
                  "OrderStatus":"SHIPPED",
                  "OrderStatusDesc":{
                     "#cdata-section":"完成出貨"
                  },
                  "OrderShippingId":{
                     "#cdata-section":"12347578"
                  }
               }
            }
         },
         "FailList":{
            "@Count":"0",
            "OrderList":null
         }
      },
      "Message":{
         "#cdata-section":""
      }
   }
}

Errors

/v1/Order/Cancel

商店執行取消訂單

Request parameters

Parameter	Value	Description
TransactionId	string (Require/15)	交易序號
OrderId	string (Require) (Require/20)	訂單編號
CancelRemark	string (Option)	取消備註

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/Cancel?TransactionId=123456&OrderId=YM1234567890123&Format=json

請注意： Order API 使用 https 通訊協定。

Response fields

Field	Description
OrderCloseDate	訂單結案日期
ErrorCode	錯誤代碼
ErrorMessage	錯誤訊息

Sample response

JSON sample

{
    "Response":
    {
        "@Status":"ok",
        "Transaction":
        {
            "@Id":"123456",
            "Order":
            {
               "@Id":"YM1234567",
               "OrderCloseDate":"2011/11/12"
            }
        }
    }
}

Errors

ErrorCode	ErrorMessage
2701	無法取消訂單：不可單獨取消物流服務費
2702	無法取消訂單，請再確認
2703	取消物流服務費發生錯誤
2704	寄發取消通知信錯誤

其他錯誤請參閱共用錯誤表

/v1/Order/GetShippingSupplierList

取得目前設定的貨運商代碼對應表,於出貨確認時使用

Response fields

Field

Description

Code

貨運商代碼

4:新竹
7:郵局
9:宅配通
11:統一宅急便
12:大榮
18:便利帶
99:自行運送

Name

貨運商名稱

Sample Request：

https://tw.ews.mall.yahooapis.com/stauth/v1/Order/GetShippingSupplierList?format=json

請注意： Order API 使用 https 通訊協定。

Sample response

JSON sample

{
  "Response": {
    "@Status": "ok",
    "ShippingSupplierList": {
      "ShippingSupplier": [
        {
          "@Code": "4",
          "_Name": "\u65b0\u7af9"
        },
        {
          "@ShippingSupplierCode": "7",
          "_Reason": "\u90f5\u5c40"
        }
      ]
    }
  }
}