{
  "openapi": "3.0.1",
  "info": {
    "title": "Walmart Product & Reviews Scraper",
    "description": "Scrape Walmart.com at scale: product search, category listings, full product details, every seller offer, and customer reviews. 5 operations, one clean JSON dataset. Built for price monitoring, competitor catalog mapping, marketplace seller intel and review analysis.",
    "version": "1.0",
    "x-build-id": "NYJJRuQksDDDfvlbl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~walmart-data-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-walmart-data-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sian.agency~walmart-data-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-walmart-data-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sian.agency~walmart-data-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-walmart-data-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "operation"
        ],
        "properties": {
          "operation": {
            "title": "🎯 Operation — what do you want to scrape?",
            "enum": [
              "search",
              "productsByCategory",
              "productDetails",
              "productOffers",
              "productReviews"
            ],
            "type": "string",
            "description": "🎯 **PICK ONE OPERATION PER RUN.** Each run produces one clean dataset matching the chosen mode.\n\n- **🔍 Product Search** — keyword search across Walmart products, paginated (~40 results/page)\n- **🗂️ Products by Category** — all products in a Walmart category ID, paginated (~40 results/page)\n- **📦 Product Details** — deep scrape of a single product (price, specs, variants, breadcrumbs, ratings)\n- **🏷️ Product Offers** — every seller offer for a product (price, seller, shipping, returns) — one row per offer\n- **⭐ Product Reviews** — paginated customer reviews for a product (text, rating, author, verified-purchase)\n\n💡 **TIP:** Use Product Search or Products by Category to discover product IDs, then drill into Details, Offers, and Reviews per product.",
            "default": "search"
          },
          "query": {
            "title": "🔍 Search Query (for Product Search)",
            "type": "string",
            "description": "🔍 **Required for `Product Search` operation.**\n\nAny Walmart product search query.\n- `coffee maker`\n- `nike running shoes`\n- `4k tv 55 inch`\n\n💡 **TIP:** Long-tail queries return higher-relevance results. Use the `sortBy` field to control ranking.\n\n⚠️ **Ignored** for all other operations."
          },
          "categoryId": {
            "title": "🗂️ Category ID (for Products by Category)",
            "type": "string",
            "description": "🗂️ **Required for `Products by Category` operation.**\n\nThe Walmart category ID.\n- `3944` — Electronics\n- `976759` — Cell Phones\n- `4044` — Home\n\n💡 **TIP:** Category IDs appear in the `categories[].url` of any Product Details result (e.g. `.../cp/electronics/3944` → `3944`), or in Walmart's site navigation URLs.\n\n⚠️ **Ignored** for all other operations."
          },
          "productId": {
            "title": "📦 Product ID (for Details / Offers / Reviews)",
            "type": "string",
            "description": "📦 **Required for `Product Details`, `Product Offers`, and `Product Reviews` operations.**\n\nThe Walmart product identifier. Either form works:\n- The numeric `us_item_id` (e.g. `609040889`)\n- The alphanumeric `product_id` (e.g. `4SZSM8SXAAJT`)\n\nBoth appear in any Product Search or Products by Category result row, and in product URLs: `https://www.walmart.com/ip/.../{us_item_id}`.\n\n💡 **TIP:** Run `Product Search` first to discover product IDs, then loop through Details / Offers / Reviews per product.\n\n⚠️ **Ignored** for Search and Category operations."
          },
          "domain": {
            "title": "🌍 Domain (Walmart marketplace)",
            "enum": [
              "us",
              "ca"
            ],
            "type": "string",
            "description": "🌍 Which Walmart marketplace to query. `us` = walmart.com (default), `ca` = walmart.ca.",
            "default": "us"
          },
          "sortBy": {
            "title": "↕️ Sort Order (Search / Category)",
            "enum": [
              "best_match",
              "price_low",
              "price_high",
              "best_seller",
              "top_rated"
            ],
            "type": "string",
            "description": "Sort order for `Product Search` and `Products by Category`.\n\n- `best_match` (default)\n- `price_low` — lowest price first\n- `price_high` — highest price first\n- `best_seller`\n- `top_rated`\n\nIgnored for Details, Offers, and Reviews.",
            "default": "best_match"
          },
          "reviewSort": {
            "title": "↕️ Review Sort Order",
            "enum": [
              "relevancy",
              "recent",
              "rating_high_low",
              "rating_low_high"
            ],
            "type": "string",
            "description": "Sort order for `Product Reviews`.\n\n- `relevancy` (default)\n- `recent` — newest first\n- `rating_high_low`\n- `rating_low_high`\n\nIgnored for all other operations.",
            "default": "relevancy"
          },
          "reviewRating": {
            "title": "⭐ Review Rating Filter",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Optional. For `Product Reviews` only — return only reviews with this star rating (1–5). Leave blank for all ratings."
          },
          "reviewLimit": {
            "title": "🔢 Reviews per page",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Optional. For `Product Reviews` only — number of reviews per page (1–50). Default is 10.",
            "default": 10
          },
          "minPrice": {
            "title": "💲 Min Price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional price filter for `Product Search` / `Products by Category`. Minimum product price. Must be lower than Max Price if both are set."
          },
          "maxPrice": {
            "title": "💲 Max Price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional price filter for `Product Search` / `Products by Category`. Maximum product price. Must be higher than Min Price if both are set."
          },
          "storeId": {
            "title": "🏬 Store ID",
            "type": "string",
            "description": "Optional. For `Product Search` / `Products by Category` — a Walmart store ID to filter results by a specific store's availability."
          },
          "state": {
            "title": "📍 State",
            "type": "string",
            "description": "Optional. US state code (e.g. `CA`, `NY`) to localize search/category results — availability and shipping options."
          },
          "zip": {
            "title": "📮 ZIP / Postal Code",
            "type": "string",
            "description": "Optional. ZIP/postal code to localize search/category results — availability and shipping options."
          },
          "maxPages": {
            "title": "📄 Max pages to fetch",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "📄 **Applies to paginated operations** (Search, Products by Category, Product Reviews). Ignored for single-record operations (Product Details, Product Offers).\n\n- **Search / Category:** ~40 products per page\n- **Product Reviews:** up to `reviewLimit` reviews per page (default 10)\n\n💡 **TIP:** Start small (1–3 pages) to preview results before scaling up. Pagination stops automatically when the data source reports the last page.\n\n⚠️ Hard cap: 50 pages to prevent runaway runs.",
            "default": 5
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}