Shopify Admin Order Notes And Attributes Report

Purpose

Queries recent orders and extracts order-level notes and custom line item attributes (e.g., gift messages, personalization text, special instructions, engraving text). Produces a report for ops and fulfillment teams to act on special requests during pick/pack. Read-only — no mutations.

Prerequisites

• Authenticated Shopify CLI session: shopify store auth --store --scopes read_orders
• API scopes: read_orders

Parameters

| Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | store | string | yes | — | Store domain (e.g., mystore.myshopify.com) | | daysback | integer | no | 1 | Lookback window (default: last 24 hours for daily ops use) | | attributekeys | array | no | [] | Specific line item attribute keys to extract (e.g., ["gift_message", "engraving"]); empty = all | | onlywithnotes | bool | no | false | Only include orders that have a note or attributes | | format | string | no | human | Output format: human or json |

Safety

> ℹ️ Read-only skill — no mutations are executed. Safe to run at any time.

Workflow Steps

1. OPERATION: orders — query

Inputs: query: "created_at:>=''", first: 250, select note, customAttributes, lineItems { customAttributes }, pagination cursor Expected output: Orders with notes and custom attributes; paginate until hasNextPage: false

1. If only_with_notes: true: filter to orders with non-empty note or non-empty customAttributes

1. If attribute_keys specified: filter line item attributes to matching keys only

GraphQL Operations

# orders:query — validated against api_version 2025-01
query OrderNotesAndAttributes($query: String!, $after: String) {
  orders(first: 250, after: $after, query: $query) {
    edges {
      node {
        id
        name
        createdAt
        displayFulfillmentStatus
        note
        customAttributes {
          key
          value
        }
        lineItems(first: 20) {
          edges {
            node {
              id
              title
              quantity
              variant {
                sku
              }
              customAttributes {
                key
                value
              }
            }
          }
        }
        shippingAddress {
          firstName
          lastName
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Session Tracking

Claude MUST emit the following output at each stage. This is mandatory.

On start, emit:

╔══════════════════════════════════════════════╗
║  SKILL: Order Notes and Attributes Report    ║
║  Store:                        ║
║  Started:              ║
╚══════════════════════════════════════════════╝

After each step, emit:

[N/TOTAL]   
          → Params: 
          → Result: 

On completion, emit:

For format: human (default):

══════════════════════════════════════════════
ORDER NOTES & ATTRIBUTES REPORT  ( day(s))
  Orders queried:         
  Orders with notes:      
  Orders with attributes: 

  #    []
    Note: ""
    Line: ""  gift_message: "Happy Birthday!"
  Output: order_notes_.csv
══════════════════════════════════════════════

For format: json, emit:

{
  "skill": "order-notes-and-attributes-report",
  "store": "",
  "period_days": 1,
  "orders_queried": 0,
  "orders_with_notes": 0,
  "orders_with_attributes": 0,
  "output_file": "order_notes_.csv"
}

Output Format

CSV file order_notes_.csv with columns: order_name, order_id, created_at, fulfillment_status, customer_name, order_note, line_item_title, line_sku, attribute_key, attribute_value

Error Handling

| Error | Cause | Recovery | |-------|-------|----------| | THROTTLED | API rate limit exceeded | Wait 2 seconds, retry up to 3 times | | No orders with notes | Quiet period or no note collection | Exit with 0 results if only_with_notes: true |

Best Practices

• Run at the start of each fulfillment shift (e.g., days_back: 1) so pickers/packers have a printed list of special instructions before starting.
• Use attribute_keys: ["gift_message"] to focus on just gift orders during holiday season.
• Orders with both a note and line item attributes indicate high-touch fulfillment needs — flag these for senior staff review.
• Print or export the CSV and attach to the pick list for efficient special handling during fulfillment.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: 40RTY-ai
• Source: 40RTY-ai/shopify-admin-skills
• License: MIT
• Homepage: http://skills.40rty.ai

Install and usage instructions live in the source repository linked above.