Newegg Developer Portal

獲取補償性退款資訊

通過指定查詢準則獲取指定的補償性退款資訊。

相關URL

Newegg.com: https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Newegg.com: https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/courtesyrefund/info?sellerid={sellerid} Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Newegg.com: https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/courtesyrefund/info?sellerid={sellerid}

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

參數

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

相關請求資訊

HTTP方式 是否需要認證? 請求格式 回覆格式 頻率限制
PUT 需要 XML,Json XML,Json 30 請求/分鐘/商家

請求文件主體

屬性 是否必填? 格式 描述
IssueUser 否 String 請求發送者在Seller Portal上註冊過的郵箱位址。
系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號。
OperationType 是 String 固定值:GetCourtesyRefundInfo
PageIndex 否 Integer 當前頁索引
如果不填,默認為1
PageSize 否 Integer 單頁的記錄數,每頁最大記錄數為100
如果不填,默認為1
KeywordsType 否 Integer 有效值:
0: All (default)(所有(默認))
1: CourtesyRefundID(補償性退款請求編號)
2: OrderNumber(訂單編號)
3: CustomerName(顧客姓名)
KeywordsValue 否 String 指定KeywordsType(關鍵詞類型)的關鍵字的值
如果KeywordsType為0,系統將會忽略該欄位
Status 否 Integer 有效值:
0: All (Default)(默認)
1: Open(待收貨)
2: Void(已作廢)
3: Close(已關閉)
DateFrom 否 String 根據時間範圍查找補償性退款請求(太平洋標準時間)。請參考可接受時間格式
DateTo 否 String 根據時間範圍查找補償性退款請求(太平洋標準時間)。請參考可接受時間格式

Schema: GetCRInfoRequest.xsd

示例:XML, Request

PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest >
<OperationType>GetCourtesyRefundInfo</OperationType>
<RequestBody>
<PageInfo>
<PageIndex>1</PageIndex>
<PageSize>10</PageSize>
</PageInfo>
<KeywordsType>0</KeywordsType>
<KeywordsValue />
<Status>0</Status>
<DateFrom>2001-12-17 09:30:47</DateFrom>
<DateTo>2011-12-17 12:30:47</DateTo>
</RequestBody>
</NeweggAPIRequest>
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest > <OperationType>GetCourtesyRefundInfo</OperationType> <RequestBody> <PageInfo> <PageIndex>1</PageIndex> <PageSize>10</PageSize> </PageInfo> <KeywordsType>0</KeywordsType> <KeywordsValue /> <Status>0</Status> <DateFrom>2001-12-17 09:30:47</DateFrom> <DateTo>2011-12-17 12:30:47</DateTo> </RequestBody> </NeweggAPIRequest>
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest >
    <OperationType>GetCourtesyRefundInfo</OperationType>
    <RequestBody>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
        <KeywordsType>0</KeywordsType>
        <KeywordsValue />
        <Status>0</Status>
        <DateFrom>2001-12-17 09:30:47</DateFrom>
        <DateTo>2011-12-17 12:30:47</DateTo>
    </RequestBody>
</NeweggAPIRequest>

示例:Json, Request

PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetCourtesyRefundInfo",
"RequestBody": {
"PageInfo": {
"PageIndex": "1",
"PageSize": "10"
},
"KeywordsType": "0",
"Status": "0",
"DateFrom": "2001-12-17 09:30:47",
"DateTo": "2011-12-17 12:30:47"
}
}
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "GetCourtesyRefundInfo", "RequestBody": { "PageInfo": { "PageIndex": "1", "PageSize": "10" }, "KeywordsType": "0", "Status": "0", "DateFrom": "2001-12-17 09:30:47", "DateTo": "2011-12-17 12:30:47" } }
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetCourtesyRefundInfo",
    "RequestBody": {
        "PageInfo": {
            "PageIndex": "1",
            "PageSize": "10"
        },
        "KeywordsType": "0",
        "Status": "0",
        "DateFrom": "2001-12-17 09:30:47",
        "DateTo": "2011-12-17 12:30:47"
    }
}

回覆文件主體

屬性 格式 描述
IsSuccess String 獲取資料狀態操作:
True:成功
False:失敗
OperationType String 固定值:GetCourtesyRefundResponse
SellerID String 商家編號
ResponseDate String 該請求提交的時間(太平洋標準時間)
TotalCount Integer 記錄總條數
TotalPageCount Integer 返回總頁數
PageSize Integer 單頁記錄條數
PageIndex Integer 當前頁索引
CourtesyRefundID String 補償性退款交易編號
SONumber Integer 訂單編號
SOAmount Decimal 訂單總金額

  • Newegg.com 和 Newggbusiness.com,所有金額都設置使用美元(USD)
  • Newegg.ca,所有金額都設置使用加幣(CAD)
