Sync Shopify Metafield Definitions
POST/api/shopify/:integrationInstance/metafield-definitions/sync
Refreshes this store's product and variant metafield definitions from Shopify now. Definitions Shopify no longer returns are marked retired (their mappings are kept). Also records the shop's base currency, used for money metafields.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and permission to update integrations.
Errors:
- 422 when Shopify rejects the store's access token (reconnect Shopify)
- 502 when Shopify could not be reached or returned an error
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 502
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.
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.
Bad Gateway