Available
reconciliation report dates:
https://marketplace.walmartapis.com/v3/report/reconreport /availableReconFiles?partnerId={partnerId}&reportVersion=v1
Parse Report CSV file with Java
You can specify how to parse the Reports CSV files using Java code that we provide.
Parse CSV File with Java
To format the CSV file, you can this Java code to parse your response to a CSV file. This example demonstrates the use of the header and the body to process the response.
Example: Java code to parse CSV file
if (response.getStatus() == Response.Status.OK.getStatusCode() && response.hasEntity()) {
InputStream inputStream = (InputStream)response.getEntity();
try {
String header = response.getHeaderString("Content-Disposition");
if(header != null && !("").equals(header)) {
if(header.contains("filename")){
//header value will be something like:
//attachment; filename=10000000354_2016-01-15T23:09:54.438+0000.zip
int length = header.length();
String fileName = header.substring(header.indexOf("filename="),length);
System.out.println("filenameText " + fileName);
String [] str = fileName.split("=");
System.out.println("fileName: " + str[1]);
//replace "/Users/anauti1/Documents/" below with your values
File reportFile = new File("/Users/anauti1/Documents/" + str[1].toString());
OutputStream outStream = new FileOutputStream(reportFile);
byte[] buffer = new byte[8 * 1024];
int bytesRead;
while ((bytesRead = inputStream.read(buffer)) != -1) {
outStream.write(buffer, 0, bytesRead);
}
IOUtils.closeQuietly(inputStream);
IOUtils.closeQuietly(outStream);
}
}
}
catch (Exception ex){
System.out.print("Exception: " + ex.getMessage());
}
}
Generate a Payment Statement Report
Sellers can generate a payment statement report and obtain information about the current cycle outstanding balances and transaction details.
The Payments Statement API uses the GET method to obtain payment information. The following sections identify the summarize the method (parameter, headers, and responses) and requested payment information.
Headers
Authorization: String (required). Partner secret retrieved in integration step 2.
WM_SEC.ACCESS_TOKEN: String (required). Access token retrieved by Access Token Call.
Content-Type: String (required). Supported media (e.g., application/json).
WM_QOS.CORRELATION_ID: String (required). Unique ID identifying each API call.
WM_SVC.NAME: String (required). Walmart Service Name.
Responses
200 Successful operation: String array containing all available report dates is returned.
API Information
The Payment Statement API generates a report containing the following data retrieved from Walmart payment data stores:
sellerInfo
Seller information including store front URL, seller status, and payment status (e.g., ACTIVE).
accountSummary
Account summary information including opening balance, order activity etc.
transactionDetails
Transaction details including aggregated product price, net payable etc.
refundDetails
Refund details including refund related product price, net payable etc.
adjustmentAggregate
Adjustment information including service fees, like Walmart Fulfillment Services fee, preparation service fee etc.
partnerTxns
Partner taxes information.
Generate a Performance Report
Sellers can use the Payment Performance API to generate a report about performance indicators. These performance Indicators could affect your continued participation as a Walmart seller and your eligibility for the Marketplace Working Capital program.
The Payments Performance API uses the GET method to obtain payment information. The following sections summarize the method (parameter, headers, and responses) and requested payment information.
Headers
Authorization: String (required). Partner secret retrieved in integration step 2.
WM_SEC.ACCESS_TOKEN: String (required). Access token retrieved by Access Token Call.
Content-Type: String (required). Supported media (e.g., application/json).
WM_QOS.CORRELATION_ID: String (required). Unique ID identifying each API call.
WM_SVC.NAME: String (required). Walmart Service Name.
Responses
> 200 Successful operation: String array containing all available report dates is returned.
API Information
The Payments Performance API retrieves information about seller activities for 7, 14, 30, 60, and 90 day periods.
refundRateSellerFault
This is the rate of refunds to customers that are the seller’s fault.
refundRateCustomerFault
This is the rate of refunds that are the customer’s fault.
ots
On Time Shipping. It measure delivery performance in terms of the number of packages shipped on or before the expected shipment date.
otd
On Time Delivery. It measures delivery performance in terms of the number of packages delivered on or before the expected delivery date.
vtr
Valid Tracking Rate. It is a percentage indicating the relative correctness of delivery or shipment tracking.
cancellationSellerFault
Cancellation Seller Fault. It is the number of sales cancellations that are the seller’s fault.
cancellationCustomerFault
Cancellation Customer Fault. It is the number of sales cancellations that are the customer’s fault.
Generate a reconciliation report
Sellers and partners can look up available Marketplace reconciliation reports available by date and generate those reports to download or consume JSON response with the Reconciliation Report APIs.
Recon Report: This is the V1 recon report Endpoint, the
latest version of the V1 report (latest implementation of V1 report)
Recon Report Legacy: This is the V0 recon report
Endpoint, the earlier version (earlier implementation of V0 report)
1. Download CSV file 2. Json response. Json format is only supported for Recon report not the Recon report (legacy).
1. Receive CSV download file
Upon success, the API call to generate the report will stream the data via CSV file with the field values.
Recon File Fields
Recon Report
Name
Description
Type
Period Start Date
Period start date
String
Period End Date
Period end date
String
Total Payable
Total payable amount
String
Currency
Currency
String
Transaction Key
Transaction key
String
Transaction Posted Timestamp
Sales: when the shipment
confirmation was received Refunds: when the return or refund was invoiced
Adjustments: when the adjustment was issued
String
Transaction Type
SALE: sale transaction
REFUNDED: refund transaction ADJMNT: fees, corrections and adjustments which
will appear as credits or debits
String
Transaction Description
Transaction description
String
Customer Order #
Customer Order Number
String
Customer Order line #
Item number within the order
String
Purchase Order #
Purchase Order number
String
Purchase Order line #
Item number within the
Purchase Order
String
Amount
Amount
String
Amount Type
Type of amount
String
Name
Description
Type
Ship Qty
Shipped quantity
String
Commission Rate
Referral fee rate (%) on sale
String
Transaction Reason
Description
Transaction reason
description
String
Partner Item Id
Partner’s Item ID
String
Partner GTIN
Partner’s GTIN #
String
Partner Item Name
Partner’s item name
String
Product Tax Code
Item’s tax code, used to
calculate sales tax on item
String
Ship to
State
2 letter code of the state
where the order was shipped; Sales transactions
only
String
Ship to City
City where order was shipped;
Sales transactions only
String
Ship to Zipcode
Zip-code where order was
shipped
String
Contract Category
Contract Category for the
item sold
String
Product Type
Product Type for the item
sold
String
Commission Rule
Commission Rule Id
String
Shipping Method
Payment method used on the
sale
String
Fulfillment Type
Walmart Fulfilled(WFS) or
Seller Fulfilled
String
Campaign Id
Campaign Name for Walmart
Connect sellers
String
Recon Report (Legacy)
Name
Description
Type
Walmart.com Order #
Walmart Order Number
String
Walmart.com Order Line #
Item number within the order
String
Walmart.com PO #
Purchase Order number
String
Walmart.com P.O. Line #
Item number within the
Purchase Order
String
Partner Order #
Partner Order Number
String
Transaction Type
SALE: sale transaction
REFUNDED: refund transaction ADJMNT: fees, corrections and adjustments which
will appear as credits or debits
String
Transaction Date Time
Sales: when the shipment
confirmation was received Refunds: when the return or refund was invoiced
Adjustments: when the adjustment was issued
String
Shipped Qty
Shipped quantity
String
Partner Item ID
Partner’s Item ID
String
Partner GTIN
Partner’s GTIN #
String
Partner Item name
Partner’s item name
String
Product tax code
Item’s tax code, used to calculate
sales tax on item
String
Shipping tax code
Item’s tax code, used to
calculate sales tax on shipping (currently empty)
String
Gift wrap tax code
Item’s tax code, used to
calculate sales tax on gift wrap (currently empty)
String
Ship to state
2 letter code of the state
where the order was shipped; Sales transactions only
String
Ship to county
Code of county where item was
shipped (currently empty)
String
County Code
Code of city where item was
shipped (currently empty)
String
Ship to city
City where order was shipped;
Sales transactions only
String
Zip code
Zip-code where order was
shipped
String
shipping_method
Payment method used on the
sale
String
Total tender to / from
customer
Total amount received
from/refunded to customer on sale/refund
String
Payable to Partner from Sale
Total amount paid to/recouped
from partner on sale/refund
String
Commission from Sale
Referral fee paid to/recouped
from Walmart on sale/refund
String
Commission Rate
Referral fee rate (%) on
sale.
String
Gross Sales Revenue
Item price + shipping charge
on sale; total amount subject to referral fee
String
Refunded Retail Sales
Refunded item price +
shipping charge; refunds only
String
Sales refund for Escalation
This column has been retired
and merged into col #26 (Refunded Retail Sales)
String
Gross Shipping Revenue
Shipping charge on sale
String
Gross Shipping Refunded
Shipping amount refunded
String
Shipping refund for
Escalation
This column has been retired
and merged into col #29 (Gross Shipping Refunded)
String
Net Shipping Revenue
Sum of shipping revenue on
sales and refunds (col #28 + #29)
String
Gross Fee Revenue
Product fee collected from
customers on sale
String
Gross Fee Refunded
Amount of product fee
refunded
String
Fee refund for Escalation
This column has been retired
and merged into col #33
String
Net Fee Revenue
Sum of fee revenue on sales
and refunds (col #32 + #33)
String
Gift Wrap Quantity
Gift-Wrap quantity
String
Gross Gift-Wrap Revenue
Gift-Wrap charges collected
from customer
String
Gross Gift-Wrap Refunded
Refunded amount on Gift-Wrap
charges
String
Gift wrap refund for
Escalation
This column has been retired
and merged into col #38
String
Net Gift Wrap Revenue
Sum of gift-wrap revenue on
sales and refunds (col #37 + #38)
String
Tax on Sales Revenue
Sales tax amount on item
price
String
Tax on Shipping Revenue
Sales tax amount on shipping
charge
String
Tax on Gift-Wrap Revenue
Sales tax amount on Gift-Wrap
fee
String
Tax on Fee Revenue
Sales tax amount on Product
Fee
String
Effective tax rate
Sales tax rate
String
Tax on Refunded Sales
Refunded tax amount on item
price
String
Tax on Shipping Refund
Refunded tax amount on
shipping charge
String
Tax on Gift-Wrap Refund
Refunded tax amount on
Gift-Wrap charge
String
Tax on Fee Refund
Refunded tax amount on
Product Fee
String
Tax on Sales refund for
Escalation
This column has been retired
and merged into col #46
String
Tax on Shipping Refund for
Escalation
This column has been retired
and merged into col #47
String
Tax on Gift-Wrap Refund for
escalation
This column has been retired
and merged into col #48
String
Tax on Fee Refund for
escalation
This column has been retired
and merged into col #49
String
Total NET Tax Collected
For sales: sum of cols
#41-#44; Refunds: sum of cols #46-#49
String
Tax Withheld
Y: sales tax withheld by
Walmart; N: sales tax included in payment (col #22)
String
Adjustment Description
Return/refund or adjustment description
String
Adjustment Code
Return/refund or adjustment
code
String
Original Item price
Partner’s original item price
before CAP program adjustment
String
Original Commission Amount
Referral fee amount before
CAP program adjustment
String
Spec Category
Category provided by seller
during ingestion
String
Contract Category
Contract Category for the
item sold
String
Product Type
Product Type for the item
sold
String
Flex Commission Rule
Dynamic commission rule ID
(when applicable)
String
Return Reason Code
Customer given reason
associated with refund/return
String
Return Reason Description
Customer given reason code
associated with refund/return
String
Fee Withheld Flag
Y: product fee withheld by
Walmart; N: product fee included in payment (col #22)
String
Fulfillment Type
Walmart Fulfilled(WFS) or
Seller Fulfilled
String
2. Receive JSON Response for Recon Report:
Upon success, the API call to generate the
report will Generate Json response with the field values.
This endpoint takes 2 new parameters pageNo and limit. Parameter pageNo is for getting rows from CSV file and convert it into the JSON Payload along with Metadata. The Metadata contains ( FileSize, Total Rows In File, Total Pages, Rows On This Page, Page No.) To learn more about the file we are converting into JSON payload this Metadata is helpful for the developer to keep track the pages, etc. The Limit parameter used to estimate number of rows per page we want. The Response will have Metadata and the Content ( The JSON payload of the CSV file )
“customer_order_line” : Item number within the
order,
“transaction_posted_timestamp”
: Sales: when the shipment confirmation was received Refunds:
when the return or refund was invoiced Adjustments: when the adjustment was
issued
“partner_gtin” : Partner’s GTIN#,
“amount_type” : Type of Amount,
“ship_to_zipcode” : Zip-code where order was shipped,
“period_end_date” : Period end date,
“shipping_method” : Payment method used on the sale,
“purchase_order_line” : Item number within the Purchase Order,
“ship_to_city” : City where order was shipped; Sales transactions only,
“total_payable” : Total payable amount,
“partner_item_id” : Partner’s Item ID,
“currency” : Currency,
“commission_rule” : Commission Rule Id,
“amount” : Amount,
“partner_item_name” : Partner’s item name,
“transaction_type” : SALE: sale transaction REFUNDED: refund transaction ADJMNT:
fees, corrections and adjustments which will appear as credits or debits,
“contract_category” : Contract Category for the item sold,
“purchase_order” : Purchase Order number,
“customer_order” : Customer Order Number,
“period_start_date” : Period start date,
“commission_rate” : Referral fee rate (%) on sale
},
]
}
Handle report errors
You might see two types of errors when you request reports:
– File not found (404)
– Internal server error
File not found error
If you request reports and get “404 – File Not Found” error, it means that the cached report was not generated by Walmart.
To resolve file not found error:
Verify that there are items in the account, either through a call to Get all items or by using a UI. If there are no items, the 404 response is a valid response.
If items do exist, repeat the call after two hours, the file may have been regenerated.
If the error persists, contact Walmart Marketplace Support.
Internal server error
500 – Internal Server Error
The error is in the internal system. Wait for at least 15 minutes and try again. If the error persists, contact Walmart Marketplace Support.
