Skip to main content

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.

Required scope: integrations:write

Grant 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​

OK

Response Headers
    Content-Type