Building a WooCommerce Admin App with WooGraphQL

WooGraphQL v1.0.0 introduces several admin-level queries and mutations that enable building custom WooCommerce management interfaces through GraphQL. This guide covers the WC Settings API, product and product attribute CRUD mutations, and refund operations.

All operations in this guide require manage_woocommerce or equivalent capabilities. Authenticate your requests using WPGraphQL JWT Authentication or WPGraphQL Headless Login with an admin or shop manager account.

Retrieve all available WooCommerce setting groups:

query {
  wcSettingGroups {
    id
    label
    description
    parentId
  }
}

Retrieve all settings within a specific group:

query {
  wcSettings(group: "general") {
    id
    label
    description
    type
    value
    default
    options {
      key
      value
    }
  }
}

Common groups include general, products, tax, shipping, checkout, account, and email.

mutation {
  updateWCSetting(input: {
    group: "general"
    id: "woocommerce_store_city"
    value: "New York"
  }) {
    setting {
      id
      label
      value
    }
  }
}

mutation {
  updateWCSettings(input: {
    group: "general"
    settings: [
      { id: "woocommerce_store_city", value: "New York" }
      { id: "woocommerce_store_postcode", value: "10001" }
      { id: "woocommerce_default_country", value: "US:NY" }
    ]
  }) {
    settings {
      id
      value
    }
  }
}

mutation {
  createProduct(input: {
    name: "Premium T-Shirt"
    type: SIMPLE
    regularPrice: "29.99"
    description: "A high-quality cotton t-shirt."
    shortDescription: "Premium cotton tee."
    sku: "TSHIRT-001"
    stockQuantity: 100
    manageStock: true
    categories: [{ id: 15 }]
  }) {
    product {
      databaseId
      name
      ... on SimpleProduct {
        price
        regularPrice
        sku
        stockQuantity
      }
    }
  }
}

mutation {
  updateProduct(input: {
    id: "cHJvZHVjdDoxMDA="
    salePrice: "24.99"
    stockQuantity: 85
  }) {
    product {
      databaseId
      ... on SimpleProduct {
        price
        salePrice
        stockQuantity
      }
    }
  }
}

mutation {
  deleteProduct(input: {
    id: "cHJvZHVjdDoxMDA="
    forceDelete: true
  }) {
    product {
      databaseId
      name
    }
  }
}

mutation {
  createProductAttribute(input: {
    name: "Material"
    slug: "material"
    hasArchives: true
    orderBy: "name"
  }) {
    attribute {
      id
      name
      slug
    }
  }
}

mutation {
  createProductAttributeTerm(input: {
    attributeId: 1
    name: "Cotton"
    slug: "cotton"
  }) {
    term {
      id
      name
      slug
    }
  }
}

Create a refund on a completed order:

mutation {
  createRefund(input: {
    orderId: 123
    amount: "15.00"
    reason: "Customer requested partial refund"
  }) {
    refund {
      databaseId
      amount
      reason
      date
      refundedBy {
        name
      }
    }
    order {
      databaseId
      total
      status
    }
  }
}

The createRefund mutation supports these optional fields:

• refundPayment — When true, triggers the payment gateway's refund API (e.g., Stripe refund).
• restockItems — When true, restocks the refunded items.
• metaData — Attach custom metadata to the refund.

mutation {
  deleteRefund(input: {
    id: "b3JkZXI6NDU="
  }) {
    refund {
      databaseId
      amount
    }
    order {
      databaseId
      total
    }
  }
}

Note: WooCommerce does not support updating refunds after creation. Refunds are immutable financial records and can only be created or deleted.

Refunds are available through the refunds connection on Order types:

query {
  order(id: "b3JkZXI6MTIz") {
    databaseId
    total
    refunds {
      nodes {
        databaseId
        amount
        reason
        date
        refundedBy {
          name
        }
      }
    }
  }
}

All admin operations require appropriate capabilities:

For client-side admin apps, authenticate with a shop manager or administrator account. For server-side applications, consider using WordPress Application Passwords with the WPGraphQL introspection endpoint.