Developer Docs

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:g="http://base.google.com/ns/1.0">
  <channel>
    <title>My Store</title>
    <item>
      <g:id>SKU-001</g:id>
      <g:title>Nike Air Max 90</g:title>
      <g:description>Classic everyday sneaker.</g:description>
      <g:price>129.99 USD</g:price>
      <g:image_link>https://mystore.com/img/nike.jpg</g:image_link>
      <g:link>https://mystore.com/products/nike-air-max-90</g:link>
      <g:product_type>Sneakers</g:product_type>
      <g:availability>in stock</g:availability>
    </item>
  </channel>
</rss>

{
  "products": [
    {
      "id": "123",
      "name": "Nike Air Max 90",
      "description": "Classic everyday sneaker, available in 5 colors.",
      "price": 129.99,
      "image": "https://mystore.com/img/nike.jpg",
      "url": "https://mystore.com/products/nike-air-max-90",
      "category": "Sneakers",
      "in_stock": true,
      "variant_id": "123-42"
    }
  ]
}

window.ChatAxonConfig.cart = {
  // Required to activate the cart adapter at all.
  addToCartUrl: 'https://yourstore.com/api/cart/add',

  // Extra headers merged into every request — this is where you pass your
  // platform's own session id / CSRF token. Read them fresh at page-load
  // time (e.g. from a cookie) since the config is built once per page load.
  headers: { 'X-Session-ID': '...' },
};

POST https://yourstore.com/api/cart/add
Content-Type: application/json
<...your configured headers>

{ "product_id": "123", "quantity": 1 }

// Read whatever your framework already uses for session/CSRF at page-load
// time, then wire it into the widget config before the script tag loads.
window.ChatAxonConfig = {
  apiKey: 'chataxon_YOUR_API_KEY',
  apiUrl: 'https://api.chataxon.com',
  cart: {
    addToCartUrl: '/api/cart/add',
    headers: { 'X-Session-ID': getMySessionId() },
  },
};

window.ChatAxonConfig.cart = {
  addToCartUrl:   '/api/cart/add',       // required for the cart adapter to activate
  applyCouponUrl: '/api/cart/coupon',    // optional — omit to use copy-to-clipboard instead
  headers: { 'X-Session-ID': getMySessionId() },
};

GET https://your-store.com/wp-json/wc/v3/orders/ORD-12345
Authorization: Basic base64(consumer_key:consumer_secret)

{
  "id": 12345,
  "status": "shipped",
  "billing": { "email": "customer@email.com" },

  // Everything below is optional. A plain WooCommerce order never has
  // these fields — the AI only mentions tracking info when present.
  "tracking_number": "1Z999AA10123456784",
  "carrier": "ups",
  "status_description": "In Transit",
  "shipped_at": "2026-06-08T14:30:00Z",
  "estimated_delivery": "2026-06-15T18:00:00Z"
}

// /api/shopify-cart-add.js — deployed on your own domain, proxied to Shopify
export default async function handler(req, res) {
  const { product_id, quantity } = req.body; // product_id = Shopify variant ID
                                              // (set this as the feed's product id for Shopify stores)
  const shopifyRes = await fetch(`https://${process.env.SHOPIFY_SHOP_DOMAIN}/cart/add.js`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json', 'Cookie': req.headers.cookie ?? '' },
    body: JSON.stringify({ id: Number(product_id), quantity }),
  });
  res.status(shopifyRes.ok ? 200 : 422).json({});
}

window.ChatAxonConfig.cart = {
  addToCartUrl: 'https://yourdomain.com/api/shopify-cart-add',
};

// GET /wp-json/wc/v3/orders/:orderId  (route this path on your own domain/proxy)
export default async function handler(req, res) {
  // 1. Basic Auth check (same consumer key/secret as Connect Store)
  const auth = Buffer.from((req.headers.authorization || '').split(' ')[1] || '', 'base64').toString();
  if (auth !== `${process.env.CHATAXON_CONSUMER_KEY}:${process.env.CHATAXON_CONSUMER_SECRET}`) {
    return res.status(401).end();
  }

  // 2. Query Shopify Admin API — order name e.g. "#1234"
  const sfRes = await fetch(
    `https://${process.env.SHOPIFY_SHOP_DOMAIN}/admin/api/2024-01/orders.json?name=%23${req.query.orderId}`,
    { headers: { 'X-Shopify-Access-Token': process.env.SHOPIFY_ADMIN_TOKEN } }
  );
  const { orders } = await sfRes.json();
  const order = orders?.[0];
  if (!order) return res.status(404).end();

  const fulfillment = order.fulfillments?.[0];

  res.json({
    id: order.order_number,
    status: order.fulfillment_status ?? order.financial_status ?? 'pending',
    billing: { email: order.email },
    tracking_number: fulfillment?.tracking_number,
    carrier: fulfillment?.tracking_company,
  });
}

POST https://api.chataxon.com/api/store/feed/webhook

