# Delete Walmart Product From Oversight Tracking
Source: https://docs.rivin.ai/api-reference/endpoint/delete-walmart-oversight-product
DELETE /walmart/oversight/products/{id}
This endpoint deletes a product from a user's tracked products in Rivin.ai's Oversight Tracking.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 requests/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: Removing products from oversight tracking costs **0 credits**. Credits are charged daily based on your chosen oversight tier when data is queried:
**Tier 0** (Every hour in depth): 150 credits/day - **Units in stock for ALL sellers + Price history for EACH seller every hour on query**\
**Tier 1** (Every 2 hours): 90 credits/day\
**Tier 2** (6 hours): 35 credits/day\
**Tier 3** (12 hours): 20 credits/day\
**Tier 4** (Daily): 10 credits/day
```bash Example request theme={null}
curl -X DELETE "http://rivin.ai/api/walmart/oversight/products/ov_123456789" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
// 204 No Content - Product successfully deleted from oversight tracking
```
**Oversight Management**: Remove products from your oversight tracking when they're no longer needed. This helps manage your tracking portfolio and optimize credit usage.
# Get User Credit Information
Source: https://docs.rivin.ai/api-reference/endpoint/get-user-credits
GET /user/credits
This endpoint allows users to query their remaining credits and billing period information. It requires a valid API key and returns comprehensive credit usage information.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Credit Cost**: This endpoint costs **0 credits** to query your credit information. It's free to check your remaining credits and billing status.
**Rate Limit**: This endpoint has a default rate limit of **10 requests/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
```bash Example request theme={null}
curl -X GET "https://rivin.ai/api/user/credits" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"user_email": "user@example.com",
"credits": {
"total": 300000,
"used_this_month": 114500,
"remaining": 185500,
"usage_percentage": 38
},
"billing_period": {
"current_period_start": "2024-01-01T00:00:00Z",
"next_refresh_date": "2024-02-01T00:00:00Z",
"days_until_refresh": 12
},
"account_info": {
"created_at": "2023-12-15T10:30:00Z",
"last_updated": "2024-01-15T14:22:00Z"
}
}
```
**Credit Refresh**: Credits refresh monthly based on your billing cycle. The exact refresh date depends on when your account was created or when you last upgraded your plan.
# Get Oversight Data for Specific Product
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-oversight-product
GET /walmart/oversight/products/{id}
This endpoint returns detailed oversight tracking data for a specific product.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 requests/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: Retrieving oversight data costs **0 credits**. Credits are charged daily based on your chosen oversight tier when data is queried:
**Tier 1** (Every hour): 100 credits/day\
**Tier 2** (6 hours): 35 credits/day\
**Tier 3** (12 hours): 20 credits/day\
**Tier 4** (Daily): 10 credits/day
```bash Example request theme={null}
curl -X GET "http://rivin.ai/api/walmart/oversight/products/ov_123456789" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"id": "ov_123456789",
"walmart_product_code": "1370971228",
"user_id": "user_123",
"created_at": "2024-01-15T10:30:00Z",
"tracking_data": {
"current_price": 39.88,
"units_in_stock": 45,
"last_updated": "2024-01-15T10:30:00Z"
}
}
```
**Detailed Tracking**: This endpoint provides comprehensive oversight data for a specific tracked product, including current pricing, inventory levels, and tracking metadata. Use this to get real-time insights into your tracked products.
# Get List of Currently Tracked Oversight Products
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-oversight-products
GET /walmart/oversight/products
This endpoint returns a list of all products currently being tracked in oversight for the authenticated user.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 requests/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: Listing oversight products costs **0 credits**. Credits are charged daily based on your chosen oversight tier when data is queried:
**Tier 0** (Every hour in depth): 150 credits/day - **Units in stock for EACH seller + Price history for EACH seller every hour on query**\
**Tier 1** (Every 2 hours): 90 credits/day\
**Tier 2** (6 hours): 35 credits/day\
**Tier 3** (12 hours): 20 credits/day\
**Tier 4** (Daily): 10 credits/day
```bash Example request theme={null}
curl -X GET "http://rivin.ai/api/walmart/oversight/products" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
[
{
"id": "ov_123456789",
"walmart_product_code": "1370971228",
"user_id": "user_123",
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": "ov_987654321",
"walmart_product_code": "46275738",
"user_id": "user_123",
"created_at": "2024-01-14T15:45:00Z"
}
]
```
**Oversight Tracking**: This endpoint returns all products currently being tracked in your oversight dashboard. Use this to monitor your active tracking list and manage your oversight portfolio.
# Get Walmart Product Details
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-product-details
GET /walmart/product/details
This endpoint accepts a UPC, EAN, or Walmart product code and returns the matching Walmart product listing with basic product data.
**Rate Limit**: This endpoint has a default rate limit of **10 products/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: This endpoint costs **1 credit** per successful request. Credits are only deducted when the API call succeeds and returns product data. Failed requests (errors, rate limits, etc.) do not consume credits.
```bash Example UPC Request theme={null}
curl -X GET "http://rivin.ai/api/walmart/product/details?upc=040094535309" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"upc": "040094535309",
"ean": "0400945353092",
"walmart_product_code": "1288567194",
"categories": ["Home", "Appliances", "Kitchen Appliances", "Blenders", "Hamilton Beach Blenders"],
"buybox_price": 32.88,
"customer_rating": 4.3,
"number_of_reviews": 2846
}
```
# Get Walmart Fees for a Product
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-product-fees
GET /walmart/product/fees
This endpoint returns the various fees associated with selling a specific Walmart product.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 products/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: This endpoint costs **3 credits** per successful request. Credits are only deducted when the API call succeeds and returns product data. Failed requests (errors, rate limits, etc.) do not consume credits.
```bash Example request theme={null}
curl -X GET "http://rivin.ai/api/walmart/product/fees?walmart_product_code=1370971228" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"walmart_product_code": "1370971228",
"referral_fee": 15.0,
"closing_fee": 0.99,
"shipping_fee": 4.99,
"total_fees": 20.98
}
```
**Fee Structure**: Fees may vary based on product category, seller type, and current promotions. All fees are in USD and represent the total cost to sell the product on Walmart's marketplace.
# Get Product Offers
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-product-offers
GET /walmart/product/offers
This endpoint returns the current inventory levels for each seller of a specific Walmart product.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 products/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: This endpoint costs **5 credits** per successful request. Credits are only deducted when the API call succeeds and returns product data. Failed requests (errors, rate limits, etc.) do not consume credits.
```bash Example request theme={null}
curl -X GET "http://rivin.ai/api/walmart/product/offers?walmart_product_code=1370971228" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"walmart_product_code": "1370971228",
"sellers": [
{
"seller_name": "Walmart.com",
"units_in_stock": 45,
"last_updated": "2024-01-15T10:30:00Z"
},
{
"seller_name": "Third Party Seller",
"units_in_stock": 12,
"last_updated": "2024-01-15T09:15:00Z"
}
]
}
```
**Inventory Tracking**: This endpoint provides real-time inventory levels for all sellers of a specific product. Data is updated frequently but may have slight delays depending on seller update frequency.
# Get Walmart Product Price History
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-product-price-history
GET /walmart/product/price-history
This endpoint accepts a Walmart product code and returns an array of the buybox price history.
**Rate Limit**: This endpoint has a default rate limit of **10 products/second** per account. Need higher limits? [**Contact our support team**](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: This endpoint costs **15 credits** per successful request. Credits are only deducted when the API call succeeds and returns product data. Failed requests (errors, rate limits, etc.) do not consume credits.
```bash Example walmart_product_code price history request theme={null}
curl -X GET "http://rivin.ai/api/walmart/product/price-history?walmart_product_code=1370971228" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```successful response theme={null}
{
"walmart_product_code":"46275738",
"priceHistory":
[
{"date":"2024-09-02T04:17:40Z","price":39.88},
{"date":"2024-10-21T04:13:26Z","price":48.39},
{"date":"2024-10-22T04:14:28Z","price":39.88},
{"date":"2024-11-18T04:22:31Z","price":37.16},
{"date":"2024-11-19T04:13:32Z","price":39.88},
{"date":"2024-12-30T21:09:02Z","price":70.78},
{"date":"2024-12-31T04:15:07Z","price":39.88},
{"date":"2025-04-07T04:17:04Z","price":35.99},
{"date":"2025-04-08T04:13:39Z","price":35.5},
{"date":"2025-04-09T04:18:39Z","price":39.88},
{"date":"2025-04-11T04:21:08Z","price":34.79},
{"date":"2025-04-12T04:14:05Z","price":39.88},
{"date":"2025-04-29T15:59:21Z","price":35.79},
{"date":"2025-04-30T04:17:41Z","price":39.88},
{"date":"2025-05-24T04:17:28Z","price":37},
{"date":"2025-05-25T04:18:08Z","price":39.88},
{"date":"2025-05-28T04:22:28Z","price":41.94},
{"date":"2025-06-07T10:09:50Z","price":38.25},
{"date":"2025-06-09T04:18:41Z","price":41.94},
{"date":"2025-06-19T04:18:57Z","price":37.51},
{"date":"2025-06-20T04:22:19Z","price":41.94},
{"date":"2025-08-26T19:12:23Z","price":34.99},
{"date":"2025-08-27T12:55:26Z","price":41.94}
]
}
```
This api/walmart/product/price-history endpoint **only tracks the Walmart buybox price and time** — not prices for each individual seller on a listing.
[Rivin.ai](http://Rivin.ai) **periodically pulls prices for different products** depending on their **monthly sales volume**, with high-volume products tracked more frequently.
If you need to **guarantee tracking** of a specific product (including prices per seller, inventory in stock per seller, and sales captured per seller), use our **/api/walmart/oversight** endpoints instead.
# Get Units Sold History Estimate
Source: https://docs.rivin.ai/api-reference/endpoint/get-walmart-product-units-sold-history
GET /walmart/product/units-sold-history
This endpoint returns estimated sales history for a specific Walmart product.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 products/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: This endpoint costs range from **5 to 150 credits** depending on the time period requested:
* **1 month**: 5 credits
* **6 months**: 25 credits
* **1 year**: 50 credits
* **3 years**: 100 credits
* **All time**: 150 credits
Credits are only deducted when the API call succeeds and returns product data. Failed requests (errors, rate limits, etc.) do not consume credits.
```bash Example request theme={null}
curl -X GET "http://rivin.ai/api/walmart/product/units-sold-history?walmart_product_code=1370971228&time_period=6months" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)"
```
```json API Response theme={null}
{
"walmart_product_code": "1370971228",
"time_period": "6months",
"credit_cost": 25,
"sales_history": [
{
"date": "2024-01-15",
"units_sold": 25
},
{
"date": "2024-01-14",
"units_sold": 18
},
{
"date": "2024-01-13",
"units_sold": 32
}
]
}
```
**Time Periods**: The `time_period` query parameter is required and specifies how much historical data you need. Longer time periods provide more comprehensive insights but cost more credits.
**Sales Estimates**: This endpoint provides estimated daily sales data based on various factors including market analysis, historical trends, and available data sources.
# Add Walmart Product To Oversight Tracking
Source: https://docs.rivin.ai/api-reference/endpoint/post-walmart-oversight-product
POST /walmart/oversight/products
This endpoint adds a product to a user's tracked products in Rivin.ai's Oversight product.
**🚧 Coming Soon**: This endpoint is currently in development and will be available soon. Stay tuned for updates!
**Rate Limit**: This endpoint has a default rate limit of **10 requests/second** per account. Need higher limits? [Contact our support team](https://cal.com/rivin-ai/30min) - we can accommodate any rate limit requirements on request.
**Credit Cost**: Adding products to oversight tracking costs **0 credits**. Credits are charged daily based on your chosen oversight tier when data is queried:
**Tier 0** (Every hour in depth): 150 credits/day - **Units in stock for EACH seller + Price history for EACH seller every hour on query**\
**Tier 1** (Every 2 hours): 90 credits/day\
**Tier 2** (6 hours): 35 credits/day\
**Tier 3** (12 hours): 20 credits/day\
**Tier 4** (Daily): 10 credits/day
```bash Example request theme={null}
curl -X POST "http://rivin.ai/api/walmart/oversight/products" \
-H "Content-Type: application/json" \
-H "x-api-key: (YOUR_API_KEY_HERE)" \
-d '{
"walmart_product_code": "1370971228"
}'
```
```json API Response theme={null}
{
"id": "ov_123456789",
"walmart_product_code": "1370971228",
"user_id": "user_123",
"created_at": "2024-01-15T10:30:00Z"
}
```
**Oversight Tracking**: Add products to your oversight dashboard to track pricing, inventory, and sales data over time. This provides comprehensive monitoring capabilities for your product portfolio.
# Rivin.ai Walmart API Reference
Source: https://docs.rivin.ai/api-reference/introduction
Complete API reference for accessing Walmart product data, price history, and oversight tracking
The Rivin.ai Walmart API provides comprehensive access to Walmart's product catalog, including real-time pricing, historical data, and product categorization. Build powerful e-commerce applications with accurate, up-to-date product information.
## **API Overview**
Our API offers comprehensive Walmart data access across multiple categories:
### **Real-time Product Info**
* **GET** `/walmart/product/details` - Retrieve detailed product information using UPC, EAN, or Walmart product codes
* **GET** `/walmart/product/offers` - Get current inventory levels and details for each seller offer of a product
* **GET** `/walmart/product/fees` - Retrieve fee structure information for selling products
### **Historical Product Info**
* **GET** `/walmart/product/price-history` - Access historical pricing data for products
* **GET** `/walmart/product/units-sold-history` - Access estimated sales history for products
### **Oversight Tracking**
* **POST** `/walmart/oversight/products` - Add products to your oversight tracking system
* **GET** `/walmart/oversight/products` - List all currently tracked oversight products
* **GET** `/walmart/oversight/products/{id}` - Get detailed oversight data for a specific product
* **DELETE** `/walmart/oversight/products/{id}` - Remove products from oversight tracking
**Development Status**: Some endpoints are currently in development and will be available soon. Check individual endpoint documentation for current availability status.
## **Credit Costs & Oversight Tiers**
### **Oversight Tracking Costs**
Adding and removing products from oversight tracking costs **0 credits**. Credits are charged daily based on your chosen oversight tier when data is queried:
### **Detailed Tier Information**
#### **Tier 0 - Ultra High-Frequency Monitoring (150 credits/day)**
* **Data Collection**: Every hour in depth
* **Best For**: Mission-critical products, real-time competitive intelligence, high-stakes pricing decisions
* **Use Cases**: Live auction monitoring, aggressive competitor tracking, immediate price change alerts
* **Special Features**:
* **Units in stock for EACH seller every hour on query**
* **Price history for EACH seller every hour on query**
* **Credit Cost**: 150 credits per day
#### **Tier 1 - High-Frequency Monitoring (90 credits/day)**
* **Data Collection**: Every 2 hours
* **Best For**: High-value products, competitive pricing analysis, frequent inventory tracking
* **Use Cases**: Flash sales monitoring, competitive tracking, time-sensitive pricing decisions
* **Credit Cost**: 90 credits per day
#### **Tier 2 - Frequent Updates (35 credits/day)**
* **Data Collection**: Every 6 hours
* **Best For**: Active product management, daily pricing strategies, regular inventory checks
* **Use Cases**: Daily pricing adjustments, inventory planning, moderate competitive monitoring
* **Credit Cost**: 35 credits per day
#### **Tier 3 - Standard Monitoring (20 credits/day)**
* **Data Collection**: Every 12 hours
* **Best For**: Standard product tracking, weekly analysis, cost-effective monitoring
* **Use Cases**: Weekly pricing reviews, inventory trend analysis, general market monitoring
* **Credit Cost**: 20 credits per day
#### **Tier 4 - Daily Updates (10 credits/day)**
* **Data Collection**: Once per day
* **Best For**: Long-term trend analysis, budget-conscious monitoring, portfolio overview
* **Use Cases**: Monthly pricing strategies, historical trend analysis, broad market insights
* **Credit Cost**: 10 credits per day
## **Authentication**
All API endpoints require authentication using your API key. Include your key in the `x-api-key` header with every request:
```json theme={null}
"security": [
{
"apiKeyAuth": []
}
]
```
```bash Authentication Example theme={null}
curl -X GET "https://rivin.ai/api/walmart/product/details?upc=040094535309" \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY_HERE"
```
## **Base URL**
All API requests should be made to:
```
https://rivin.ai/api
```
## **Response Format**
All API responses are returned in JSON format with appropriate HTTP status codes:
* **200** - Success
* **400** - Bad Request (invalid parameters)
* **401** - Unauthorized (invalid or missing API key)
* **404** - Not Found
* **500** - Internal Server Error
## **Rate Limits**
Rate limits are applied per API key to ensure fair usage across all users. Contact our team for custom rate limit configurations for high-volume applications.
## **Getting Help**
Need assistance with the API? We're here to help!
* **Discord Community**: Join our [Discord server](https://discord.gg/ax9p3eNMup) for real-time support and discussions with other developers
* **Book a Call**: Schedule a 30-minute consultation with our team at [cal.com/rivin-ai/30min](https://cal.com/rivin-ai/30min)
* **Email Support**: Send us a message at [emiliano@rivin.ai](mailto:emiliano@rivin.ai)
* **Documentation**: This reference covers all available endpoints and parameters
* **API Status**: Check our status page for real-time API health information
# Bulk Analysis
Source: https://docs.rivin.ai/bulk-analysis/introduction
Upload files containing thousands of product identifiers and receive comprehensive analysis results for all products in one go
## The 3 Minute Demo
See our bulk analysis product in action with our detailed demo.
Our bulk analysis product enables you to upload files containing thousands of product identifiers and receive comprehensive analysis results for all products in one go. This is a great way to get a quick overview of your product catalogs and identify potential opportunities.
## Supported Product Codes
Types of product identifiers that can be analyzed:
| Code Type | Format | Example |
| ----------------------------- | --------- | ------------- |
| UPC (Universal Product Code) | 12 digits | 123456789012 |
| EAN (European Article Number) | 13 digits | 1234567890123 |
## File Format Guidelines
Rivin requires a specific file structure for parsing. Your file must follow these strict formatting requirements to be processed successfully.
### Supported File Types
* Excel files (.xlsx, .xls)
* CSV files (.csv)
**Important: Excel Sheets with Subsheets**
**Excel files with multiple sheets (subsheets) are not supported.** Our bulk analysis feature can only process single-sheet Excel files or CSV files.
Please ensure your Excel file contains only one sheet with your product data. You can:
* Copy your data to a new single-sheet Excel file
* Or export your data as a CSV file
* Remove any extra sheets before uploading
### Required Column Headers
**Your file must have clear, descriptive column names in the first row.** Our system uses strict column mapping based on exact header names. Column headers must match the following requirements:
#### Required Column:
* **"UPC"** or **"EAN"** - for product identifiers (**Required**)
**Common Format Issues**
Most parsing problems are caused by improper UPC/EAN format. Ensure your product codes are correctly formatted:
* **UPC codes** must be exactly 12 digits
* **EAN codes** must be exactly 13 digits
* **14-digit GTINs are not yet supported** - Support for 14-digit GTINs will be added soon
* Do not include leading zeros that create incorrect lengths (e.g., a 14-digit "EAN" like `01234567890123` is invalid - it should be `1234567890123`)
* Do not include spaces, dashes, or other formatting characters
**Examples of incorrect formats:**
* `01234567890123` (14 digits - EAN with leading zero, not supported)
* `12345678901234` (14-digit GTIN, not yet supported)
* `123-456-789-012` (UPC with dashes)
* `12345 67890 12` (UPC with spaces)
**Examples of correct formats:**
* `123456789012` (12-digit UPC)
* `1234567890123` (13-digit EAN)
#### Optional Columns:
* **"Price"** or **"Cost"** - for supplier prices (if providing pricing data)
* **"Length"**, **"Width"**, **"Height"** - for dimensions (if providing dimension data)
* **"Weight"** - for product weight (if providing weight data)
#### Column Header Requirements:
* Headers must be in the first row of your file
* Headers must match exactly (case-sensitive)
* Generic names like "Column A", "Data 1" are not accepted
* Abbreviations that aren't clear are not accepted
* Special characters or symbols are not accepted
* Very long column names are not accepted
### File Structure Requirements
| Requirement | Description | Status |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| File Format | File must be a single-sheet Excel file (.xlsx, .xls) or CSV file (.csv). Multi-sheet Excel files are not supported. | **Required** |
| Column Headers | First row must contain clear, descriptive column headers that match our accepted header names exactly (case-sensitive). | **Required** |
| Product Codes | Must include UPC or EAN product codes in a column with the exact header name "UPC" or "EAN". Our system uses strict column mapping based on exact header matches. | **Required** |
| Supplier Prices | If including supplier/cost prices, the column header must be exactly "Price" or "Cost" to enable profitability calculations. | **Optional** |
| Product Dimensions | If including dimensions, each measurement must be in its own column with these exact headers (case-sensitive): "length", "width", "height". The measurements must be in inches. | **Optional** |
| Product Weight | If including weight, the column header must be exactly "weight" to enable profitability calculations. The weight must be in pounds. | **Optional** |
### Example File Format
**Important: Dimensions & Weight Format**
If you want to use your own dimensions and weight data, each measurement must be in its own column with these exact header names:
* **"length"** - Product length in inches
* **"width"** - Product width in inches
* **"height"** - Product height in inches
* **"weight"** - Product weight in pounds
These will be used for accurate WFS fee calculations and prioritized over other data sources.
## What You'll Get
Comprehensive analysis results for each product in your file.
### Product Information
* Walmart product code and canonical URL
* Product title, brand, and category
* Current buybox price and seller
* Number of offers and selling status
* Monthly units sold estimates
* Product dimensions and weight (from multiple sources)
### Profitability Analysis
* Walmart referral fee percentage and amount
* WFS (Walmart Fulfillment Services) fees
* Net profit calculation
* ROI percentage
* Profit margin percentage
## Frequently Asked Questions
### What is the maximum number of products I can analyze at once?
The maximum number of products per file depends on your subscription plan:
* Base Plan: Up to 100,000 products per month
* Pro Plan: Up to 250,000 products per month
* Enterprise Plan: Custom limits available
For optimal performance, we recommend splitting very large files into smaller batches of 5,000-10,000 products each. But Rivin can reliably handle up to 50,000 products at once from a single file.
### How long does the analysis take?
Processing time varies based on the number of products and current system load. Typically, you can expect to process products at around two minutes plus two additional minutes per 5,000 products:
* Small batches (≤2,000): 2-3 minutes
* Medium batches (2,001-6,000): 5-7 minutes
* Large batches (6,001+): 2 minutes + 2 minute per 5,000 products
You'll receive an immediate response with an estimated completion time. Processing continues in the background while you can monitor progress.
### What happens if some product codes are invalid?
The system will continue processing valid codes and provide a report of any invalid codes encountered. You'll receive detailed error messages explaining why specific codes couldn't be processed.
### How accurate are the profitability calculations?
Profitability calculations use real-time data and official fee structures:
* **Current pricing:** Real-time buybox prices from Walmart
* **Official fees:** Walmart's current referral fee percentages
* **WFS fees:** Calculated based on actual dimensions and weight
* **Multiple sources:** Prioritized data from most reliable sources
Results are estimates based on current market conditions and may vary with actual sales.
### Can I save or export the analysis results?
Yes, analysis results are:
* stored in your account for future access
* available for download in CSV format
* available for download with filtering applied in CSV format
### What if I need to process more than the plan limits?
If you need to process more products than your current plan allows:
* **Upgrade your plan by [contacting us](https://cal.com/rivin-ai/30min):** Higher tiers support larger files
Monthly limits reset at the beginning of each billing cycle.
# Rivin.ai API Quickstart
Source: https://docs.rivin.ai/introduction
Build powerful e-commerce applications with [Rivin.ai](http://Rivin.ai)'s comprehensive Walmart product data API. Access both real-time and historical product information, pricing, reviews, and more to enhance your applications and provide better experiences for your users.
## **Getting Started**
### **Authentication**
All API requests require authentication using your API key. Include your key in the x-api-key header with every request:
```x-api-key Proper Authentication Example theme={null}
curl -X GET "https://api.rivin.ai/walmart/product/details?upc=040094535309" \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY_HERE"
```
## **Credit System**
[Rivin.ai](http://Rivin.ai) uses a credit-based pricing model to ensure fair usage and cost-effective access to our data:
* **Basic API requests** (product details lookup, basic data): **1 credit**
* **Complex queries** (price history, units sold history, profitability analysis): **up to 150 credits**
Credits are consumed based on the complexity and depth of data requested. Monitor your credit usage in your dashboard and purchase additional credits as needed.
## **Rate Limits**
Rate limits vary by endpoint and are designed to ensure optimal performance for all users:
* **Real-time data lookup**: Lower rate limits for real-time queries
* **Historical data analysis**: Higher rate limits due to pulling this data directly from our own databases
**Customizable Limits**: Rate limits are fully adjustable based on your specific use case and requirements. [Contact our team](https://cal.com/rivin-ai/30min) to discuss custom rate limit configurations for high-volume applications or enterprise needs. We are happy to increase rate limits in order to meet your needs.
## Questions or Requests?
If you have data requirements that are not currently supported via Rivin.ai's API, please reach out by [scheduling a call with our team.](https://cal.com/rivin-ai/30min) We're constantly looking to add depth to our data, and often create new endpoints on customer request.