VipCommerce Data Extractor

Extract real-time product and pricing data from 87+ Brazilian supermarkets.

The VipCommerce Data Extractor provides access to product information, prices, and inventory data from major Brazilian supermarket chains that use the VipCommerce e-commerce platform.

What You Can Do

• Price Monitoring - Track competitor prices in real-time
• Market Research - Analyze pricing trends and product availability
• Competitive Analysis - Compare product assortments across different chains
• Regional Analysis - Compare prices across different Brazilian regions
• Inventory Tracking - Monitor stock levels and product availability

Supported Stores

87 Brazilian supermarket chains currently configured and tested.

All stores use the VipCommerce e-commerce platform. If you're familiar with VipCommerce, you can verify store compatibility by checking their platform implementation.

Coverage:

• Nationwide coverage across Brazil
• Major national and regional supermarket chains
• Real-time pricing and inventory data

Need specific store information or custom configuration? Contact us through our Apify profile for detailed consultation.

Quick Start

The Actor operates in four modes that follow a natural workflow:

1. Distribution Centers → Find available store locations for a domain
2. Departments → Get departments for a specific distribution center
3. Categories → Retrieve product categories for a specific location
4. Assortment → Extract product data (prices, inventory, etc.) for a category

Each execution returns one page of data, giving you full control over pagination and data processing.

Operation Modes

Distribution Centers Mode

Returns available distribution centers for a store domain.

{
  "mode": "distribution_centers",
  "domain": "lojahirota.com.br",
  "branch_id": 1,
  "zip_code": "01310-100",
  "request_waiting": 5
}

Departments Mode

Returns departments for a specific distribution center.

{
  "mode": "departments",
  "domain": "lojahirota.com.br",
  "branch_id": 1,
  "distribution_center_id": 5,
  "request_waiting": 5
}

Categories Mode

Returns product categories available at a specific distribution center.

{
  "mode": "categories", 
  "domain": "lojahirota.com.br",
  "branch_id": 1,
  "distribution_center_id": 5,
  "request_waiting": 5
}

Assortment Mode

Returns products for a specific category (one page per execution).

{
  "mode": "assortment",
  "domain": "lojahirota.com.br",
  "branch_id": 1,
  "distribution_center_id": 5,
  "category_id": 61,
  "page": "1",
  "request_waiting": 5
}

Output Format

Distribution Centers

[
  {
    "name": "Centro São Paulo",
    "distribution_center_id": 5,
    "city": "São Paulo",
    "state": "SP",
    "branch_id": 1
  }
]

Departments

[
  {
    "id": 3,
    "name": "Bebidas",
    "slug": "/bebidas",
    "branch_id": 1,
    "distribution_center_id": 1,
    "categories": [
      {
        "id": 246,
        "name": "AGUARDENTES E CACHAÇAS",
        "slug": "/bebidas/aguardentes-e-cachacas"
      }
    ]
  }
]

Assortment

[{
  "records_per_page": 20,
  "items": 890,
  "pages": 45,
  "data": [
    {
      "name": "COCA COLA LATA 350ML",
      "ean": 7894900011517,
      "price_to": 3.99,
      "available": "S",
      "sku": "CC-350",
      "product_id": 12345,
      "brand": "Coca-Cola",
      "category_id": 61,
      "branch_id": 1,
      "distribution_center_id": 5,
      "price_from": 4.99,
      "price_offer": 0.0,
      "qty_min": 1,
      "qty_max": 10,
      "sold_amount": 150,
      "unit_label": "UN",
      "unit_fraction": 1,
      "qty_fraction": 1,
      "price_fraction": 3.99,
      "prioritized_product": "N",
      "main_volume": "350ml",
      "url": "https://lojahirota.com.br/produto/12345",
      "image": "https://cdn.lojahirota.com.br/coca-cola.jpg",
      "created_at": "2024-01-15",
      "hour": "10:30:00"
    }
  ]
}]

Python Implementation

Install the required packages:

$pip install apify-client

Basic Usage

from apify_client import ApifyClient

client = ApifyClient("your_apify_token")

# Get products from a specific store and category
run = client.actor("yasmany.casanova/vipcommerce-scraper").call(run_input={
    "mode": "assortment",
    "domain": "lojahirota.com.br",
    "branch_id": 1,
    "distribution_center_id": 5,
    "category_id": 61,
    "page": "1"
})

# Get the results
result = client.dataset(run["defaultDatasetId"]).list_items().items[0]
print(f"Found {len(result['data'])} products out of {result['items']} total")
print(f"Page 1 of {result['pages']} pages ({result['records_per_page']} per page)")

for product in result['data'][:5]:  # Show first 5 products
    print(f"{product['name']} - R$ {product['price_to']}")

Complete Workflow

from apify_client import ApifyClient

client = ApifyClient("your_apify_token")

# Step 1: Get distribution centers
dc_run = client.actor("yasmany.casanova/vipcommerce-scraper").call(run_input={
    "mode": "distribution_centers",
    "domain": "lojahirota.com.br",
    "branch_id": 1,
    "zip_code": "01310-100"
})

distribution_centers = client.dataset(dc_run["defaultDatasetId"]).list_items().items
print(f"Found {len(distribution_centers)} distribution centers")

# Step 2: Get departments for first DC
departments_run = client.actor("yasmany.casanova/vipcommerce-scraper").call(run_input={
    "mode": "departments",
    "domain": "lojahirota.com.br", 
    "branch_id": 1,
    "distribution_center_id": distribution_centers[0]["id"]
})

departments = client.dataset(departments_run["defaultDatasetId"]).list_items().items
print(f"Found {len(departments)} departments")

# Step 3: Get products for first category
first_category = departments[0]
products_run = client.actor("yasmany.casanova/vipcommerce-scraper").call(run_input={
    "mode": "assortment",
    "domain": "lojahirota.com.br",
    "branch_id": 1,
    "distribution_center_id": distribution_centers[0]["distribution_center_id"],
    "category_id": first_category["classificacao_mercadologica_id"],
    "page": "1"
})

result = client.dataset(products_run["defaultDatasetId"]).list_items().items[0]
products = result["data"]

print(f"Found {len(products)} products on page 1 of {result['pages']}")
print(f"Total products available: {result['items']}")

Parameters

Parameter	Type	Required	Description
mode	string	✅	Operation mode: distribution_centers, departments, categories, assortment
domain	string	✅	Store domain (e.g., "lojahirota.com.br")
branch_id	integer	✅	Branch ID (default: 1)
zip_code	string	🔸	ZIP code for distribution centers (default: "01310-100")
distribution_center_id	integer	🔸	Required for categories and assortment modes
category_id	integer	🔸	Required for assortment mode
page	string	🔸	Page number for assortment (default: "1")
request_waiting	integer	✅	Request delay in seconds (min: 3, default: 5)

Technical Details

• Platform: VipCommerce e-commerce platform
• Rate Limiting: Configurable delays (minimum 3 seconds)
• Error Handling: Returns empty structures on errors
• Data Format: Structured JSON output
• Authentication: No setup required - pre-configured credentials
• Privacy: No sensitive data collected - public data only
• Integration: Works with any programming language