InvoiceNumber Integer 訂單的發票編號
RefundAmount Decimal 退款總額

  • Newegg.com 和 Newggbusiness.com,所有金額都設置使用美元(USD)
  • Newegg.ca,所有金額都設置使用加幣(CAD)
ReasonCode Integer 有效值
1. Negative customer feedback(顧客差評)
2. Pricing error(價格錯誤)
3. Wrong item information(錯誤的商品資訊)
4. Shipping delay(發貨延遲)
5. Package not received(沒有收到包裹)
6. Customer Courtesy(顧客優惠)
Reason String 有效值
Negative customer feedback(顧客差評):如果ReasonCode的值為1
Pricing error(價格錯誤):如果ReasonCode的值為2
Wrong item information(錯誤的商品資訊) :如果ReasonCode的值為3
Shipping delay(發貨延遲):如果ReasonCode的值為4
Package not received(沒有收到包裹) :如果ReasonCode的值為5
Customer Courtesy(顧客優惠):如果ReasonCode的值為6
NoteToCustomer String 給顧客的備註資訊
Status String 有效值:
1:Open(待收貨)
2:Close(已關閉)
3:Void(已作廢)
IsNeweggRefund String 指定新蛋客服代替處理退款。有效值:True或者False
InUserName String 補償性退款請求的創建者
InDate String 補償性退款請求創建時間(太平洋標準時間)
EditUserName String 最後編輯用戶
EditDate String 最後編輯時間(太平洋標準時間)

Schema: GetCRInfoResponse.xsd

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<OperationType>GetCourtesyRefundResponse</OperationType>
<SellerID>A006</SellerID>
<ResponseDate>2012-02-17 15:12:00</ResponseDate>
<ResponseBody>
<PageInfo>
<TotalCount>1</TotalCount>
<TotalPageCount>1</TotalPageCount>
<PageSize>10</PageSize>
<PageIndex>1</PageIndex>
</PageInfo>
<CourtesyRefundInfoList>
<CourtesyrefundInfo>
<CourtesyRefundID>8a9501f2-495a-4b4f-b921-966a40969aa8</CourtesyRefundID>
<SONumber>88251262</SONumber>
<SOAmount>890.40</SOAmount>
<InvoiceNumber>48799955</InvoiceNumber>
<RefundAmount>2.01</RefundAmount>
<ReasonCode>1</ReasonCode>
<Reason>Negative Customer Feedback</Reason>
<NoteToCustomer>This is a test note</NoteToCustomer>
<Status>Close</Status>
<IsNeweggRefund>false</IsNeweggRefund>
<InUserName>A006</InUserName>
<InDate>2012-02-17 12:10:00</InDate>
<EditUserName>A006</EditUserName>
<EditDate>2012-02-17 12:10:00</EditDate>
</CourtesyrefundInfo>
</CourtesyRefundInfoList>
</ResponseBody>
</NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>GetCourtesyRefundResponse</OperationType> <SellerID>A006</SellerID> <ResponseDate>2012-02-17 15:12:00</ResponseDate> <ResponseBody> <PageInfo> <TotalCount>1</TotalCount> <TotalPageCount>1</TotalPageCount> <PageSize>10</PageSize> <PageIndex>1</PageIndex> </PageInfo> <CourtesyRefundInfoList> <CourtesyrefundInfo> <CourtesyRefundID>8a9501f2-495a-4b4f-b921-966a40969aa8</CourtesyRefundID> <SONumber>88251262</SONumber> <SOAmount>890.40</SOAmount> <InvoiceNumber>48799955</InvoiceNumber> <RefundAmount>2.01</RefundAmount> <ReasonCode>1</ReasonCode> <Reason>Negative Customer Feedback</Reason> <NoteToCustomer>This is a test note</NoteToCustomer> <Status>Close</Status> <IsNeweggRefund>false</IsNeweggRefund> <InUserName>A006</InUserName> <InDate>2012-02-17 12:10:00</InDate> <EditUserName>A006</EditUserName> <EditDate>2012-02-17 12:10:00</EditDate> </CourtesyrefundInfo> </CourtesyRefundInfoList> </ResponseBody> </NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetCourtesyRefundResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseDate>2012-02-17 15:12:00</ResponseDate>
    <ResponseBody>
        <PageInfo>
            <TotalCount>1</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <CourtesyRefundInfoList>
            <CourtesyrefundInfo>
                <CourtesyRefundID>8a9501f2-495a-4b4f-b921-966a40969aa8</CourtesyRefundID>
                <SONumber>88251262</SONumber>
                <SOAmount>890.40</SOAmount>
                <InvoiceNumber>48799955</InvoiceNumber>
                <RefundAmount>2.01</RefundAmount>
                <ReasonCode>1</ReasonCode>
                <Reason>Negative Customer Feedback</Reason>
                <NoteToCustomer>This is a test note</NoteToCustomer>
                <Status>Close</Status>
                <IsNeweggRefund>false</IsNeweggRefund>
                <InUserName>A006</InUserName>
                <InDate>2012-02-17 12:10:00</InDate>
                <EditUserName>A006</EditUserName>
                <EditDate>2012-02-17 12:10:00</EditDate>
            </CourtesyrefundInfo>
        </CourtesyRefundInfoList>
    </ResponseBody>
