shopy.shshopy.shDocs
    View as Markdown

    Commerce Frontmatter

    The commerce-specific metadata lives in the metadata map of the YAML frontmatter. This extends the standard skills.sh frontmatter with fields that AI shopping agents need.

    Core fields

    metadata:
      vendor_domain: sweetwater.com
      vendor_slug: sweetwater
      vendor_name: Sweetwater
      brand_type: retailer
      sector: arts-entertainment
      tier: premium
    
    FieldTypeDescription
    vendor_domainstringThe primary domain of the store
    vendor_slugstringURL-safe identifier used in the catalog
    vendor_namestringDisplay name of the vendor
    brand_typestringBrand classification: brand, retailer, independent, chain, marketplace, department_store, supermarket, or mega_merchant. Determines how sectors and categories are resolved — see taxonomy docs.
    sectorstringPrimary sector slug — one of 27 assignable values from the sector taxonomy (e.g., electronics, apparel-accessories, business-industrial), or multi-sector for department stores, supermarkets, and mega merchants.
    tierstringMarket position: commodity, budget, value, mid_range, premium, luxury, ultra_luxury

    Taxonomy fields

    metadata:
      product_categories:
        - "54 - Arts & Entertainment > Hobbies & Creative Arts > Musical Instruments"
        - "55 - Arts & Entertainment > Hobbies & Creative Arts > Musical Instrument & Orchestra Accessories"
      categories:
        - id: 54
          name: Musical Instruments
          path: "Arts & Entertainment > Hobbies & Creative Arts > Musical Instruments"
          depth: 3
          primary: true
        - id: 55
          name: Musical Instrument & Orchestra Accessories
          path: "Arts & Entertainment > Hobbies & Creative Arts > Musical Instrument & Orchestra Accessories"
          depth: 3
    
    FieldTypeDescription
    product_categoriesstring[]Category strings in Google Product Taxonomy format: "{id} - {full path}". One entry per category.
    categoriesobject[]Structured category mappings using Google Product Taxonomy IDs
    categories[].idintegerTaxonomy ID — Google Product Taxonomy number for Google categories, 100001+ for custom sectors
    categories[].namestringCategory display name
    categories[].pathstringFull path from root (e.g., "Electronics > Computers > Laptops")
    categories[].depthintegerDepth in taxonomy tree (1 = root, 2 = subcategory, 3 = sub-subcategory). Merchant-level uses depth 2-3.
    categories[].primarybooleanWhether this is the merchant's primary category

    Categories are assigned automatically during scanning using the Google Product Taxonomy. The product_categories string format shown above is used in SKILL.md frontmatter for human readability. The machine-readable skill.json companion file at /brands/{slug}/skill-json uses only the structured categories array (with id, name, path, depth, primary fields) — it does not include the string format.

    See the taxonomy documentation for details on how sectors and categories work.

    Scoring fields

    metadata:
      asx_score: 82
      asx_tier: good
      axs_rating: 4.2
      axs_rating_count: 47
    
    FieldTypeDescription
    asx_scorenumberASX Score (0–100) from the most recent scan
    asx_tierstringexcellent, good, fair, or needs_work
    axs_ratingnumberCrowdsourced AXS Rating (1–5)
    axs_rating_countnumberNumber of feedback submissions

    Capability fields

    metadata:
      api_access: keyed
      guest_checkout: true
      payment_methods:
        - credit_card
        - paypal
        - apple_pay
      shipping_options:
        - standard
        - express
        - same_day
      checkout_type: multi_step
    
    FieldTypeDescription
    api_accessstringopen, keyed, partnered, or private
    guest_checkoutbooleanWhether guest checkout is available
    payment_methodsstring[]Accepted payment methods
    shipping_optionsstring[]Available shipping tiers
    checkout_typestringsingle_page, multi_step, or api

    Distribution fields

    metadata:
      generated_by: creditclaw
      generated_at: 2026-04-03T00:00:00Z
      verified: true
      verified_at: 2026-04-03T00:00:00Z
    
    FieldTypeDescription
    generated_bystringWho generated the skill
    generated_atstringISO 8601 timestamp of generation
    verifiedbooleanWhether the skill has been verified against the live store
    verified_atstringISO 8601 timestamp of last verification