Shopping Agent with UCP

Shopping Agent with UCP implements the Google Universal Commerce Protocol (UCP), providing a standardized REST API that enables AI agents and automated systems to interact with your online store.

This plugin requires WooCommerce to be installed and activated.

Key Features

• Store Discovery – Standard /.well-known/ucp endpoint for AI agents to discover your store’s capabilities
• Product Catalog – Browse, search, and filter products with full support for variations
• Category Navigation – Full category hierarchy with nested subcategories
• Persistent Cart – Create and manage shopping carts with automatic stock validation
• Checkout Sessions – Complete checkout flow with address management and coupon support
• Order Management – Retrieve order details, status, and event timeline
• Customer Profiles – Create and manage customer accounts
• Shipping Rates – Real-time shipping rate calculation
• Product Reviews – Access and create product reviews
• Coupon Validation – Discover and validate promotional codes
• Webhooks – Real-time order event notifications with HMAC-SHA256 signatures, retry logic, and automatic failed webhook recovery
• Secure Authentication – API key authentication with granular permission levels

Why Use Shopping Agent with UCP?

The Universal Commerce Protocol (UCP) is designed to enable AI assistants and automated agents to help users discover products, compare options, and complete purchases. By implementing UCP, your store becomes accessible to the next generation of AI-powered shopping experiences.

API Endpoints

The plugin provides the following API endpoints:

• /wp-json/ucp/v1/discovery – Store discovery and capabilities
• /wp-json/ucp/v1/products – Product listing, search, and details
• /wp-json/ucp/v1/categories – Category navigation
• /wp-json/ucp/v1/carts – Cart management
• /wp-json/ucp/v1/checkout/sessions – Checkout flow
• /wp-json/ucp/v1/orders – Order information
• /wp-json/ucp/v1/customers – Customer management
• /wp-json/ucp/v1/shipping/rates – Shipping calculation
• /wp-json/ucp/v1/reviews – Product reviews
• /wp-json/ucp/v1/coupons – Coupon validation

Authentication

API keys can be created with three permission levels:

• Read – Browse products, categories, reviews
• Write – Create carts, checkout sessions, orders
• Admin – Full access including API key management

Requirements

• WordPress 5.8 or higher
• WooCommerce 5.0 or higher
• PHP 7.4 or higher

External Services

1. UCP Schema Registry

   • Service URL: https://ucp.dev
   • Purpose: Referenced as a protocol namespace identifier in JSON schemas and API responses.
   • Data Sent: None. This is a passive reference; the plugin does not connect to or send data to this service.
   • Privacy Policy: N/A (Static documentation site)
   • Terms of Service: N/A

2. Documentation Examples

   • Service URLs: https://agent.example, https://your-store.com
   • Purpose: Used as placeholder URLs in documentation examples and code comments to demonstrate link relations.
   • Data Sent: None.
   • Privacy Policy: N/A
   • Terms of Service: N/A

3. User-Configured Webhooks

   • Service URL: Varies (User configured)
   • Purpose: Sending real-time order event notifications.
   • Data Sent: Order details, customer information, and checkout status as JSON payloads.
   • Timing: Triggered immediately when specific events occur (e.g., order creation) or via WP-Cron for retries.
   • Privacy Policy: Please refer to the privacy policy of the specific service you configure as a webhook receiver.

Documentation

For full documentation, please visit our GitHub repository.

Privacy Policy

Shopping Agent with UCP stores the following data:

• API Keys – Stored in a custom database table with hashed secrets
• Cart Sessions – Temporary cart data stored until expiration or checkout
• Checkout Sessions – Temporary checkout data stored until completion or expiration
• Webhook Configurations – Webhook URLs and secrets for event notifications

No data is sent to external servers except:
* Webhook payloads are sent to URLs you configure for order event notifications

All data is stored locally in your WordPress database and can be deleted by deactivating and removing the plugin.

Third Party Services

This plugin does not connect to any third-party services by default. If you configure webhooks, the plugin will send HTTP POST requests to the URLs you specify when order events occur.

This plugin requires WooCommerce (https://woocommerce.com) to function, but does not send any data to WooCommerce servers.