Tools

curl -X GET https://api-commerce.nucleoplatform.com/api/v1/ai-tools \
  -H "Authorization: Bearer $NUCLEO_ACCESS_TOKEN" \
  -H 'X-Nucleo-Company: 7' \
  -H 'X-Nucleo-Language: en' \
  -H 'X-Nucleo-AI-Tools-Version: 1' \
  -H 'X-Nucleo-Request-Id: 2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a' \
  -H 'X-Nucleo-Store: acme-eu' \
  -H 'If-None-Match: "5f1d3b0c9a4e2b7d8c6f1a0e3b2d4c5a6f7e8d9c"' \
  -H 'Accept: application/json'

const res = await fetch("https://api-commerce.nucleoplatform.com/api/v1/ai-tools", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.NUCLEO_ACCESS_TOKEN}`,
    "X-Nucleo-Company": "7",
    "X-Nucleo-Language": "en",
    "X-Nucleo-AI-Tools-Version": "1",
    "X-Nucleo-Request-Id": "2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a",
    "X-Nucleo-Store": "acme-eu",
    "If-None-Match": "\"5f1d3b0c9a4e2b7d8c6f1a0e3b2d4c5a6f7e8d9c\"",
    Accept: "application/json",
  },
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-commerce.nucleoplatform.com/api/v1/ai-tools', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('NUCLEO_ACCESS_TOKEN'),
        'X-Nucleo-Company' => '7',
        'X-Nucleo-Language' => 'en',
        'X-Nucleo-AI-Tools-Version' => '1',
        'X-Nucleo-Request-Id' => '2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a',
        'X-Nucleo-Store' => 'acme-eu',
        'If-None-Match' => '"5f1d3b0c9a4e2b7d8c6f1a0e3b2d4c5a6f7e8d9c"',
        'Accept' => 'application/json',
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

{
  "version": 1,
  "module": "commerce",
  "company": {
    "id": 7,
    "slug": "acme",
    "name": "Acme Apparel"
  },
  "language": "en",
  "instructions": "Nucleo Commerce: Customer care (internal tickets between Customer Service, Logistics and the other teams; customer requests from the helpdesk, for the Customer Service team only), POS (points of sale, on-hand stock, inbound deliveries, transfers and returns) and Orders (the OMS: orders, customers, returns, shipments, sellable stock, routing, anomalies, fulfillment KPIs). Ticket codes look like TK-0029. Start from search_tickets or list_customer_requests (search_orders for orders), then read the detail. Everything here is read-only: nothing changes data, and reading a ticket does not mark it as read.",
  "tools": [
    {
      "name": "get_order",
      "title": "Get order",
      "description": "Orders (Nucleo OMS). One order in full, as on its page: customer and shipping address, items (SKU, quantities ordered, cancelled, shipped; price paid, full price, compare-at price and share of order discounts, fixed at the first download), amounts in the order currency and in the store currency (original and current after edits, refunds and cancellations; received, outstanding, refunded; shipping with discount and tax), refunds made on the sales channel, where each item ships from, pauses, shipments with tracking, returns, open anomalies. The order can be given by number (#1001) or id. For \"why is it here / why is it stuck\" use explain_order instead.",
      "inputSchema": {
        "type": "object",
        "properties": {
          "order": {
            "type": "string",
            "description": "Order number (e.g. #1001) or id."
          }
        },
        "required": [
          "order"
        ]
      },
      "permission": "oms.read",
      "side_effects": "read",
      "annotations": {
        "readOnlyHint": true,
        "destructiveHint": false,
        "idempotentHint": true,
        "openWorldHint": false
      },
      "tags": [
        "oms",
        "orders"
      ]
    }
  ],
  "generated_at": "2026-10-04T09:15:00+02:00"
}

{
  "error": "company_required",
  "message": "Missing or invalid X-Nucleo-Company header."
}

{
  "message": "Azienda attiva mancante (header X-Nucleo-Company)."
}

{
  "message": "Unauthenticated."
}

{
  "error": "company_forbidden",
  "message": "Nucleo Commerce is not available to you in this company."
}

{
  "error": "ai_connector_disabled",
  "message": "The AI connector is switched off for this module in this company."
}

{
  "message": "Hub is not provisioned for this company."
}

{
  "error": "unsupported_version",
  "message": "Unsupported ai-tools contract version.",
  "supported": [
    1
  ]
}

{
  "error": "company_not_ready",
  "message": "Nucleo Intelligence is not set up yet for this company: open it once in the Nucleo app."
}

{
  "message": "Too Many Attempts."
}

curl -X POST https://api-commerce.nucleoplatform.com/api/v1/ai-tools/search_orders \
  -H "Authorization: Bearer $NUCLEO_ACCESS_TOKEN" \
  -H 'X-Nucleo-Company: 7' \
  -H 'X-Nucleo-Language: en' \
  -H 'X-Nucleo-AI-Tools-Version: 1' \
  -H 'X-Nucleo-Request-Id: 2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a' \
  -H 'X-Nucleo-Store: acme-eu' \
  -H 'X-Nucleo-Client: acme-agent/1.4' \
  -H 'Content-Type: application/json' \
  -d '{
  "arguments": {
    "query": "giulia.rossi@acme.example",
    "status": "shipped",
    "per_page": 5
  },
  "context": {
    "client": {
      "name": "acme-agent",
      "version": "1.4"
    }
  }
}'

const res = await fetch("https://api-commerce.nucleoplatform.com/api/v1/ai-tools/search_orders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.NUCLEO_ACCESS_TOKEN}`,
    "X-Nucleo-Company": "7",
    "X-Nucleo-Language": "en",
    "X-Nucleo-AI-Tools-Version": "1",
    "X-Nucleo-Request-Id": "2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a",
    "X-Nucleo-Store": "acme-eu",
    "X-Nucleo-Client": "acme-agent/1.4",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "arguments": {
      "query": "giulia.rossi@acme.example",
      "status": "shipped",
      "per_page": 5
    },
    "context": {
      "client": {
        "name": "acme-agent",
        "version": "1.4"
      }
    }
  }),
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-commerce.nucleoplatform.com/api/v1/ai-tools/search_orders', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('NUCLEO_ACCESS_TOKEN'),
        'X-Nucleo-Company' => '7',
        'X-Nucleo-Language' => 'en',
        'X-Nucleo-AI-Tools-Version' => '1',
        'X-Nucleo-Request-Id' => '2f9c1e4a-7b3d-4c5e-9f8a-1b2c3d4e5f6a',
        'X-Nucleo-Store' => 'acme-eu',
        'X-Nucleo-Client' => 'acme-agent/1.4',
    ],
    'json' => [
        'arguments' => [
            'query' => 'giulia.rossi@acme.example',
            'status' => 'shipped',
            'per_page' => 5,
        ],
        'context' => [
            'client' => [
                'name' => 'acme-agent',
                'version' => '1.4',
            ],
        ],
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

{
  "content": [
    {
      "type": "text",
      "text": "{\n    \"total\": 1,\n    \"orders\": [ { \"number\": \"#1042\", \"status\": \"shipped\" } ]\n}"
    }
  ],
  "structuredContent": {
    "total": 1,
    "orders": [
      {
        "number": "#1042",
        "status": "shipped",
        "customer": "Giulia Rossi",
        "total": "89.00 EUR",
        "url": "https://app.nucleoplatform.com/commerce/orders/1042"
      }
    ]
  },
  "isError": false
}

{
  "content": [
    {
      "type": "text",
      "text": "{\n    \"error\": \"not_found\",\n    \"message\": \"Order #1099 not found.\"\n}"
    }
  ],
  "structuredContent": {
    "error": "not_found",
    "message": "Order #1099 not found."
  },
  "isError": true
}

{
  "content": [
    {
      "type": "text",
      "text": "{ \"error\": \"confirmation_required_in_app\", \"applied\": false, ... }"
    }
  ],
  "structuredContent": {
    "error": "confirmation_required_in_app",
    "applied": false,
    "message": "Nothing was changed. This change needs an explicit confirmation that only happens inside Nucleo Catalog (deletions, whole-object replacements, bulk or storefront-facing changes, imports, publishing, or more than 3 writes / 5 products within 10 minutes). `will_do` is the preview: show it to the user and ask them to run it with Atomo in Nucleo Catalog, or split it into smaller changes.",
    "will_do": {
      "summary": "Set price 29.90 EUR on 40 products in price list Retail EU"
    }
  },
  "isError": true
}

{
  "error": "company_required",
  "message": "Missing or invalid X-Nucleo-Company header."
}

{
  "message": "Azienda attiva mancante (header X-Nucleo-Company)."
}

{
  "message": "Unauthenticated."
}

{
  "error": "permission_denied",
  "permission": "dashboard.private",
  "message": "This dashboard is private: only its owner and Intelligence admins can open it."
}

{
  "error": "company_forbidden",
  "message": "Nucleo Commerce is not available to you in this company."
}

{
  "error": "ai_connector_disabled",
  "message": "The AI connector is switched off for this module in this company."
}

{
  "error": "unknown_tool",
  "message": "Unknown tool: search_invoices"
}

{
  "error": "unsupported_version",
  "message": "Unsupported ai-tools contract version.",
  "supported": [
    1
  ]
}

{
  "error": "company_not_ready",
  "message": "Nucleo Intelligence is not set up yet for this company: open it once in the Nucleo app."
}

{
  "error": "invalid_arguments",
  "message": "The per page field must not be greater than 50.",
  "errors": {
    "per_page": [
      "The per page field must not be greater than 50."
    ]
  }
}

{
  "error": "invalid_arguments",
  "message": "Invalid arguments for this tool.",
  "details": [
    {
      "field": "product",
      "error": "required"
    }
  ]
}

{
  "error": "invalid_arguments",
  "message": "The arguments do not match the tool input schema: deal_id is required.",
  "details": [
    {
      "field": "deal_id",
      "error": "is required"
    }
  ]
}

{
  "message": "Too Many Attempts."
}