{
  "openapi": "3.0.1",
  "info": {
    "title": "Walmart Scraper - Products, Prices & Reviews",
    "description": "Extract Walmart product prices, ratings, availability and categories in the US, Canada and Mexico, plus US sellers and reviews. Pay per delivered row, with a separate start fee.",
    "version": "0.1",
    "x-build-id": "DLj5p1Pda2zgZQQYC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lentic_clockss~walmart-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lentic_clockss-walmart-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/lentic_clockss~walmart-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lentic_clockss-walmart-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/lentic_clockss~walmart-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lentic_clockss-walmart-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",
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "auto",
              "search",
              "browse",
              "departments",
              "product",
              "catalog",
              "categoryHub",
              "sellers",
              "reviews",
              "home"
            ],
            "type": "string",
            "description": "Auto selects a mode from your target fields; choose a mode explicitly for catalogs, departments, category hubs or paginated reviews. Sellers and reviews modes support only the US market. `home` reads the App home layout: the merchandised shelves and their items, US only. It is a selection, not the full catalogue.",
            "default": "auto"
          },
          "keywords": {
            "title": "Keywords",
            "maxItems": 10,
            "type": "array",
            "description": "Up to 10 search terms, each with its own maxResults allowance. Use this instead of keyword for several searches.",
            "items": {
              "type": "string"
            }
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "One search term; use keywords instead for several terms. With no target, the Actor runs the small form example."
          },
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "Walmart product page links for product or reviews mode: walmart.com, walmart.ca or walmart.com.mx with /ip/.../<item id>. Apify {\"url\": \"<link>\"} request objects are accepted; remote lists such as requestsFromUrl and walmrt.us short links are not fetched — open them and paste the full product link. One entry may hold several links separated by whitespace or by a comma directly before the next http(s):// link. Each input shares its maxResults allowance across its product, offers and requested variant or review rows.",
            "items": {
              "type": "string"
            }
          },
          "usItemIds": {
            "title": "US Item IDs",
            "type": "array",
            "description": "Walmart numeric item IDs for product or reviews mode. Each ID has its own maxResults allowance.",
            "items": {
              "type": "string"
            }
          },
          "sellerUrls": {
            "title": "Seller storefront URLs",
            "type": "array",
            "description": "US Walmart storefront links, such as https://www.walmart.com/seller/101174524, for sellers mode. Each URL counts as one input.",
            "items": {
              "type": "string"
            }
          },
          "catalogSellerIds": {
            "title": "Catalog seller IDs",
            "type": "array",
            "description": "Numeric Walmart seller IDs, such as 101174524, for sellers mode. Each ID counts as one input.",
            "items": {
              "type": "string"
            }
          },
          "categoryId": {
            "title": "Category ID",
            "pattern": "^([0-9]+(_[0-9]+)*)?$",
            "type": "string",
            "description": "Category number for browse or catalog mode, such as 3944 for electronics. Also accepted by categoryHub mode."
          },
          "categorySlug": {
            "title": "Category URL name",
            "type": "string",
            "description": "Category name from a Walmart URL, such as electronics. Optional with a category ID, or usable alone to select categoryHub mode."
          },
          "maxResults": {
            "title": "Max results per input",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum rows per keyword, product URL/item ID or seller URL/ID; other modes count as one input, and product, offer, variant and review rows share its allowance. Default 70, larger values are collected in parts of 70, and total delivery also follows your cost limit and the Free-plan limits of 200 rows per run and 10 runs.",
            "default": 70
          },
          "market": {
            "title": "Market",
            "enum": [
              "US",
              "CA",
              "MX"
            ],
            "type": "string",
            "description": "Choose US (walmart.com), CA (walmart.ca) or MX (walmart.com.mx). Sellers and reviews modes require US.",
            "default": "US"
          },
          "postalCode": {
            "title": "Postal / ZIP code",
            "pattern": "^([A-Za-z0-9][A-Za-z0-9 -]{2,9})?$",
            "type": "string",
            "description": "Request local pricing with a Canadian postal code or US ZIP code; Mexico does not apply this setting. Check pricedForPostalCode and RUN_SUMMARY for the actual pricing location, because the requested code is not always applied. When it is not applied, rows still deliver and carry `locationStatus: walmartDefaultStore:<id>` plus the store Walmart priced for."
          },
          "storeId": {
            "title": "Store ID",
            "pattern": "^([0-9]+)?$",
            "type": "string",
            "description": "Optional Walmart store number, such as 5260, for location-dependent listings. Check the returned location before treating prices as store-specific."
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "best_match",
              "price_low",
              "price_high",
              "best_seller",
              "highest_rated",
              "new"
            ],
            "type": "string",
            "description": "Listing sort order: best match, price ascending or descending, best seller, highest rated, or new. Default best_match.",
            "default": "best_match"
          },
          "facet": {
            "title": "Facet",
            "type": "string",
            "description": "Optional listing filter expression copied from Walmart, such as brand:Apple."
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Optional minimum listing price, in the selected market currency."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Optional maximum listing price, in the selected market currency. Must be at least minPrice."
          },
          "excludeSponsored": {
            "title": "Exclude sponsored products",
            "type": "boolean",
            "description": "Exclude sponsored product rows from listings when Walmart marks them as sponsored.",
            "default": false
          },
          "reviewSort": {
            "title": "Review sort",
            "type": "string",
            "description": "Review order in reviews mode, such as relevancy or newest. Default relevancy.",
            "default": "relevancy"
          },
          "slpShard": {
            "title": "Seller sitemap shard",
            "minimum": 1,
            "maximum": 4,
            "type": "integer",
            "description": "Choose seller sitemap shard 1–4 for sellers mode. Use slpOffset to skip entries and maxResults to limit delivered rows."
          },
          "slpOffset": {
            "title": "Seller sitemap offset",
            "minimum": 0,
            "type": "integer",
            "description": "Number of seller entries to skip in the selected slpShard. Default 0.",
            "default": 0
          },
          "enrichDetails": {
            "title": "Add product details",
            "type": "boolean",
            "description": "Add product-page details to search or browse rows, including available US seller contacts. Off by default; enrichLimit controls how many products receive details.",
            "default": false
          },
          "enrichLimit": {
            "title": "Product detail limit",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum search or browse products to enrich when enrichDetails is true. Default 5, from 1 to 50.",
            "default": 5
          },
          "facetCrawl": {
            "title": "Crawl facets",
            "type": "boolean",
            "description": "Include category filter slices in catalog mode. Off by default; this does not guarantee complete category coverage.",
            "default": false
          },
          "facetCrawlMaxFacets": {
            "title": "Maximum facets to crawl",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum category filter slices to try when facetCrawl is true. Default 15, from 1 to 100.",
            "default": 15
          },
          "expandVariants": {
            "title": "Expand variants",
            "type": "boolean",
            "description": "Return available product variants as separately billed rows within the input row limit. Off by default.",
            "default": false
          },
          "maxReviews": {
            "title": "Maximum reviews",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum review rows: product pages and enriched listings provide only their available review preview, disabled at 0. In reviews mode, 0 uses the remaining maxResults allowance; a positive value adds a review cap.",
            "default": 0
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}