店配作業 #
建立托運單標籤PDF檔 #
必須先使用
建立托運單標籤PDF檔
取得Callback資訊,再呼叫
下載托運單標籤PDF檔
取得pdf檔案
。
Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/StoreDelivery/CreateLabelFile
HTTP Method: POST
Request Body #
TransferDateStart #
轉單日 (起)。
資料型態: dateTime
必填: 是(註:日期區間、訂單編號、RG單號為三選一但不能完全沒有)
說明: 時間格式為
- yyyy-mm-ddThh:mm:ssZ
- ex. 2024-06-28T09:00:00Z
使用日期區間查詢時,無筆數限制
TransferEndDate #
轉單日 (迄)。
資料型態: dateTime
必填: 是(註:日期區間、訂單編號、RG單號為三選一但不能完全沒有)
說明: 時間格式為
- yyyy-mm-ddThh:mm:ssZ
- ex. 2024-06-28T10:00:00Z
使用日期區間查詢時,無筆數限制
OrderCodes #
訂單編號。
資料型態: String Array
必填: 是(註:日期區間、訂單編號、RG單號為三選一但不能完全沒有)
說明: 訂單編號一次最多允許查詢200筆
ExternalOrderkeys #
RG單號。
資料型態: Integer Array
必填: 是(註:日期區間、訂單編號、RG單號為三選一但不能完全沒有)
說明: RG單號一次最多允許查詢200筆
CallbackURL #
回呼函式。
資料型態: String
必填: 是
說明: 回傳標籤pdf檔案下載位址
Request/Response Sample #
POST /scmapi/api/StoreDelivery/CreateLabelFile
{
"TransferStartDate": "2024-06-21T09:00:00Z",
"TransferEndDate": "2024-06-28T10:00:00Z",
//此為範例,請依照實際開發的CallbackURL代替
"CallbackUrl": "https://XXXX/listingapicallback.ashx"
}
POST /scmapi/api/StoreDelivery/CreateLabelFile
{
"OrderCodes":["RM2406110000187","RM2406110000452"],
//此為範例,請依照實際開發的CallbackURL代替
"CallbackUrl": "https://XXXX/listingapicallback.ashx"
}
POST /scmapi/api/StoreDelivery/CreateLabelFile
{
"ExternalOrderkeys":[504076498,504076502],
//此為範例,請依照實際開發的CallbackURL代替
"CallbackUrl": "https://XXXX/listingapicallback.ashx"
}
"已開始產生標籤檔案"
Response Elements #
若操作成功,API 會回傳 HTTP 200 response。並顯示已開始產生標籤檔案
。