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