Newegg Developer Portal

獲取補償性退款請求狀態

通過指定查詢準則獲取指定的補償性退款請求的狀態。

相關URL

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

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

參數

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

相關請求資訊

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

請求文件主體

屬性 是否必填? 格式 描述
IssueUser 否 String 請求發送者在Seller Portal上註冊過的郵箱位址。
系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號。
OperationType 是 String 固定值:GetCourtesyRefundStatusRequest
RequestID 否 String 新蛋給已提交的補償性退款請求分配的請求ID。
註:如果已指定請求ID,則其他條件如MaxCount,RequestStatus,RequestDateFrom,RequestDateTo都可以忽略。
MaxCount 否 String 最大返回記錄數。默認為100條。如果您指定的記錄數超過100,系統也只會返回100條。
RequestStatus 否 String 有效值:
ALL (Default):所有(默認)
SUBMITTED:已提交
IN_PROGRESS:處理中
FINISHED:已完成
FAILED:失敗
CANCELLED:已取消
RequestDateFrom 否 String 按時間段搜索補償性退款請求(太平洋標準時間)。請參考可接受時間格式
RequestDateTo 否 String 按時間段搜索補償性退款請求(太平洋標準時間)。請參考可接受時間格式

Schema: GetCRStatusRequest.xsd

示例:XML, Request

PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>GetCourtesyRefundStatusRequest</OperationType>
<RequestBody>
<GetRequestStatus>
<RequestIDList>
<RequestID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestID>
</RequestIDList>
<MaxCount>100</MaxCount>
<RequestStatus>ALL</RequestStatus>
<RequestDateFrom/>
<RequestDateTo/>
</GetRequestStatus>
</RequestBody>
</NeweggAPIRequest>
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest> <OperationType>GetCourtesyRefundStatusRequest</OperationType> <RequestBody> <GetRequestStatus> <RequestIDList> <RequestID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestID> </RequestIDList> <MaxCount>100</MaxCount> <RequestStatus>ALL</RequestStatus> <RequestDateFrom/> <RequestDateTo/> </GetRequestStatus> </RequestBody> </NeweggAPIRequest>
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>GetCourtesyRefundStatusRequest</OperationType>
    <RequestBody>
        <GetRequestStatus>
            <RequestIDList>
                <RequestID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestID>
            </RequestIDList>
            <MaxCount>100</MaxCount>
            <RequestStatus>ALL</RequestStatus>
            <RequestDateFrom/>
            <RequestDateTo/>
        </GetRequestStatus>
    </RequestBody>
</NeweggAPIRequest>

示例:Json, Request

PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetCourtesyRefundStatusRequest",
"RequestBody": {
"GetRequestStatus": {
"RequestIDList": {
"RequestID": [
"cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8"
]
},
"MaxCount": "100",
"RequestStatus": "ALL"
}
}
}
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "GetCourtesyRefundStatusRequest", "RequestBody": { "GetRequestStatus": { "RequestIDList": { "RequestID": [ "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8" ] }, "MaxCount": "100", "RequestStatus": "ALL" } } }
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetCourtesyRefundStatusRequest",
    "RequestBody": {
        "GetRequestStatus": {
            "RequestIDList": {
                "RequestID": [
                    "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8"
                ]
            },
            "MaxCount": "100",
            "RequestStatus": "ALL"
        }
    }
}

回覆文件主體

屬性 格式 描述
IsSuccess String 獲取資料狀態操作:
True:成功
False:失敗
OperationType String 固定值:GetCourtesyRefundRequestStatusResponse
SellerID String 商家編號
RequestId String 新蛋分配的請求編號
RequestType String 固定值:COURTESYREFUND
RequestDate String 提交請求的時間(太平洋標準時間)
RequestStatus String 有效值:
SUBMITTED:已提交
IN_PROGRESS:處理中
FINISHED:已完成
FAILED:失敗
CANCELLED:已取消
註:

  • 如果您收到的請求狀態為FAILED(失敗),請參考[ProcessMemo]欄位獲取詳細原因。
  • 如果您收到的請求狀態為FINISHED,補償性退款資訊將會顯示。
ProcessMemo String 如果狀態為failed(失敗),詳細的錯誤資訊將會在該欄位顯示。
CourtesyRefundID String 退款交易的ID
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:Closed(已關閉)
3:Void(已作廢)
IsNeweggRefund String 指定新蛋客服代替處理退款。有效值:True或者False
InUserName String 補償性退款請求的創建者
InDate String 補償性退款請求創建時間(太平洋標準時間)
EditUserName String 最後編輯用戶
EditDate String 最後編輯時間(太平洋標準時間)
Memo String 附加資訊