</NeweggAPIResponse>

示例: Json, Response

{
"NeweggAPIResponse": {
"IsSuccess": "true",
"OperationType": "GetCourtesyRefundResponse",
"SellerID": "A006",
"ResponseDate": "2012-02-17 15:12:00",
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "1",
"PageIndex": "10"
},
"CourtesyRefundInfoList": {
"CourtesyrefundInfo": {
"CourtesyRefundID": "8a9501f2-495a-4b4f-b921-966a40969aa8",
"SONumber": "88251262",
"SOAmount": "890.40",
"InvoiceNumber": "48799955",
"RefundAmount": "2.01",
"ReasonCode": "1",
"Reason": "Negative Customer Feedback",
"NoteToCustomer": "This is a test note",
"Status": "Close",
"IsNeweggRefund": "false",
"InUserName": "A006",
"InDate": "2012-02-17 12:10:00",
"EditUserName": "EDI",
"EditDate": "2012-02-17 12:10:00"
}
}
}
}
}
{ "NeweggAPIResponse": { "IsSuccess": "true", "OperationType": "GetCourtesyRefundResponse", "SellerID": "A006", "ResponseDate": "2012-02-17 15:12:00", "ResponseBody": { "PageInfo": { "TotalCount": "1", "TotalPageCount": "1", "PageSize": "1", "PageIndex": "10" }, "CourtesyRefundInfoList": { "CourtesyrefundInfo": { "CourtesyRefundID": "8a9501f2-495a-4b4f-b921-966a40969aa8", "SONumber": "88251262", "SOAmount": "890.40", "InvoiceNumber": "48799955", "RefundAmount": "2.01", "ReasonCode": "1", "Reason": "Negative Customer Feedback", "NoteToCustomer": "This is a test note", "Status": "Close", "IsNeweggRefund": "false", "InUserName": "A006", "InDate": "2012-02-17 12:10:00", "EditUserName": "EDI", "EditDate": "2012-02-17 12:10:00" } } } } }
{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "OperationType": "GetCourtesyRefundResponse",
        "SellerID": "A006",
        "ResponseDate": "2012-02-17 15:12:00",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "1",
                "TotalPageCount": "1",
                "PageSize": "1",
                "PageIndex": "10"
            },
            "CourtesyRefundInfoList": {
                "CourtesyrefundInfo": {
                    "CourtesyRefundID": "8a9501f2-495a-4b4f-b921-966a40969aa8",
                    "SONumber": "88251262",
                    "SOAmount": "890.40",
                    "InvoiceNumber": "48799955",
                    "RefundAmount": "2.01",
                    "ReasonCode": "1",
                    "Reason": "Negative Customer Feedback",
                    "NoteToCustomer": "This is a test note",
                    "Status": "Close",
                    "IsNeweggRefund": "false",
                    "InUserName": "A006",
                    "InDate": "2012-02-17 12:10:00",
                    "EditUserName": "EDI",
                    "EditDate": "2012-02-17 12:10:00"
                }
            }
        }
    }
}

請求失敗錯誤資訊

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

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
<Error>
<Code>CE001</Code>
<Message>SellerID cannot be null or empty</Message>
</Error>
</Errors>
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>CE001</Code> <Message>SellerID cannot be null or empty</Message> </Error> </Errors>
<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CE001</Code>
        <Message>SellerID cannot be null or empty</Message>
    </Error>
</Errors>

示例: Json, Response

[
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
]
[ { "Code": "CE001", "Message": "SellerID cannot be null or empty" } ]
[
    {
        "Code": "CE001",
        "Message": "SellerID cannot be null or empty"
    }
]

更新日期:10/15/2018