Get Product Mapping Breakdown
GET/api/shopify/:integrationInstance/products/mapping-breakdown
Mapped, unmapped and total product counts across the WHOLE filtered set — not just the current page.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Use this before running a bulk mapping operation so the confirmation reflects the real number of products the operation will touch. Paginated list responses only describe the page you loaded, which understates the scope of a bulk run on a large catalog.
Accepts the same filter[...] parameters as the product list endpoint, so the counts describe exactly the set the same filters would return. Archived listings are excluded unless a status or archived filter is supplied.
Filters:
- filter[search]: partial match on product title, SKU or barcode
- filter[mapping_status]: mapped | unmapped
- filter[status]: Shopify listing status (active, draft, archived, all)
- filter[sku_status]: has_sku | empty_sku
- filter[vendor]: exact vendor name
- filter[product_type]: exact Shopify product type
- filter[archived]: 0 | 1
Response fields:
- mapped: products already linked to a SKU product
- unmapped: products with no SKU product link
- total: mapped + unmapped
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.