Schema: GetCRStatusResponse.xsd

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<OperationType>GetCourtesyRefundRequestStatusResponse</OperationType>
<SellerID>A006</SellerID>
<ResponseBody>
<ResponseList>
<ResponseInfo>
<RequestId>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestId>
<RequestType>COURTESYREFUND</RequestType>
<RequestDate>2012-03-07 12:37:09</RequestDate>
<RequestStatus>FINISHED</RequestStatus>
<Result>
<CourtesyRefundInfo>
<CourtesyRefundID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</CourtesyRefundID>
<SONumber>164878278</SONumber>
<SOAmount>1.00</SOAmount>
<InvoiceNumber>84724946</InvoiceNumber>
<RefundAmount>1.00</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-03-07 12:38:00</InDate>
<EditUserName>EDI</EditUserName>
<EditDate>2012-03-07 13:07:02</EditDate>
</CourtesyRefundInfo>
</Result>
</ResponseInfo>
</ResponseList>
</ResponseBody>
</NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>GetCourtesyRefundRequestStatusResponse</OperationType> <SellerID>A006</SellerID> <ResponseBody> <ResponseList> <ResponseInfo> <RequestId>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestId> <RequestType>COURTESYREFUND</RequestType> <RequestDate>2012-03-07 12:37:09</RequestDate> <RequestStatus>FINISHED</RequestStatus> <Result> <CourtesyRefundInfo> <CourtesyRefundID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</CourtesyRefundID> <SONumber>164878278</SONumber> <SOAmount>1.00</SOAmount> <InvoiceNumber>84724946</InvoiceNumber> <RefundAmount>1.00</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-03-07 12:38:00</InDate> <EditUserName>EDI</EditUserName> <EditDate>2012-03-07 13:07:02</EditDate> </CourtesyRefundInfo> </Result> </ResponseInfo> </ResponseList> </ResponseBody> </NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetCourtesyRefundRequestStatusResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestId>
                <RequestType>COURTESYREFUND</RequestType>
                <RequestDate>2012-03-07 12:37:09</RequestDate>
                <RequestStatus>FINISHED</RequestStatus>
                <Result>
                    <CourtesyRefundInfo>
                        <CourtesyRefundID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</CourtesyRefundID>
                        <SONumber>164878278</SONumber>
                        <SOAmount>1.00</SOAmount>
                        <InvoiceNumber>84724946</InvoiceNumber>
                        <RefundAmount>1.00</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-03-07 12:38:00</InDate>
                        <EditUserName>EDI</EditUserName>
                        <EditDate>2012-03-07 13:07:02</EditDate>
                    </CourtesyRefundInfo>
                </Result>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

示例: Json, Response

{
"NeweggAPIResponse": {
"IsSuccess": "true",
"OperationType": "GetCourtesyRefundRequestStatusResponse",
"SellerID": "A006",
"ResponseBody": {
"ResponseList": {
"ResponseInfo": {
"RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
"RequestType": "COURTESYREFUND",
"RequestDate": "2012-03-07 12:37:09",
"RequestStatus": "FINISHED",
"Result": {
"CourtesyRefundInfo": {
"CourtesyRefundID": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
"SONumber": "164878278",
"SOAmount": "1.00",
"InvoiceNumber": "84724946",
"RefundAmount": "1.00",
"ReasonCode": "1",
"Reason": "Negative Customer Feedback",
"NoteToCustomer": "this is a test note",
"Status": "Close",
"IsNeweggRefund": "false",
"InUserName": "A006",
"InDate": "2012-03-07 12:38:00",
"EditUserName": "EDI",
"EditDate": "2012-03-07 13:07:02"
}
}
}
}
}
}
}
{ "NeweggAPIResponse": { "IsSuccess": "true", "OperationType": "GetCourtesyRefundRequestStatusResponse", "SellerID": "A006", "ResponseBody": { "ResponseList": { "ResponseInfo": { "RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8", "RequestType": "COURTESYREFUND", "RequestDate": "2012-03-07 12:37:09", "RequestStatus": "FINISHED", "Result": { "CourtesyRefundInfo": { "CourtesyRefundID": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8", "SONumber": "164878278", "SOAmount": "1.00", "InvoiceNumber": "84724946", "RefundAmount": "1.00", "ReasonCode": "1", "Reason": "Negative Customer Feedback", "NoteToCustomer": "this is a test note", "Status": "Close", "IsNeweggRefund": "false", "InUserName": "A006", "InDate": "2012-03-07 12:38:00", "EditUserName": "EDI", "EditDate": "2012-03-07 13:07:02" } } } } } } }
{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "OperationType": "GetCourtesyRefundRequestStatusResponse",
        "SellerID": "A006",
        "ResponseBody": {
            "ResponseList": {
                "ResponseInfo": {
                    "RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
                    "RequestType": "COURTESYREFUND",
                    "RequestDate": "2012-03-07 12:37:09",
                    "RequestStatus": "FINISHED",
                    "Result": {
                        "CourtesyRefundInfo": {
                            "CourtesyRefundID": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
                            "SONumber": "164878278",
                            "SOAmount": "1.00",
                            "InvoiceNumber": "84724946",
                            "RefundAmount": "1.00",
                            "ReasonCode": "1",
                            "Reason": "Negative Customer Feedback",
                            "NoteToCustomer": "this is a test note",
                            "Status": "Close",
                            "IsNeweggRefund": "false",
                            "InUserName": "A006",
                            "InDate": "2012-03-07 12:38:00",
                            "EditUserName": "EDI",
                            "EditDate": "2012-03-07 13:07:02"
                        }
                    }
                }
            }
        }
    }
}

請求失敗錯誤資訊

常規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