Map Products to Existing SKUs
POST/api/shopify/:integrationInstance/map-to-existing-skus
Queues a background operation that links Shopify products to existing SKU.io products using the configured field mappings. No new products are created - only matches to products that already exist. The endpoint returns immediately with status "queued".
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Body - exactly one selection strategy is required:
- ids (array of integers, max 1000): specific Shopify product IDs (SKU.io row IDs).
- process_all (boolean): process every eligible product on the instance.
- filters (object): server-side selection, e.g. {"unmapped_only": true, "created_after": "2024-01-01"}.
Returns 400 if no strategy is given, if more than 1000 ids are sent, or if no field mappings are configured yet.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Bad Request
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.