Recipe — Order lookup capability

A capability that lets an AI specialist answer “where’s my order?” by looking it up in your store’s API. This is the simplest, highest-value capability most teams build first.

What you’ll get

When a customer asks about an order, the AI:

1. Asks for the order number (if it doesn’t already have it from the conversation)
2. Calls your API with that number
3. Replies with the status, expected delivery date, and tracking link if available

If the order doesn’t exist, the AI explains that politely and suggests the customer double-check the number.

Configuration

Capability basics

• Name — Look up order
• Description — Retrieves the current status, expected delivery date, and tracking link for a customer order. Use whenever the customer asks about an order they’ve placed.
• Build mode — Simple Tool

Inputs

• orderNumber — string — The customer’s order number, e.g. ORD-12345 or 1001. Required.

API connection

• Base URL — https://api.your-store.example.com/v1
• Endpoint — GET /orders/{orderNumber}
• Auth type — API Key
• Auth mode — Full Access
• Header name — X-API-Key
• Credential — Your store’s API key (paste; Atender encrypts it)

Outputs

Map these JSON fields from your API response to capability outputs:

• status — $.status — One of pending, shipped, delivered, cancelled
• placedAt — $.placed_at — Order date
• estimatedDelivery — $.shipping.estimated_delivery — Expected delivery date
• trackingUrl — $.shipping.tracking_url — Carrier tracking link (may be empty for pending orders)

Security

• Security level — 1 (logged, no approval required)
• Identity verification — Email match — the customer must state the email on the account before the lookup runs
• Redaction rules — None needed for read-only lookup

Test it

Run Run Test with orderNumber: "ORD-1001" (or a real order number from your store). You should see the order’s current status returned. If the API returns 404 for a missing order, that’s correct — the AI will explain that to the customer.

Assign to a specialist

Once published, attach this capability to your Order & Shipping specialist (or whatever you’ve named the agent that handles delivery questions). See Add a capability to a specialist. Don’t attach it to specialists that handle other topics — keeping each agent’s capabilities scoped to its area is what makes the AI accurate.

Variations

• By customer + order: pass both customerId and orderNumber for tighter scoping. Useful if your API allows order numbers to repeat across customers.
• With cancellation: build a separate Cancel order capability at security level 3 (supervisor approval) so the specialist can offer to cancel after the lookup. Don’t combine lookup and cancel into one capability — read and write should be separate.

See also

• Create a capability
• Test and publish a capability
• Authentication options
• Specialist agents