shopify-admin-customer-note-bulk-annotator

Purpose

Queries customers matching a filter (tag, email list, or spend threshold) and appends a note to each customer record. Internal notes are visible to staff in Shopify Admin but not to customers. Used for post-campaign annotation, import source tracking, VIP flags, or support context.

Prerequisites

• Authenticated Shopify CLI session: shopify store auth --store <domain> --scopes read_customers,write_customers
• API scopes: read_customers, write_customers

Parameters

Parameter	Type	Required	Default	Description
store	string	yes	—	Store domain (e.g., mystore.myshopify.com)
filter	string	yes	—	Customer filter query (e.g., tag:vip, total_spent:>=500)
note	string	yes	—	Note text to append to matching customers
append	bool	no	true	Append to existing note (true) or replace entirely (false)
dry_run	bool	no	true	Preview matching customers without executing mutations
format	string	no	human	Output format: human or json

Safety

⚠️ If append: false, this overwrites the existing customer note entirely. Existing notes will be lost. Default is append: true which safely appends with a timestamp prefix. Run with dry_run: true to confirm the customer list before committing.

Workflow Steps

1. OPERATION: customers — query Inputs: query: <filter>, first: 250, select id, displayName, note, pagination cursor Expected output: Matching customers with existing notes; paginate until hasNextPage: false

2. Construct new note: if append: true, prepend [YYYY-MM-DD] <note> to existing note (newline-separated); if append: false, replace with <note>

3. OPERATION: customerUpdate — mutation Inputs: id: <customer_id>, note: <new_note> Expected output: customer { id, note }, userErrors

GraphQL Operations

# customers:query — validated against api_version 2025-01
query CustomersByFilter($query: String!, $after: String) {
  customers(first: 250, after: $after, query: $query) {
    edges {
      node {
        id
        displayName
        defaultEmailAddress {
          emailAddress
        }
        note
        tags
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}