The Buy Box report provides Buy Box information about a seller’s items.
To get the Buy Box Report, call GET /v3/getReport and specify buybox
for the type
query parameter (e.g. GET https://marketplace.walmartapis.com/v3/getReport?type=buybox).
What’s in the report CSV file?
The Buy Box report is returned in a .CSV file, with report name listed in content-disposition header, (e.g. filename=10000000354_2016-01-15T23:09:54.438+0000.zip). Your Partner ID is attached to report as a prefix, (e.g. 10000000354) followed by file generation timestamp.
The API response provides the .csv file with the following information about your buy box items:
Name | Description | Origin |
---|---|---|
Seller ID | The seller ID on Walmart.com | Walmart |
SKU | An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item | Seller |
Item ID | The item ID on Walmart.com | Seller |
Product Name | The name of this item | Seller |
Product Category | The category of this item | Walmart |
Seller Name | Name of the seller | Seller |
Seller Item Price | The price of the item | Seller |
Seller Ship Price | The shipping price of the item | Seller |
isSellerBuyBoxWinner | Specifies if seller is the BuyBox winner | Walmart |
BuyBox Seller ID | The BuyBox winner’s Seller ID | Walmart |
BuyBox Item Price | The BuyBox winner’s item price | Walmart |
BuyBox Ship Price | The BuyBox winner’s shipping price | Walmart |
Offer2 Seller ID | The Seller ID for offer 2 | Walmart |
Offer2 Item Price | The item price for offer 2 | Walmart |
Offer2 Ship Price | The shipping price of the item for offer 2 | Walmart |
Offer3 Seller ID | The Seller ID for offer 3 | Walmart |
Offer3 Item Price | The item price for offer 3 | Walmart |
Offer3 Ship Price | The shipping price of the item for offer 3 | Walmart |
Offer4 Seller ID | The Seller ID for offer 4 | Walmart |
Offer4 Item Price | The item price for offer 4 | Walmart |
Offer4 Ship Price | The shipping price of the item for offer 4 | Walmart |