获取结算汇总报告
每个结算日获取结算/退款/佣金汇总报告。
相关URL
Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/result?{sellerid}&version={version} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?{sellerid}&version={version} Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?sellerid={sellerid}={version}
注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。
参数
名称 | 是否必填? | 描述 | ||||||||||||||||||||||||
sellerid | 是 | 您在新蛋商城的商家编号 | ||||||||||||||||||||||||
version | 是 | 有效版本:
|
相关请求信息
HTTP方式 | 是否需要认证? | 请求格式 | 回复格式 | 频率限制 |
PUT | 需要 | XML,Json | XML,Json | 500 请求/小时 |
请求文件主体
属性 | 是否必填? | 格式 | 描述 |
IssueUser | 否 | String | 请求发送者在Seller Portal上注册过的邮箱地址 。 系统只接受商家注册过的Seller Portal邮箱地址。如果为空,默认值为商家编号 |
OperationType | 是 | String | 固定值:SettlementSummaryReportRequest |
RequestID | 是 | String | 新蛋分配的已提交的请求的编号 |
PageIndex | 是 | Integer | 当前页索引 |
PageSize | 是 | Integer | 一页返回的记录总数
每页最多100条。 |
Schema: GetReportRequest.xsd
示例:XML,Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest > <OperationType>SettlementSummaryReportRequest</OperationType> <RequestBody> <RequestID>2PQBYWH4V68ZP</RequestID> <PageInfo> <PageIndex>1</PageIndex> <PageSize>10</PageSize> </PageInfo> </RequestBody> </NeweggAPIRequest>
示例:Json,Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "SettlementSummaryReportRequest", "RequestBody": { "RequestID": "2PQBYWH4V68ZP", "PageInfo": { "PageSize": "10", "PageIndex": "1" } } }
回复文件主体
属性 | 格式 | 描述 |
IsSuccess | String | 用于获取数据状态的操作 True:成功 False:失败 |
SellerID | String | 你的商家编号 |
OperationType | String | 固定值:GetSettlementSummaryInfoResponse |
RequestID | String | 你的请求编号 |
RequestDate | String | 请求时间(太平洋标准时间) |
TotalCount | Integer | 总记录数 |
TotalPageCount | Integer | 总页数 |
PageIndex | Integer | 当前页索引 |
PageSize | Integer | 一页的记录个数 |
SettlementDateFrom | String | 结算起始时间(太平洋标准时间) |
SettlementDateTo | String | 结算结束时间(太平洋标准时间) |
SettlementID | String | 结算编号 |
CheckNumber | String | 核查编号 |
ItemPrice | Decimal | 商品价格
|
Shipping | Decimal | 运费
|
TaxDuty | Decimal | 关税
不适用于Newggbusiness.com 和 Newegg.ca平台 |
GSTTotal | Decimal | 增值税总额
不适用于Newgg.com 和 Neweggbusiness.com平台 |
HSTTotal | Decimal | 消费税总额
不适用于Newgg.com 和 Neweggbusiness.com平台 |
GSTAndHST | Decimal | 消费税和增值税
不适用于Newgg.com 和 Neweggbusiness.com平台 |
PSTTotal | Decimal | 省销售税
不适用于Newgg.com 和 Neweggbusiness.com平台 |
PSTAndQST | Decimal | 省销售税(PST, QST)
不适用于Newgg.com 和 Neweggbusiness.com平台 |
EHFTotal | Decimal | 环境处理费
不适用于Newgg.com 和 Neweggbusiness.com平台 |
Other | Decimal | 其他
|
RecyclingFeeTotal | Decimal | 回收费是政府对新购买的电子产品、电池、新轮胎等征收的费用。这些费用用于支付这些产品的未来回收,因为其中许多产品含有有害物质。以下回收费用将添加到回收费用总额中:电子废物回收费、电池回收费、轮胎回收费、环保费。
|
TotalOrderAmount | Decimal | 订单总金额
|
Refunds | Decimal | 退款额
|
ChargeBack | Decimal | 信用卡拒付
|
MiscellaneousAdjustment | Decimal | 杂项调整
|
CourtesyRefund | Decimal | 补偿性退款
|
TotalRefunds | Decimal | 退款总金额
|
NeweggCommissionFee | Decimal | 新蛋佣金
|
NeweggTransactionFee | Decimal | 新蛋交易费
|
NeweggRefundCommissionFee | Decimal | 新蛋退款佣金
|
NeweggMonthlyFee | Decimal | 新蛋月费
|
NeweggStorageFee | Decimal | 新蛋保管费
|
NeweggRMABuyoutFee | Decimal | 新蛋RMA Buyout费
|
NeweggServiceFeeTax | Decimal | 新蛋服务税费
不适用于Newgg.com 和 Neweggbusiness.com平台 |
NeweggPremierFee | Decimal | 新蛋Premier费
|
NeweggShippingLabelFee | Decimal | 新蛋货运标签费
|
CreditCardPayment | Decimal | 信用卡支付
|
FulfillmentByNeweggFee | Decimal | 新蛋配送费
|
MultiChannelFee | Decimal | 多渠道运费
|
AdjustmentFee | Decimal | 其他
|
MerchandisingFee | Decimal | 广告费
|
TotalNeweggFee | Decimal | 新蛋费用总计
|
TotalSettlement | Decimal | 结算总计
|
ReservedBalance | Decimal | 预留金额 新蛋暂时扣留的金额,用于支付您账户上潜在的索赔,退货和退单 |
PreviousReservedBalance | Decimal | 上期预留金额:上一次汇款时暂时扣留的金额 |
Memo | String | 附加信息 |
Schema: settlementSummaryResponse.xsd
示例:XML,Response
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <SellerID>A09D</SellerID> <OperationType>GetSettlementSummaryInfoResponse</OperationType> <ResponseBody> <PageInfo> <TotalCount>1</TotalCount> <TotalPageCount>1</TotalPageCount> <PageSize>10</PageSize> <PageIndex>1</PageIndex> </PageInfo> <RequestID>2PQBZMZTL3DYF</RequestID> <RequestDate>2/21/2012 15:12:55</RequestDate> <SettlementSummaryList> <SettlementSummary> <SettlementDate>2/21/2012 12:00:00</SettlementDate> <SettlementDateFrom>8/5/2011 12:00:00</SettlementDateFrom> <SettlementDateTo>2/21/2012 12:00:00</SettlementDateTo> <SettlementID>0</SettlementID> <CheckNumber /> <ItemPrice>71.00</ItemPrice> <Shipping>31.95</Shipping> <Other>0.00</Other> <TotalOrderAmount>102.95</TotalOrderAmount> <Refunds>-1.98</Refunds> <ChargeBack>0.00</ChargeBack> <MiscellaneousAdjustment>-182.53</MiscellaneousAdjustment> <TotalRefunds>-184.51</TotalRefunds> <NeweggCommissionFee>-7.71</NeweggCommissionFee> <NeweggTransactionFee>0.00</NeweggTransactionFee> <NeweggRefundCommissionFee>0.15</NeweggRefundCommissionFee> <NeweggMonthlyFee>0.00</NeweggMonthlyFee> <NeweggStorageFee>-59.05</NeweggStorageFee> <NeweggRMABuyoutFee>-0.72</NeweggRMABuyoutFee> <NeweggPremierFee>0.00</NeweggPremierFee> <NeweggShippingLabelFee>0.00</NeweggShippingLabelFee> <TotalNeweggFee>-638.63</TotalNeweggFee> <TotalSettlement>-720.19</TotalSettlement> <ReservedBalance>12.22</ReservedBalance> <PreviousReservedBalance>1.22</PreviousReservedBalance> </SettlementSummary> </SettlementSummaryList> </ResponseBody> <Memo /> </NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <SellerID>BFUS</SellerID> <OperationType>GetSettlementSummaryInfoResponse</OperationType> <ResponseBody> <PageInfo> <TotalCount>2</TotalCount> <TotalPageCount>1</TotalPageCount> <PageIndex>1</PageIndex> <PageSize>10</PageSize> </PageInfo> <RequestID>24L8PVM11WG8S</RequestID> <RequestDate>04/27/2020 02:49:09</RequestDate> <SettlementSummaryList> <SettlementSummary> <SettlementDate>10/16/2019 00:00:00</SettlementDate> <SettlementDateFrom>05/14/2012 00:00:00</SettlementDateFrom> <SettlementDateTo>10/16/2019 00:00:00</SettlementDateTo> <SettlementID>0</SettlementID> <CheckNumber></CheckNumber> <ItemPrice>1256.46</ItemPrice> <Shipping>611.90</Shipping> <GSTTotal>41.00</GSTTotal> <HSTTotal>0.00</HSTTotal> <PSTTotal>0.00</PSTTotal> <EHFTotal>0.00</EHFTotal> <Other>0.00</Other> <TotalOrderAmount>1909.36</TotalOrderAmount> <Refunds>-36.50</Refunds> <ChargeBack>0.00</ChargeBack> <MiscellaneousAdjustment>-75.67</MiscellaneousAdjustment> <TotalRefunds>-112.17</TotalRefunds> <NeweggCommissionFee>-186.85</NeweggCommissionFee> <NeweggTransactionFee>0.00</NeweggTransactionFee> <NeweggRefundCommissionFee>3.65</NeweggRefundCommissionFee> <NeweggMonthlyFee>-19.99</NeweggMonthlyFee> <NeweggStorageFee>-6.98</NeweggStorageFee> <NeweggRMABuyoutFee>0.00</NeweggRMABuyoutFee> <NeweggServiceFeeTax>0.00</NeweggServiceFeeTax> <TotalNeweggFee>-263.29</TotalNeweggFee> <TotalSettlement>1533.90</TotalSettlement> <ReservedBalance>12.22</ReservedBalance> <PreviousReservedBalance>1.22</PreviousReservedBalance> </SettlementSummary> <SettlementSummary> <SettlementDate>04/22/2020 00:00:00</SettlementDate> <SettlementDateFrom>11/19/2013 00:00:00</SettlementDateFrom> <SettlementDateTo>04/22/2020 00:00:00</SettlementDateTo> <SettlementID>0</SettlementID> <CheckNumber></CheckNumber> <ItemPrice>1256.46</ItemPrice> <Shipping>611.90</Shipping> <GSTTotal>41.00</GSTTotal> <HSTTotal>0.00</HSTTotal> <PSTTotal>0.00</PSTTotal> <EHFTotal>0.00</EHFTotal> <Other>0.00</Other> <TotalOrderAmount>1930.36</TotalOrderAmount> <Refunds>-36.50</Refunds> <ChargeBack>0.00</ChargeBack> <MiscellaneousAdjustment>-75.67</MiscellaneousAdjustment> <TotalRefunds>-112.17</TotalRefunds> <NeweggCommissionFee>-186.85</NeweggCommissionFee> <NeweggTransactionFee>0.00</NeweggTransactionFee> <NeweggRefundCommissionFee>3.65</NeweggRefundCommissionFee> <NeweggMonthlyFee>0.00</NeweggMonthlyFee> <NeweggStorageFee>0.00</NeweggStorageFee> <NeweggRMABuyoutFee>0.00</NeweggRMABuyoutFee> <NeweggServiceFeeTax>-2.52</NeweggServiceFeeTax> <TotalNeweggFee>-200.79</TotalNeweggFee> <TotalSettlement>1617.40</TotalSettlement> <ReservedBalance>12.22</ReservedBalance> <PreviousReservedBalance>1.22</PreviousReservedBalance> </SettlementSummary> </SettlementSummaryList> </ResponseBody> <Memo></Memo> </NeweggAPIResponse>
示例:Json,Response
{ "NeweggAPIResponse": { "IsSuccess": "true", "SellerID": "A09D", "OperationType": "GetSettlementSummaryInfoResponse", "ResponseBody": { "PageInfo": { "TotalCount": "1", "TotalPageCount": "1", "PageSize": "10", "PageIndex": "1" }, "RequestID": "2PQBZMZTL3DYF", "RequestDate": "2/21/2012 15:12:55", "SettlementSummaryList": [ { "SettlementDate": "2/21/2012 12:00:00", "SettlementDateFrom": "8/5/2011 12:00:00", "SettlementDateTo": "2/21/2012 12:00:00", "SettlementID": "0", "ItemPrice": "71.00", "Shipping": "31.95", "Other": "0.00", "TotalOrderAmount": "102.95", "Refunds": "-1.98", "ChargeBack": "0.00", "MiscellaneousAdjustment": "-182.53", "TotalRefunds": "-184.51", "NeweggCommissionFee": "-7.71", "NeweggTransactionFee": "0.00", "NeweggRefundCommissionFee": "0.15", "NeweggMonthlyFee": "0.00", "NeweggStorageFee": "-59.05", "NeweggRMABuyoutFee": "-0.72", "NeweggPremierFee": "0.00", "NeweggShippingLabelFee": "0.00", "TotalNeweggFee": "-638.63", "TotalSettlement": "-720.19", "ReservedBalance": "12.22", "PreviousReservedBalance": "1.22" } ] } } }
{ "IsSuccess": "true", "SellerID": "BFUS", "OperationType": "GetSettlementSummaryInfoResponse", "ResponseBody": { "PageInfo": { "TotalCount": "2", "TotalPageCount": "1", "PageIndex": "1", "PageSize": "10" }, "RequestID": "24L8PVM11WG8S", "RequestDate": "04/27/2020 02:49:09", "SettlementSummaryList": [ { "SettlementDate": "10/16/2019 00:00:00", "SettlementDateFrom": "05/14/2012 00:00:00", "SettlementDateTo": "10/16/2019 00:00:00", "SettlementID": "0", "CheckNumber": [], "ItemPrice": "1256.46", "Shipping": "611.90", "GSTTotal": "41.00", "HSTTotal": "0.00", "PSTTotal": "0.00", "EHFTotal": "0.00", "Other": "0.00", "TotalOrderAmount": "1909.36", "Refunds": "-36.50", "ChargeBack": "0.00", "MiscellaneousAdjustment": "-75.67", "TotalRefunds": "-112.17", "NeweggCommissionFee": "-186.85", "NeweggTransactionFee": "0.00", "NeweggRefundCommissionFee": "3.65", "NeweggMonthlyFee": "-19.99", "NeweggStorageFee": "-6.98", "NeweggRMABuyoutFee": "0.00", "NeweggServiceFeeTax": "0.00", "TotalNeweggFee": "-263.29", "TotalSettlement": "1533.90", "ReservedBalance": "12.22", "PreviousReservedBalance": "1.22" }, { "SettlementDate": "04/22/2020 00:00:00", "SettlementDateFrom": "11/19/2013 00:00:00", "SettlementDateTo": "04/22/2020 00:00:00", "SettlementID": "0", "CheckNumber": [], "ItemPrice": "1256.46", "Shipping": "611.90", "GSTTotal": "41.00", "HSTTotal": "0.00", "PSTTotal": "0.00", "EHFTotal": "0.00", "Other": "0.00", "TotalOrderAmount": "1930.36", "Refunds": "-36.50", "ChargeBack": "0.00", "MiscellaneousAdjustment": "-75.67", "TotalRefunds": "-112.17", "NeweggCommissionFee": "-186.85", "NeweggTransactionFee": "0.00", "NeweggRefundCommissionFee": "3.65", "NeweggMonthlyFee": "0.00", "NeweggStorageFee": "0.00", "NeweggRMABuyoutFee": "0.00", "NeweggServiceFeeTax": "-2.52", "TotalNeweggFee": "-200.79", "TotalSettlement": "1617.40", "ReservedBalance": "12.22", "PreviousReservedBalance": "1.22" } ] }, "Memo": [] }
请求失败错误信息
常规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>
示例:Json,Response
[ { "Code": "CE001", "Message": "SellerID cannot be null or empty" } ]
更新日期:09/23/2021