> For the complete documentation index, see [llms.txt](https://docs.zigpoll.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zigpoll.com/embed/poll-metadata/special-variables.md).

# Special Variables

Some metadata has special meaning with the Zigpoll dashboard.

```
shopify_customer_id
```

If **shopify\_customer\_id** is passed it will connect the underlying Shopify customer information to the response.

```
shopify_order_id
```

If **shopify\_order\_id** is passed it will connect the underlying Shopify customer information to the response.

```
order_amount
```

If **order\_amount** is passed it will pass through a value to the response. This value will be used to add additional metrics like Revenue and Average Order Value to the Zigpoll dashboards.

### Automatic Shopify metadata

On Shopify surfaces (checkout, Thank You, Order Status, and customer account surveys), Zigpoll attaches these metadata keys automatically — you can use them in template variables, segments, and exports:

| Key                      | Value                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------ |
| `shopify_customer_email` | The customer's email                                                                 |
| `shopify_customer_phone` | The customer's phone number                                                          |
| `shopify_order_total`    | The order total                                                                      |
| `shopify_currency_code`  | The order's currency code                                                            |
| `shopify_line_items`     | The order's line item titles, comma-separated                                        |
| `shopify_market`         | The buyer's country code (formerly the Shopify Market handle, deprecated by Shopify) |
| `shopify_country_code`   | The buyer's country code                                                             |
| `browser-language`       | The buyer's language (e.g. `fr`)                                                     |
| `browser-locale`         | The buyer's region-qualified locale (e.g. `fr-CA`)                                   |

These keys are also available as [template variables](/questions/template-variables.md) in your question copy.

### Order journey and shipment metadata

When a response is tied to a Shopify order (through `shopify_order_id`, or automatically on the Thank You and Order Status surfaces), Zigpoll also pulls the order's customer journey and shipment details from Shopify and adds them to the response a few minutes after it is submitted:

| Key                                                                   | Value                                                 |
| --------------------------------------------------------------------- | ----------------------------------------------------- |
| `daysToConversion`                                                    | Days between the customer's first visit and the order |
| `landingPage`                                                         | The page the customer first landed on                 |
| `referrerUrl`                                                         | The site that referred the customer                   |
| `source`, `sourceType`, `sourceDescription`                           | Where the visit came from, as Shopify classifies it   |
| `referralCode`                                                        | A referral code attached to the visit, if any         |
| `utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content` | UTM parameters from the visit that led to the order   |
| `shopify_tracking_company`                                            | The shipping carrier or carriers                      |
| `shopify_tracking_number`                                             | The shipment tracking number or numbers               |
| `shopify_tracking_url`                                                | The shipment tracking link or links                   |

Only keys with a value are written. A survey completed before a carrier is assigned adds no tracking keys, and Zigpoll checks again about three minutes after submission to catch fulfillments created in the meantime. Multiple shipments are comma-separated.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zigpoll.com/embed/poll-metadata/special-variables.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.