Collections
ConceptUpdated 2026-06-20
A Collection is the central object in MultiCartAPI. It groups the items you want to scrape, holds their results, and controls how and when the job runs.
Terminology
- Collection
- A named job that holds a set of items (ASINs or SKUs) plus its schedule, priority and notification settings.
- Request
- A single item within a Collection — one ASIN (Amazon) or SKU (Officeworks), with its domain and postcode.
- Runner
- One execution of a Collection. Each run produces its own result set, so you can compare runs over time.
- Result Set
- The output files a runner produces — one JSON page per batch of items, plus an all-pages ZIP.
Lifecycle
A Collection moves through a simple lifecycle:
- Draft — created but not yet runnable.
- Enabled — automatically promoted once it has at least one item.
- Processing — a runner is actively scraping.
- Completed — results are ready to download.
Drafts promote automatically
You don't enable a Collection by hand — adding the first item flips it from draft to enable
for you.
What a Collection controls
| Field | Purpose |
|---|---|
name | A human label for the job. |
request_type | amazon or officeworks — the source. |
schedule | When it runs — Manual, Every X Minutes, Daily, Weekly or Monthly. |
priority | Where it sits in the queue (Highest → Lowest). |
fetch_mode | full (product + availability) or availability_only (faster). |
notification_email | Where to send the "results ready" email. |