← Docs

Shopify Metafields Reference

All Compatify data is written to Shopify product metafields under the compatify namespace.

Namespace: compatify
Owner type: PRODUCT
Set via: metafieldsSet GraphQL mutation (requires write_product_listings scope)
compatify.compatible_devicesjson

Array of canonical device IDs that are compatible with this accessory product.

Example value
{
  "devices": ["apple_iphone_15_pro_max", "apple_iphone_15_pro"],
  "confidence": 0.97,
  "source": "Compatify API",
  "last_updated": "2026-05-05T00:00:00Z"
}
compatify.compatibility_badgesingle_line_text_field

Short badge text for display on product pages.

Example value
"Certified Compatible · Works with iPhone 13–15 series"
compatify.confidence_scorenumber_decimal

Confidence score (0.0–1.0) from the most recent Compatify check.

Example value
0.97
compatify.sourcesingle_line_text_field

Source of the compatibility data.

Example value
"Official Certification"
compatify.compatibility_notesmulti_line_text_field

Human-readable compatibility notes from Compatify.

Example value
"Certified compatible. Fast charge confirmed on iPhone 15 Pro Max up to 27W."
compatify.incompatible_devicesjson

Array of device IDs confirmed incompatible with this accessory.

Example value
["samsung_galaxy_s24_ultra", "google_pixel_8_pro"]
compatify.last_verified_atdate_time

ISO 8601 timestamp when compatibility was last verified by Compatify.

Example value
"2026-05-05T00:00:00Z"

GraphQL mutation example

mutation {
  metafieldsSet(metafields: [
    {
      ownerId: "gid://shopify/Product/123456789"
      namespace: "compatify"
      key: "compatible_devices"
      type: "json"
      value: "{\"devices\":[\"apple_iphone_15_pro_max\"],\"confidence\":0.97}"
    },
    {
      ownerId: "gid://shopify/Product/123456789"
      namespace: "compatify"
      key: "confidence_score"
      type: "number_decimal"
      value: "0.97"
    }
  ]) {
    metafields { key namespace value }
    userErrors { field message }
  }
}