User Tools

Site Tools


relesenote_datafeed_05142019

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

relesenote_datafeed_05142019 [2019/04/18 09:26]
jn34 created
relesenote_datafeed_05142019 [2019/04/18 09:30] (current)
jn34
Line 1: Line 1:
 +==== Newegg Canada Update - Environmental Handling Fee (EHF) and Tax Types ==== 
  
 +**Overview:​**
 +  * Adding Environmental Handling Fee (EHF) on related functions.
 +  * Identify tax type: HST, GST, and PST in related settlement reports.
 +**Release Date:** May 14, 2019
 +=== Related Functions: ===
 +=== API- Get Order Information Response ===
 +
 +  * Additional element added: **EHFAmount** the total EHF for each order.
 +
 +
 +[[https://​mkpl.newegg.com/​Guideline/​ChangeHistory/​2019/​CANUpdate_040172019.zip|Download related schema]]
 +
 +Example: XML, Response
 +
 +  <?xml version="​1.0"​ encoding="​utf-8"?>​
 +  <​NeweggAPIResponse>​
 + <​IsSuccess>​true</​IsSuccess>​
 + <​OperationType>​GetOrderInfoResponse</​OperationType>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​ResponseBody>​
 + <​PageInfo>​
 + <​TotalCount>​1</​TotalCount>​
 + <​TotalPageCount>​1</​TotalPageCount>​
 + <​PageIndex>​1</​PageIndex>​
 + <​PageSize>​10</​PageSize>​
 + </​PageInfo>​
 + <​OrderInfoList>​
 + <​OrderInfo>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​OrderNumber>​230153115</​OrderNumber>​
 + <​InvoiceNumber>​48886647</​InvoiceNumber>​
 + <​OrderDownloaded>​true</​OrderDownloaded>​
 + <​OrderDate>​01/​22/​2019 19:​33:​51</​OrderDate>​
 + <​OrderStatus>​3</​OrderStatus>​
 + <​OrderStatusDescription>​Invoiced</​OrderStatusDescription>​
 + <​CustomerName><​![CDATA[ttttt rr]]></​CustomerName>​
 + <​CustomerPhoneNumber>​555-555-5555EXT5555</​CustomerPhoneNumber>​
 + <​CustomerEmailAddress>​ccan.q7ew1hlersgt9n@marketplace.newegg.com</​CustomerEmailAddress>​
 + <​ShipToAddress1><​![CDATA[yiyi]]></​ShipToAddress1>​
 + <​ShipToAddress2/>​
 + <​ShipToCityName>​fdfdg</​ShipToCityName>​
 + <​ShipToStateCode>​AB</​ShipToStateCode>​
 + <​ShipToZipCode>​T2J 6W2</​ShipToZipCode>​
 + <​ShipToCountryCode>​CA</​ShipToCountryCode>​
 + <​ShipService>​International Economy Shipping(8-15 business days)</​ShipService>​
 + <​ShipToFirstName><​![CDATA[ttttt]]></​ShipToFirstName>​
 + <​ShipToLastName><​![CDATA[rr]]></​ShipToLastName>​
 + <​ShipToCompany/>​
 + <​OrderItemAmount>​400.00</​OrderItemAmount>​
 + <​ShippingAmount>​2.00</​ShippingAmount>​
 + <​DiscountAmount>​0.00</​DiscountAmount>​
 + <​GSTorHSTAmount>​20.70</​GSTorHSTAmount>​
 + <​PSTorQSTAmount>​0.00</​PSTorQSTAmount>​
 + <​EHFAmount>​12.00</​EHFAmount>​
 + <​RefundAmount>​0.00</​RefundAmount>​
 + <​OrderTotalAmount>​434.70</​OrderTotalAmount>​
 + <​OrderQty>​1</​OrderQty>​
 + <​IsAutoVoid>​false</​IsAutoVoid>​
 + <​ItemInfoList>​
 + <​ItemInfo>​
 + <​SellerPartNumber><​![CDATA[Test_SP1070726081400351]]></​SellerPartNumber>​
 + <​NeweggItemNumber>​9SIBFUZ03G8215</​NeweggItemNumber>​
 + <​MfrPartNumber><​![CDATA[Test1070726081400351]]></​MfrPartNumber>​
 + <​UPCCode>​7072608140035</​UPCCode>​
 + <​Description><​![CDATA[Test_WST1070726081400351]]></​Description>​
 + <​OrderedQty>​1</​OrderedQty>​
 + <​ShippedQty>​1</​ShippedQty>​
 + <​UnitPrice>​100.00</​UnitPrice>​
 + <​ExtendUnitPrice>​100.00</​ExtendUnitPrice>​
 + <​UnitShippingCharge>​0.50</​UnitShippingCharge>​
 + <​ExtendShippingCharge>​0.50</​ExtendShippingCharge>​
 + <​Status>​2</​Status>​
 + <​StatusDescription>​Shipped</​StatusDescription>​
 + </​ItemInfo>​
 + </​ItemInfoList>​
 + <​PackageInfoList>​
 + <​PackageInfo>​
 + <​PackageType>​Shipped</​PackageType>​
 + <​ShipCarrier>​FedEx</​ShipCarrier>​
 + <​ShipService>​jjjj</​ShipService>​
 + <​TrackingNumber>​20190124_002</​TrackingNumber>​
 + <​ShipDate>​01/​23/​2019 19:​39:​07</​ShipDate>​
 + <​ShipFromAddress><​![CDATA[MainAddress1]]></​ShipFromAddress>​
 + <​ShipFromAddress2><​![CDATA[MainAddress2]]></​ShipFromAddress2>​
 + <​ShipFromCity>​MainCity</​ShipFromCity>​
 + <​ShipFromState>​NL</​ShipFromState>​
 + <​ShipFromZipCode>​ASD3</​ShipFromZipCode>​
 + <​ShipFromName/>​
 + <​ItemInfoList>​
 + <​ItemInfo>​
 + <​SellerPartNumber><​![CDATA[Test_SP1070726081400351]]></​SellerPartNumber>​
 + <​MfrPartNumber><​![CDATA[Test1070726081400351]]></​MfrPartNumber>​
 + <​ShippedQty>​1</​ShippedQty>​
 + </​ItemInfo>​
 + </​ItemInfoList>​
 + </​PackageInfo>​
 + </​PackageInfoList>​
 + </​OrderInfo>​
 + </​OrderInfoList>​
 + </​ResponseBody>​
 + <​ResponseDate>​03/​28/​2019 20:​11:​54</​ResponseDate>​
 + <​Memo/>​
 +  </​NeweggAPIResponse>​
 +
 +=== API- Get Order List Report Response ===
 +
 +  * Additional element added: **EHFAmount** the total EHF for each order.
 +
 +
 +[[https://​mkpl.newegg.com/​Guideline/​ChangeHistory/​2019/​CANUpdate_040172019.zip|Download related schemas]]
 +
 +Example: XML, Response
 +
 +  <?xml version="​1.0"​ encoding="​utf-8"?>​
 +  <​NeweggAPIResponse>​
 + <​IsSuccess>​true</​IsSuccess>​
 + <​OperationType>​GetOrderInfoResponse</​OperationType>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​ResponseBody>​
 + <​PageInfo>​
 + <​TotalCount>​1</​TotalCount>​
 + <​TotalPageCount>​1</​TotalPageCount>​
 + <​PageIndex>​1</​PageIndex>​
 + <​PageSize>​30</​PageSize>​
 + </​PageInfo>​
 + <​RequestID>​25JCMX3AO33K8</​RequestID>​
 + <​RequestDate>​03/​28/​2019 19:​02:​48</​RequestDate>​
 + <​OrderInfoList>​
 + <​OrderInfo>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​OrderNumber>​230153935</​OrderNumber>​
 + <​InvoiceNumber>​48886736</​InvoiceNumber>​
 + <​OrderDownloaded>​true</​OrderDownloaded>​
 + <​OrderDate>​01/​23/​2019 23:​33:​38</​OrderDate>​
 + <​OrderStatus>​3</​OrderStatus>​
 + <​OrderStatusDescription>​Invoiced</​OrderStatusDescription>​
 + <​CustomerName><​![CDATA[rrr ​ tttttt]]></​CustomerName>​
 + <​CustomerPhoneNumber>​033-123-4567</​CustomerPhoneNumber>​
 + <​CustomerEmailAddress>​ccan.q7fw1gtercgt9e@marketplace.newegg.com</​CustomerEmailAddress>​
 + <​ShipToAddress1><​![CDATA[yyyyyy zzzz]]></​ShipToAddress1>​
 + <​ShipToAddress2><​![CDATA[DaDa DIDI]]></​ShipToAddress2>​
 + <​ShipToCityName>​CD</​ShipToCityName>​
 + <​ShipToStateCode>​AB</​ShipToStateCode>​
 + <​ShipToZipCode>​T2J 6W2</​ShipToZipCode>​
 + <​ShipToCountryCode>​CA</​ShipToCountryCode>​
 + <​ShipService>​International Economy Shipping(8-15 business days)</​ShipService>​
 + <​ShipToFirstName><​![CDATA[rrr]]></​ShipToFirstName>​
 + <​ShipToLastName><​![CDATA[tttttt]]></​ShipToLastName>​
 + <​ShipToCompany/>​
 + <​OrderItemAmount>​380.00</​OrderItemAmount>​
 + <​ShippingAmount>​2.01</​ShippingAmount>​
 + <​DiscountAmount>​0.00</​DiscountAmount>​
 + <​GSTorHSTAmount>​19.70</​GSTorHSTAmount>​
 + <​PSTorQSTAmount>​0.00</​PSTorQSTAmount>​
 + <​EHFAmount>​12.00</​EHFAmount>​
 + <​RefundAmount>​0.00</​RefundAmount>​
 + <​OrderTotalAmount>​413.71</​OrderTotalAmount>​
 + <​OrderQty>​1</​OrderQty>​
 + <​IsAutoVoid>​false</​IsAutoVoid>​
 + <​ItemInfoList>​
 + <​ItemInfo>​
 + <​SellerPartNumber><​![CDATA[Test_SP190123163321707]]></​SellerPartNumber>​
 + <​NeweggItemNumber>​9SIBFUZ03H3272</​NeweggItemNumber>​
 + <​MfrPartNumber><​![CDATA[Test190123163321707]]></​MfrPartNumber>​
 + <​UPCCode>​0123163321707</​UPCCode>​
 + <​Description><​![CDATA[Test_WST190123163321707]]></​Description>​
 + <​OrderedQty>​1</​OrderedQty>​
 + <​ShippedQty>​1</​ShippedQty>​
 + <​UnitPrice>​100.00</​UnitPrice>​
 + <​ExtendUnitPrice>​100.00</​ExtendUnitPrice>​
 + <​UnitShippingCharge>​0.67</​UnitShippingCharge>​
 + <​ExtendShippingCharge>​0.67</​ExtendShippingCharge>​
 + <​Status>​2</​Status>​
 + <​StatusDescription>​Shipped</​StatusDescription>​
 + </​ItemInfo>​
 + </​ItemInfoList>​
 + <​PackageInfoList>​
 + <​PackageInfo>​
 + <​PackageType>​Shipped</​PackageType>​
 + <​ShipCarrier>​yerry</​ShipCarrier>​
 + <​ShipService>​yuyuy</​ShipService>​
 + <​TrackingNumber>​2555555</​TrackingNumber>​
 + <​ShipDate>​01/​29/​2019 22:​52:​56</​ShipDate>​
 + <​ShipFromAddress><​![CDATA[MainAddress1]]></​ShipFromAddress>​
 + <​ShipFromAddress2><​![CDATA[MainAddress2]]></​ShipFromAddress2>​
 + <​ShipFromCity>​MainCity</​ShipFromCity>​
 + <​ShipFromState>​NL</​ShipFromState>​
 + <​ShipFromZipCode>​ASD3</​ShipFromZipCode>​
 + <​ShipFromName/>​
 + <​ItemInfoList>​
 + <​ItemInfo>​
 + <​SellerPartNumber><​![CDATA[Test_SP190123163321707]]></​SellerPartNumber>​
 + <​MfrPartNumber><​![CDATA[Test190123163321707]]></​MfrPartNumber>​
 + <​ShippedQty>​1</​ShippedQty>​
 + </​ItemInfo>​
 + </​ItemInfoList>​
 + </​PackageInfo>​
 + </​PackageInfoList>​
 + </​OrderInfo>​
 + </​OrderInfoList>​
 + </​ResponseBody>​
 +  </​NeweggAPIResponse>​
 +
 +=== API- Get Settlement Transaction Report Response ===
 +
 +  * New transaction types values added: **EHF, HST, GST, PST**
 +
 +
 +[[https://​mkpl.newegg.com/​Guideline/​ChangeHistory/​2019/​CANUpdate_040172019.zip|Download related schemas]]
 +
 +Example: XML, Response
 +
 +  <?xml version="​1.0"​ encoding="​utf-8"?>​
 +  <​NeweggAPIResponse>​
 + <​IsSuccess>​true</​IsSuccess>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​OperationType>​GetSettlementTransactionInfoResponse</​OperationType>​
 + <​ResponseBody>​
 + <​PageInfo>​
 + <​TotalCount>​34</​TotalCount>​
 + <​TotalPageCount>​2</​TotalPageCount>​
 + <​PageIndex>​1</​PageIndex>​
 + <​PageSize>​28</​PageSize>​
 + </​PageInfo>​
 + <​RequestID>​26ET8QW575DLK</​RequestID>​
 + <​RequestDate>​03/​27/​2019 20:​19:​14</​RequestDate>​
 + <​SettlementTransactionInfoList>​
 + <​SettlementTransactionInfo>​
 + <​TransactionDate>​01/​23/​2019 00:​00:​00</​TransactionDate>​
 + <​TransactionType>​EHF</​TransactionType>​
 + <​OrderID>​230153055 </​OrderID>​
 + <​InvoiceID>​48886646 ​ </​InvoiceID>​
 + <​SellerPartNumber/>​
 + <​Amount>​4.00</​Amount>​
 + <​CommissionFee>​0.00</​CommissionFee>​
 + <​SettlementID/>​
 + <​NeweggItemNumber/>​
 + <​ItemCondition/>​
 + <​Shipping>​0.00</​Shipping>​
 + <​NOTE>​This refers to dererefasdfasdfsdaf</​NOTE>​
 + </​SettlementTransactionInfo>​
 + <​SettlementTransactionInfo>​
 + <​TransactionDate>​01/​23/​2019 00:​00:​00</​TransactionDate>​
 + <​TransactionType>​GST</​TransactionType>​
 + <​OrderID>​230150895 </​OrderID>​
 + <​InvoiceID>​48886644 ​ </​InvoiceID>​
 + <​SellerPartNumber/>​
 + <​Amount>​23.10</​Amount>​
 + <​CommissionFee>​0.00</​CommissionFee>​
 + <​SettlementID>​2000000013</​SettlementID>​
 + <​NeweggItemNumber/>​
 + <​ItemCondition/>​
 + <​Shipping>​0.00</​Shipping>​
 + </​SettlementTransactionInfo>​
 + <​SettlementTransactionInfo>​
 + <​TransactionDate>​01/​23/​2019 00:​00:​00</​TransactionDate>​
 + <​TransactionType>​Order</​TransactionType>​
 + <​OrderID>​230150895 </​OrderID>​
 + <​InvoiceID>​48886644 ​ </​InvoiceID>​
 + <​SellerPartNumber>​Test_SP1070726081400308</​SellerPartNumber>​
 + <​ItemDescription>​Test_WST1070726081400308</​ItemDescription>​
 + <​Amount>​100.00</​Amount>​
 + <​CommissionFee>​-3.52</​CommissionFee>​
 + <​SettlementID>​2000000013</​SettlementID>​
 + <​NeweggItemNumber>​9SIBFUZ03G8214</​NeweggItemNumber>​
 + <​ItemCondition>​New</​ItemCondition>​
 + <​Shipping>​0.45</​Shipping>​
 + </​SettlementTransactionInfo>​
 + </​SettlementTransactionInfoList>​
 + </​ResponseBody>​
 + <​Memo/>​
 +  </​NeweggAPIResponse>​
 +
 +
 +=== API- Get Settlement Summary Report Response ===
 +
 +  * Additional element added: **GSTTotal, HSTTotal, PSTTotal, EHFTotal**
 +
 +
 +[[https://​mkpl.newegg.com/​Guideline/​ChangeHistory/​2019/​CANUpdate_040172019.zip|Download related schemas]]
 +
 +Example: XML, Response
 +
 +  <?xml version="​1.0"​ encoding="​utf-8"?>​
 +  <​NeweggAPIResponse>​
 + <​IsSuccess>​true</​IsSuccess>​
 + <​SellerID>​BFUZ</​SellerID>​
 + <​OperationType>​GetSettlementSummaryInfoResponse</​OperationType>​
 + <​ResponseBody>​
 + <​PageInfo>​
 + <​TotalCount>​2</​TotalCount>​
 + <​TotalPageCount>​1</​TotalPageCount>​
 + <​PageIndex>​1</​PageIndex>​
 + <​PageSize>​30</​PageSize>​
 + </​PageInfo>​
 + <​RequestID>​22UA6HEN1PELU</​RequestID>​
 + <​RequestDate>​03/​25/​2019 23:​22:​44</​RequestDate>​
 + <​SettlementSummaryList>​
 + <​SettlementSummary>​
 + <​SettlementDate>​01/​23/​2019 00:​00:​00</​SettlementDate>​
 + <​SettlementDateFrom>​01/​23/​2019 00:​00:​00</​SettlementDateFrom>​
 + <​SettlementDateTo>​01/​23/​2019 00:​00:​00</​SettlementDateTo>​
 + <​SettlementID>​2000000014</​SettlementID>​
 + <​CheckNumber/>​
 + <​ItemPrice>​340.00</​ItemPrice>​
 + <​Shipping>​2.01</​Shipping>​
 + <​GSTTotal>​17.85</​GSTTotal>​
 + <​HSTTotal>​2.20</​HSTTotal>​
 + <​PSTTotal>​1.10</​PSTTotal>​
 + <​EHFTotal>​15.00</​EHFTotal>​
 + <​Other>​0.00</​Other>​
 + <​TotalOrderAmount>​378.16</​TotalOrderAmount>​
 + <​Refunds>​0.00</​Refunds>​
 + <​ChargeBack>​0.00</​ChargeBack>​
 + <​MiscellaneousAdjustment>​0.00</​MiscellaneousAdjustment>​
 + <​TotalRefunds>​0.00</​TotalRefunds>​
 + <​NeweggCommissionFee>​-41.66</​NeweggCommissionFee>​
 + <​NeweggTransactionFee>​0.00</​NeweggTransactionFee>​
 + <​NeweggRefundCommissionFee>​0.00</​NeweggRefundCommissionFee>​
 + <​NeweggMonthlyFee>​0.00</​NeweggMonthlyFee>​
 + <​NeweggStorageFee>​0.00</​NeweggStorageFee>​
 + <​NeweggRMABuyoutFee>​0.00</​NeweggRMABuyoutFee>​
 + <​TotalNeweggFee>​-41.66</​TotalNeweggFee>​
 + <​TotalSettlement>​336.50</​TotalSettlement>​
 + </​SettlementSummary>​
 + </​SettlementSummaryList>​
 + </​ResponseBody>​
 + <​Memo/>​
 +  </​NeweggAPIResponse>​
 +
 +=== Data feed template- Ship Order Template ===
 +
 +  * A New field: **EHFTotal** is added to identify the total EHF for each order.
 +
 +
 +[[https://​mkpl.newegg.com/​Guideline/​ChangeHistory/​2019/​CANUpdate_040172019.zip|Download template]]
 +
 +[[Update History|Back]]

Page Tools