Headers:
  x-api-key: chataxon_YOUR_API_KEY
  Content-Type: application/json
  X-ChatAxon-Signature: <your_webhook_secret>   # optional but strongly recommended

Body (all fields optional):
{
  "event": "product.updated"  // product.created | product.deleted | catalog.updated
}

# Run once. Store the returned webhook_secret in your server's environment variables.
curl -s https://api.chataxon.com/api/store/feed/webhook-secret \
  -H "x-api-key: chataxon_YOUR_API_KEY"

# Response:
# { "webhook_secret": "a3f1c8...64 hex chars..." }

POST https://api.chataxon.com/api/store/track
x-api-key: chataxon_YOUR_API_KEY
x-session-id: <current chat session UUID>
Content-Type: application/json

{
  "event_type": "csat",
  "metadata": {
    "rating": "positive"   // "positive" | "negative"
  }
}

// Call this after showing the thumbs-up / thumbs-down prompt
async function sendCSAT(rating) {
  await fetch('https://api.chataxon.com/api/store/track', {
    method: 'POST',
    headers: {
      'Content-Type':  'application/json',
      'x-api-key':     window.ChatAxonConfig.apiKey,
      'x-session-id':  window.ChatAxon.getSessionId(), // exposed by the widget
    },
    body: JSON.stringify({
      event_type: 'csat',
      metadata:   { rating }, // 'positive' | 'negative'
    }),
  });
}

// Wire up your buttons
document.getElementById('thumbs-up').addEventListener('click',   () => sendCSAT('positive'));
document.getElementById('thumbs-down').addEventListener('click', () => sendCSAT('negative'));

<!-- ChatAxon Widget -->
<div id="chataxon-root"></div>
<script>
  window.ChatAxonConfig = {
    apiKey: 'chataxon_YOUR_API_KEY',
    apiUrl: 'https://api.chataxon.com',
  };
</script>
<script src="https://api.chataxon.com/widget.js" defer></script>

<script>
  window.ChatAxonConfig = {
    // Required
    apiKey:  'chataxon_YOUR_API_KEY',
    apiUrl:  'https://api.chataxon.com',

    // Appearance
    themeColor:     '#1E364B',      // hex color for buttons and accents
    widgetPosition: 'bottom-right', // 'bottom-right' | 'bottom-left'
    offsetBottom:   24,             // pixels from bottom edge
    offsetSide:     24,             // pixels from side edge

    // Mobile overrides (null = inherit from desktop)
    mobileWidgetPosition: null,
    mobileOffsetBottom:   null,
    mobileOffsetSide:     null,

    // Capabilities — REQUIRED to enable these features. Omit this object and
    // the widget defaults both to false: order tracking and human handoff
    // disappear with no error anywhere.
    features: {
      canWimo:    true,             // "where is my order" — needs Order Tracking API
      canHandoff: true,             // hand the conversation to a person
    },

    // Behaviour
    defaultOpen:    false,          // open chat on page load
    bubbleText:     'Need help?',   // speech bubble above widget
    welcomeMessage: 'Hi! How can I help you today?',
    // Objects, not strings: label is the chip text, message is what gets sent.
    // Entries missing either field as a string are dropped; max 8 chips.
    quickReplies: [
      { label: 'Delivery & returns', message: 'What are your delivery and return terms?' },
      { label: 'Help me choose',     message: 'Help me choose a product' },
    ],

    // Visibility — 'everyone' (default) or 'admins' while you evaluate.
    // See "Testing on a live site" below.
    visibility: 'everyone',

    // Internationalisation
    currency: '€',                  // symbol passed to price display

    // Cart adapter (optional) — see Cart Integration. Omit entirely on
    // WordPress; the widget falls back to WooCommerce's own ajax cart.
    cart: {
      addToCartUrl:   '/api/cart/add',
      applyCouponUrl: '/api/cart/coupon', // optional
      headers: { 'X-Session-ID': '...' },
    },
  };
</script>

https://yourstore.com/?chataxon-preview=1   # visible to you
https://yourstore.com/                     # invisible to shoppers
https://yourstore.com/?chataxon-preview=0   # invisible to you too

const res = await fetch('https://api.chataxon.com/api/store/settings', {
  headers: {
    'x-api-key':   'chataxon_YOUR_API_KEY',
    'x-store-url': window.location.origin,
  },
});
const settings = await res.json();

if (settings.widget_enabled === false) return;  // master switch is off

window.ChatAxonConfig = {
  apiKey: 'chataxon_YOUR_API_KEY',
  apiUrl: 'https://api.chataxon.com',
  features: { canWimo: true, canHandoff: true },
  currency: '€',

  themeColor:     settings.theme_color,
  bubbleText:     settings.bubble_text,
  welcomeMessage: settings.welcome_message,
  widgetPosition: settings.widget_position,
  offsetBottom:   settings.widget_offset_bottom,
  offsetSide:     settings.widget_offset_side,
  defaultOpen:    settings.default_open,
  quickReplies:   settings.quick_replies,
};