> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yourhomie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Examples

> Sample configurations for common external APIs, which serve as a reference for setting up your own tool integrations.

Each example shows a complete, proven configuration—from the endpoint URL to the required header and authentication settings, all the way to the appropriate JSON path for processing the response.

<Tabs>
  <Tab title="DHL Shipment Tracking">
    <Steps>
      <Step title="Shipment tracking template">
        Select the preconfigured shipment tracking template.
      </Step>

      <Step title="Endpoint URL">
        Enter the following URL in the HTTP Request field:

        `https://www.dhl.de/int-verfolgen/data/search?piececode={tracking_id}&language=de`

        Select **GET** as the method.
      </Step>

      <Step title="Response">
        Define the JSON path as follows:

        `sendungen[0].sendungsdetails.sendungsverlauf.status`
      </Step>

      <Step title="Header">
        Set the header details:

        | Name              | Value                                                                                                             |
        | :---------------- | :---------------------------------------------------------------------------------------------------------------- |
        | `User-Agent`      | `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36` |
        | `Referer`         | `https://www.dhl.de/de/privatkunden/dhl-sendungsverfolgung.html?piececode={tracking_id}`                          |
        | `Accept`          | `application/json, text/plain, */*`                                                                               |
        | `Accept-Language` | `de-DE,de;q=0.9`                                                                                                  |
      </Step>
    </Steps>
  </Tab>

  <Tab title="Shopware Order Status">
    <Steps>
      <Step title="Create a Shopware integration">
        In the Shopware admin, go to **Settings › System › Integrations** and create a new integration. Note the **Access key ID** and **Secret access key**.
      </Step>

      <Step title="Set up an OAuth2 auth connection">
        Store the secret access key as a [secret](/en/user-guide/settings/secrets), then open [Settings › Auth connections](/en/user-guide/settings/auth-connections) and create a new connection of type **OAuth2 (Client Credentials)**:

        * **Token URL:** `https://{your-shop-domain}/api/oauth/token`
        * **Client ID:** the access key ID from step 1
        * **Client secret:** the secret from step 1

        Leave **Credential transmission** set to **Auto-detect (recommended)** and verify the connection with **Test connection**.
      </Step>

      <Step title="Create the tool and define parameters">
        Create a new HTTP tool, attach the auth connection from step 2 under **Authentication**, and add the parameters `order_number` and `plz` for the assistant to fill in from the conversation. homie fetches and renews the access token automatically — no extra headers needed.
      </Step>

      <Step title="Endpoint URL">
        Enter the following URL in the HTTP Request field:

        `https://{your-shop-domain}/api/order`

        Select **POST** as the method.
      </Step>

      <Step title="JSON body">
        Set the following JSON body:

        ```json theme={null}
        {
          "limit": 1,
          "filter": [
            {
              "type": "equals",
              "field": "orderNumber",
              "value": "{order_number}"
            },
            {
              "type": "equals",
              "field": "billingAddress.zipcode",
              "value": "{plz}"
            }
          ],
          "associations": {
            "billingAddress": {},
            "stateMachineState": {},
            "deliveries": {
              "associations": {
                "stateMachineState": {}
              }
            }
          }
        }
        ```

        Matching on the postal code (`plz`) ensures the assistant only reveals the status of the shopper's own order.
      </Step>

      <Step title="Response">
        Define the JSON path as follows:

        `data[0].stateMachineState`
      </Step>
    </Steps>
  </Tab>
</Tabs>