提交訂單清單報表

請求獲取商家帳戶下有效訂單清單。

相關URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/submitrequest?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/submitrequest?sellerid={sellerid}

註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。

參數

名稱 是否必填? 描述
sellerid 您在新蛋商城的商家編號

相關請求資訊

HTTP方式 是否需要認證? 請求格式 回覆格式 頻率限制
POST 需要 XML,Json XML,Json 100 請求/小時

請求文件主體

屬性 是否必填? 格式 描述
IssueUser String 請求發送者在Seller Portal上註冊過的郵箱位址 。

系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號

OperationType String 固定值:OrderListReportRequest
RequestType String 固定值:ORDER_LIST_REPORT
KeywordsType Integer 有效值:
0:All (Default)(所有)(默認)
1: OrderNumber(訂單編號)
2: InvoiceNumber(發票編號)
3: CustomerName(顧客姓名)
4: SellerPartNumber(商家商品編號)
5: NeweggItemNumber(新蛋商品編號)
6: CustomerPhoneNumber(顧客電話)
7: TitleDescription(標題描述)
8: Manufacturer(製造商)
9: SellerOrderNumber(商家定義訂單編號)
註:9: SellerOrderNumber(商家定義訂單編號)只可用于商家使用新蛋配送SBN配送多平台訂單時使用。
KeywordsValue String 指定KeywordsType(關鍵詞類型)的關鍵字的值
如果KeywordsType(關鍵詞類型)為0,系統將忽略該欄位。
Status Integer 有效值:
0: Unshipped(未發貨)
1: Partially Shipped(部分發貨)
2: Shipped(已發貨)
3: Invoiced(交易完成)
4: Voided(訂單作廢)
Type Integer 有效值:
0: All (Default) 所有(默認)
1: SBN(新蛋配送)
2: SBS(商家配送)
3: Multi-Channel(其他管道)
OrderDateFrom String 根據訂單時間範圍查詢(太平洋標準時間)。請參考可接受時間格式
OrderDateTo String 根據訂單時間範圍查詢(太平洋標準時間)。請參考可接受時間格式
VoidSoon Integer 訂單將在 24 或 48小時後自動刪除
有效值:
24
48
OrderDownloaded String 有效值:
False: 包括已下載訂單
True: 不包括已下載訂單
CountryCode String 訂單所在國家。只接受國際標準3位元國家編碼。
完整國家代碼清單,請通過以下連結下載:International Country Guide
不適用於Neweggbusiness.com 和Newegg.ca
PremierOrder String 有效值:
0: All (Default) 所有(默認)
1: Premier Order Only 僅顯示Premier訂單
2: No Premier Order 不顯示Premier訂單
不適用於Neweggbusiness.com 和Newegg.ca

Schema: OrderListRequest.xsd

示例:XML, Request

POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>OrderListReportRequest</OperationType>
    <RequestBody>
        <OrderReportCriteria>
            <RequestType>ORDER_LIST_REPORT</RequestType>
            <KeywordsType>0</KeywordsType>
            <KeywordsValue/>
            <Status>4</Status>
            <Type>0</Type>
            <OrderDateFrom>2011-12-07</OrderDateFrom>
            <OrderDateTo>2012-12-30</OrderDateTo>
            <OrderDownloaded>false</OrderDownloaded>
            <CountryCode>USA</CountryCode>
            <PremierOrder>1</PremierOrder>
        </OrderReportCriteria>
    </RequestBody>
</NeweggAPIRequest>

示例:Json, Request

POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "OrderListReportRequest",
    "RequestBody": {
        "OrderReportCriteria": {
            "RequestType": "ORDER_LIST_REPORT",
            "KeywordsType": "0",
            "Status": "4",
            "Type": "0",
            "OrderDateFrom": "2011-12-07",
            "OrderDateTo": "2012-12-30",
            "OrderDownloaded": "false",
            "CountryCode": "USA",
            "PremierOrder": "1"
        }
    }
}

回覆文件主體

屬性 格式 描述
IsSuccess String 獲取資料狀態操作:
True:成功
False:失敗
OperationType String 固定值:OrderListReportResponse
SellerID String 您的商家編號
RequestId String 新蛋為已提交的請求分配的編號
RequestType String 固定值:ORDER_LIST_REPORT
RequestDate String 資料提交的時間(太平洋標準時間)
RequestSatus String 提交狀態:
SUBMITTED 已提交(默認)
Memo String 附加資訊

Schema: SubmitReportResponse.xsd

示例: XML, Response

<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>OrderListReportResponse</OperationType>
    <SellerID>a001</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>270Z8Y3SYIGQV</RequestId>
                <RequestType>ORDER_LIST_REPORT</RequestType>
                <RequestDate>07/12/2014 11:02:35</RequestDate>
                <RequestStatus>SUBMITTED</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

示例: Json, Response

{
    "IsSuccess": true,
    "OperationType": "OrderListReportResponse",
    "SellerID": "a001",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestId": "270Z8Y3SYIGQV",
                "RequestType": "ORDER_LIST_REPORT",
                "RequestDate": "07/12/2014 11:34:57",
                "RequestStatus": "SUBMITTED"
            }
        ]
    }
}

請求失敗錯誤資訊

常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單

錯誤代碼 描述
RP010 Invalid Order Number.
無效的 Order Number
RP018 Invalid Settlement Date.
無效的 Settlement Date(結算時間)
RP019 The requestID cannot be null or empty.
請求編號(requestID)不能為空
RP020 We are unable to process your request because one of the following search criteria is required: SettlementID, SettlementDate, or SettlementDateFrom and SettlementDateTo.
我們無法處理你的請求,因為你必須提供下列搜索條件中的一個:SettlementID,SettlementDate或 SettlementDateFrom和 SettlementDateTo
RP021 Maximum item lookup cannot exceed 1000 for each request.
每個請求的商品檢索數量最多不超過1000個
RP022 Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please use International Program – Daily Inventory Report.
每日庫存報表不支持多個倉庫所在地。若有多個倉庫所在地,請使用新蛋全球化 – 每日庫存報表章節內容.

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>RP018</Code>
        <Message>Invalid Settlement Date</Message>
    </Error>
</Errors>

示例: Json, Response

[
    {
        "Code": "RP018",
        "Message": "Invalid Settlement Date"
    }
]

更新日期:10/15/2018