{
  "openapi": "3.0.1",
  "info": {
    "title": "Sobeys & Voila Scraper: Prices, Flyers & Scene+ Deals",
    "description": "Get Voila online prices and Sobeys, Safeway Canada, IGA, FreshCo, Foodland and Thrifty Foods flyer offers by Canadian postal code: prices, Scene+ text, dates, unit prices and stock when supplied. US$0.004 per product or flyer item plus US$0.005 per run. No login.",
    "version": "1.0",
    "x-build-id": "A54GrFU8kLv8JhZ34"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vant47~sobeys-voila-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vant47-sobeys-voila-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/vant47~sobeys-voila-scraper/runs": {
      "post": {
        "operationId": "runs-sync-vant47-sobeys-voila-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/vant47~sobeys-voila-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-vant47-sobeys-voila-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": {
          "banner": {
            "title": "Online store or flyer banner",
            "enum": [
              "voila",
              "sobeys",
              "safeway-ca",
              "iga",
              "freshco",
              "foodland",
              "thrifty-foods"
            ],
            "type": "string",
            "description": "Voila collects regional online prices. Other banners collect regional weekly flyer entries, with dates and printed conditions. Flyer prices are advertised amounts and can be bundle totals; physical-store shelf prices are not verified.",
            "default": "voila"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Voila: each term is searched in each delivery region. Flyers: filter product names by any supplied term; leave empty for all current named flyer entries.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Category, deals or product URLs",
            "type": "array",
            "description": "Public https://voila.ca product, category or promotions links. Region selection always comes from locations or storeIds, never from URL query parameters.",
            "items": {
              "type": "string"
            }
          },
          "productIds": {
            "title": "Product IDs",
            "type": "array",
            "description": "Optional Voila retailer product IDs, such as 267314EA or 507464EA. These are SKUs, not UPC barcodes.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Canadian postal codes",
            "type": "array",
            "description": "Full Canadian postal codes. Voila resolves a delivery-region catalogue. Banner flyers use the source-resolved postal area. These are online/flyer observations, not verified physical-store shelf prices.",
            "items": {
              "type": "string"
            }
          },
          "storeIds": {
            "title": "Exact delivery-region IDs",
            "type": "array",
            "description": "Voila online mode only: exact delivery-region UUIDs from previous output, taking precedence over locations. Flyer mode requires locations; physical store numbers are not supported.",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerSearch": {
            "title": "Maximum products per search and store",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Voila: new rows per source and delivery region. Flyers: new entries per postal-code selection across current flyers.",
            "default": 20
          },
          "maxItems": {
            "title": "Maximum products in this run",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Global product/region or flyer-item cap. $0.004 per observation plus a $0.005 start charge: 20 observations cost $0.085 at base pricing.",
            "default": 20
          },
          "dealsOnly": {
            "title": "Deals only",
            "type": "boolean",
            "description": "Keep products with a sale or a public promotion, including Scene+ points and conditional multi-buy offers. Points are not deducted from prices.",
            "default": false
          },
          "includeDetails": {
            "title": "Include product details",
            "type": "boolean",
            "description": "Voila only: add product-page description, label fields, ingredients and nutrition when supplied, with no extra product fee. Flyer entries always include their public description and printed conditions.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Automatic default: default datacenter proxy first, then Canadian residential after refusal. Explicit disable, groups, country or custom proxies are respected and never silently overridden.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}