Map Product
POST/api/shopify/:integrationInstance/products/:product/map
Map a Shopify product variant to a SKU product (or subscription offering).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
If the product is already mapped, updates the existing mapping (remap). Dispatches a job to map any unresolved sales order lines matching this listing.
Authentication: Requires Bearer token.
Validation:
- product_id: required_without subscription_offering_id, integer, must exist in products
- subscription_offering_id: required_without product_id, integer, must exist in subscription_offerings
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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.