System tools for Configured Commerce

  • Updated

System tools are built-in features that help Optimizely Opal take action. Each tool performs a specific task, such as creating a campaign, uploading files, or generating images. Think of tools like attachments on a Swiss Army knife. Each one has a distinct purpose that helps you get work done.

In addition to the system tools available in Opal, Optimizely Configured Commerce includes a set of system tools designed to help you interact with the Admin Console, such as analyzing your site's error logs or retrieving information about a product or customer order. 

You can ask Opal what tools it has at any time. For example, enter "Please list the tools you have with a brief description of what they do and the parameters" into Opal Chat.

Click a tool's name to expand it and learn when to use it, its required and optional parameters, and example prompts to calling the tool. If you do not provide a required parameter, Opal prompts you for it.

cfg_commerce_api_proxy – Lets you make proxy calls to Optimizely Commerce Admin API endpoints. This is useful when you need to interact with the Commerce Admin API using custom HTTP methods, parameters, and request bodies.
  • When to use
    • Retrieve specific data from endpoints like restrictiongroups, customers, or products.
    • Create, update, or delete resources within the Configured Commerce Admin.
    • Execute complex queries using OData filters.
  • Parameters
    • HttpMethod – The HTTP method to use for the request. Valid values are GET, POST, PUT, DELETE, or PATCH.
    • Endpoint – The specific API endpoint path you want to access, such as api/restrictiongroups, api/customers, or api/products.
    • (Optional) QueryString – A query string for OData operations (such as $filter=Name eq 'Test'&$top=10) or any standard URL query parameters.
    • (Optional) RequestBody – A JSON string representing the request body. This is typically used for POST, PUT, or PATCH requests.
    • (Optional) Headers – A JSON string of additional HTTP headers to include in the request, such as {"Content-Type": "application/json"}.
  • Example prompts
    • Get the first 10 customer records from the Commerce Admin API.
    • Create a product with the name 'New Product' and a price of 100 using a POST request to 'api/products'.
    • Update the customer with ID '123' by changing their email to 'new.email@example.com' using a PATCH request.
    • Delete the restriction group named 'TestGroup'.
    • Retrieve all products where the 'Category' is 'Electronics' and order them by 'Price' in descending order.
cfg_commerce_get_carts – Retrieves detailed information about active and abandoned carts.
  • When to use
    • Use this tool when you need to analyze cart abandonment, identify customers with pending orders, or get a list of carts based on their status or modification date.
  • Parameters
    • MaxResults (integer) – The maximum number of carts to retrieve. The default is 10, and the maximum is 100.
    • ModifiedAfter (string) – Includes only carts modified on or after this date. Use ISO 8601 format (such as 2024-11-01 or 2024-11-01T10:30:00Z). If neither ModifiedAfter nor ModifiedBefore is specified, it defaults to 30 days ago.
    • ModifiedBefore (string) – Includes only carts modified on or before this date. Use ISO 8601 format (such as 2024-11-01 or 2024-11-01T10:30:00Z). If not specified, it includes carts up to the current time.
    • StatusFilter (string) – Filters carts by status. The default is all.
      • all – For all cart types (active, alternate, and abandoned).
      • active – For active carts only (includes primary and alternate or saved carts).
      • abandoned – For abandoned carts only.
  • Example prompts
    • Show me all abandoned carts.
    • Get the 50 most recent active carts.
    • List all carts modified after 2024-01-01.
    • Find all carts that were modified between 2023-10-01 and 2023-10-31.
cfg_commerce_get_order – Gets orders by order numbers or OData filters.
  • When to use
    • Fetch details about one or more orders. You can specify orders by their unique order numbers or by applying various filters to narrow down the results.
  • Parameters
    • Filter – This parameter determines which orders are retrieved. You can provide the following:
      • A comma-separated list of specific order numbers (such as ORD001,ORD002).
      • An OData filter string to query orders based on criteria such as status or date (such as status eq 'Submitted' and orderDate gt 2024-01-01).
  • Example prompts
    • Get order details for order numbers ORD001 and ORD002.
    • Show me all orders with a 'Submitted' status.
    • Retrieve orders that were placed after January 1, 2024, and have a status of 'Completed'.
    • Find the order with order number 12345.
cfg_commerce_get_product – Retrieves detailed information about products.
  • When to use
    • Use this tool when you need to find products, look up product details, get product information, check product pricing, or display products.
  • Parameters
    • Filter – This parameter accepts either a comma-separated list of product numbers (like ABC123,DEF456) or an OData filter expression (like "Brand/Name eq 'Acme Corporation'").
  • Example prompts
    • Show me product ABC123.
    • Find products ABC123,DEF456,GHI789.
    • Get product information for product XYZ987.
    • Check the pricing for product PQR456.
    • Show me products from 'Acme Corporation'.

If you use Opti ID, administrators can turn off generative AI in the Opti ID Admin Center. See Turn generative AI off across Optimizely applications.