Gap Canada APIgapcanada.ca ↗
Access Gap Canada's full product catalog via API. Retrieve categories, paginated product listings with pricing and inventory, and SKU-level size data in CAD.
What is the Gap Canada API?
The Gap Canada API gives developers structured access to gapcanada.ca's product catalog across 3 endpoints, covering all five departments: Women, Men, Girls, Boys, and Baby & Toddler. The get_products endpoint returns paginated listings with real-time pricing, color variants, review scores, and inventory signals, while get_product_detail exposes individual SKU-level size availability and effective versus regular prices in CAD.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/148f30c1-3f01-4023-b803-13822b3437d6/list_categories' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace gapcanada-ca-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: Gap Canada catalog — browse categories, list products, drill into detail."""
from parse_apis.gap_canada_product_catalog_api import GapCanada, ProductNotFound
client = GapCanada()
# List all categories, take the first one to explore.
category = client.categories.list(limit=5).first()
print(f"Category: {category.name} ({category.division}) — cid={category.cid}")
# Browse products in that category (capped to 3 items).
for product in category.products.list(limit=3):
print(f" {product.style_name} | {product.color_name} | ${product.effective_price} (was ${product.regular_price})")
# Drill into the first product's full detail via the summary → detail nav op.
summary = category.products.list(limit=1).first()
detail = summary.details()
print(f"\nDetail: {detail.name} — {len(detail.skus)} SKUs, sizes: {detail.sizes}")
for sku in detail.skus[:3]:
print(f" SKU {sku.sku_id}: size {sku.size}, status={sku.inventory_status}, ${sku.effective_price}")
# Fetch a product directly by pid.
try:
direct = client.products.get(pid=summary.cc_id)
print(f"\nDirect fetch: {direct.name}, currency={direct.currency}, variants={len(direct.customer_choice_ids)}")
except ProductNotFound as exc:
print(f"Product not found: {exc}")
print("\nExercised: categories.list / category.products.list / summary.details / products.get")
Returns all available product categories across Women, Men, Girls, Boys, and Baby & Toddler divisions. Each category includes a cid and department code required by get_products. The list is static and returns the full catalog in one response with no pagination.
No input parameters required.
{
"type": "object",
"fields": {
"categories": "array of category objects each containing division, name, cid, and department"
},
"sample": {
"data": {
"categories": [
{
"cid": "1127938",
"name": "Shop All Styles",
"division": "Women",
"department": "136"
},
{
"cid": "6998",
"name": "Jeans",
"division": "Men",
"department": "75"
}
]
},
"status": "success"
}
}About the Gap Canada API
Endpoints and Coverage
The API is organized around three endpoints. list_categories returns a static index of all browsable categories, each with a cid, department code, division, and human-readable name. These identifiers feed directly into get_products and form the entry point for any catalog traversal.
Product Listings
get_products accepts a required cid and department (both sourced from list_categories), and optional page (0-indexed) and page_size (up to 200) parameters. Each product object in the response includes style_id, style_name, cc_id, color_name, color_description, effective_price, regular_price, price_ty, badges, review scores, and image references. The pagination object in the response exposes current_page, total_pages, page_size, and total_products, making it straightforward to walk a full category.
SKU-Level Detail
get_product_detail accepts a pid corresponding to the cc_id field from get_products. It returns the full set of SKUs for that color variant, each with sku_id, size, inventory_status, effective_price, and regular_price. The response also includes a sizes array of available dimension strings, the currency field (always CAD), and a customer_choice_ids array listing all color variants belonging to the same parent style — useful for fetching alternate colorways without re-querying the category listing.
The Gap Canada API is a managed, monitored endpoint for gapcanada.ca — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when gapcanada.ca changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official gapcanada.ca API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Track price drops by comparing
effective_pricetoregular_priceacross categories over time - Build a size availability checker using
inventory_statusfrom SKU objects inget_product_detail - Aggregate Gap Canada's full catalog by iterating
list_categoriesand paginating throughget_products - Monitor which products carry promotional badges in the
get_productsresponse for deal-surfacing tools - Map all color variants of a style using
customer_choice_idsreturned inget_product_detail - Feed kids' and baby clothing data into a cross-retailer comparison tool using department-filtered requests
- Sync CAD pricing and inventory status into an affiliate or price-alert application
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Gap Canada have an official public developer API?+
How do I paginate through all products in a category?+
get_products returns a pagination object containing current_page, total_pages, and total_products. Start with page=0 and increment until you reach total_pages - 1. The page_size parameter accepts values up to 200, which reduces the number of requests needed for large categories.Does `get_product_detail` return data for all color variants of a style, or only one?+
get_product_detail returns SKU and size data for a single color variant identified by its pid (the cc_id from get_products). The customer_choice_ids array in the response lists the IDs of all other color variants for that parent style, so you can call get_product_detail for each to build a full picture of the style.Does the API cover product search or filtering by size, price, or other attributes?+
list_categories and get_products, and per-variant detail via get_product_detail. There is no search or attribute-filter endpoint. You can fork this API on Parse and revise it to add a search endpoint if that capability is needed.Are prices in the API always in Canadian dollars?+
currency field in get_product_detail is always CAD, and all effective_price and regular_price values across all endpoints reflect Canadian dollar pricing from gapcanada.ca. US pricing from gap.com is not covered. You can fork this API on Parse and revise it to point at gap.com if USD pricing is required.