{
  "openapi": "3.0.1",
  "info": {
    "title": "Gopuff Scraper - US Quick-Commerce Prices & Assortment",
    "description": "Scrape Gopuff, the US quick-commerce delivery store, by location or product: prices, promotions, stock and availability per fulfillment location across thousands of everyday products. Availability monitoring (NEW, UPDATED, REAPPEARED, EXPIRED), detail enrichment, incremental runs, MCP export.",
    "version": "0.1",
    "x-build-id": "LB1jr6Agf7mFqezJy"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abotapi~gopuff-prices-assortment-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abotapi-gopuff-prices-assortment-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/abotapi~gopuff-prices-assortment-scraper/runs": {
      "post": {
        "operationId": "runs-sync-abotapi-gopuff-prices-assortment-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/abotapi~gopuff-prices-assortment-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-abotapi-gopuff-prices-assortment-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": [
              "categories",
              "products"
            ],
            "type": "string",
            "description": "Catalog walks a storefront location's collections page by page with prices, promotions and stock. Product mode reads one or more product links or numeric ids.",
            "default": "categories"
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Catalog mode: where to read the catalog - one entry per location. A US ZIP code (78701), a city or place name (Austin), or exact coordinates as lat,lng (30.2672,-97.7431). Names and ZIP codes are resolved automatically and cached.",
            "items": {
              "type": "string"
            }
          },
          "locationId": {
            "title": "Storefront location id (advanced)",
            "type": "string",
            "description": "Catalog mode: pin an exact Gopuff fulfillment location id and skip location resolution. Location ids appear in catalog records. Leave empty to resolve from the locations above."
          },
          "categoryInputs": {
            "title": "Collections (optional)",
            "type": "array",
            "description": "Catalog mode: walk only these collections, given as links (gopuff.com/c/candy/txERmYDy) or bare collection ids (txERmYDy). Deal pages work too (gopuff.com/deals/...). Leave empty to walk the whole navigation.",
            "items": {
              "type": "string"
            }
          },
          "discoverCategories": {
            "title": "Walk the whole navigation",
            "type": "boolean",
            "description": "Catalog mode: when no collections are set above, read the storefront navigation and walk every collection it lists.",
            "default": true
          },
          "inStockOnly": {
            "title": "Only items in stock",
            "type": "boolean",
            "description": "Catalog mode: hide items the selected location currently cannot deliver.",
            "default": false
          },
          "productInputs": {
            "title": "Product links or ids",
            "type": "array",
            "description": "Product mode: numeric product ids (198176) or any product link (gopuff.com/p/banana-1ct/p198176). Multi-value supported.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many records (0 = unlimited). With several locations each gets an equal share.",
            "default": 20
          },
          "maxPages": {
            "title": "Max pages per collection",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Catalog mode: how many pages to walk inside each collection, 1 to 100. 0 (the default) walks every page the collection has, up to the ceiling of 100. A collection ends early when its pages run out.",
            "default": 0
          },
          "pageSize": {
            "title": "Page size",
            "minimum": 10,
            "maximum": 50,
            "type": "integer",
            "description": "Catalog mode: how many products to request per page, 10 to 50.",
            "default": 50
          },
          "fetchDetails": {
            "title": "Enrich from product documents",
            "type": "boolean",
            "description": "Catalog mode: also read each product's own document for description, brand, SKU and image (billed as the detail-enrichment event, one unit per enriched record). Note: detail documents are priced by the storefront's default location, not by the walked location.",
            "default": false
          },
          "incrementalMode": {
            "title": "Incremental runs (monitoring)",
            "type": "boolean",
            "description": "Remember the previous run of the same search and label every record NEW, UPDATED, UNCHANGED or REAPPEARED; records that disappeared from a complete scan are reported EXPIRED. First run reports everything as NEW.",
            "default": false
          },
          "emitUnchanged": {
            "title": "Emit unchanged records",
            "type": "boolean",
            "description": "Incremental mode: also return (and bill) records that did not change since the previous run. Off keeps runs small.",
            "default": false
          },
          "emitExpired": {
            "title": "Emit expired records",
            "type": "boolean",
            "description": "Incremental mode: also return (and bill) records gone from a COMPLETE scan (every location walked to its end, nothing capped, nothing resumed). Partial scans never mark records expired.",
            "default": false
          },
          "stateKey": {
            "title": "State key (optional)",
            "type": "string",
            "description": "Incremental mode: name a monitoring campaign so two runs share a baseline even if their input text differs. Leave empty to derive it from mode + locations + collections + filters."
          },
          "resumeFromRunId": {
            "title": "Resume from run or dataset id",
            "type": "string",
            "description": "Skip records already collected by an earlier run or dataset so an interrupted crawl can continue. Compatible with incremental mode."
          },
          "mcpConnectors": {
            "title": "MCP connectors",
            "type": "array",
            "description": "Send every pushed record to these Apify MCP connectors (for example a Notion database) after the run. Leave empty to skip the export.",
            "items": {
              "type": "string"
            }
          },
          "notionParentPageUrl": {
            "title": "Notion parent page URL",
            "type": "string",
            "description": "When a Notion connector is used above, create pages under this parent."
          },
          "maxNotifyListings": {
            "title": "Max records per connector export",
            "minimum": 1,
            "type": "integer",
            "description": "Upper bound on records sent to the connectors above.",
            "default": 50
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "The storefront read runs through the Apify proxy; the entry session and every page must share one residential exit in the US."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}