# Integration Specifications

## Integration Overview

Stay Ai is a subscription platform for e-commerce brands. Our integration extracts and loads the contents of those subscriptions.

This document provides context on what kind of data is being gathered through this extractor, which endpoints that data is coming from, and how the extracted tables relate to each other.

## Integration Availability

This integration is currently available for:

* Enterprise

## API Endpoints

The Daasity Stay Ai extractor is built based on [this API documentation](https://docs.stay.ai/reference/). The following endpoints are used by Daasity to replicate data into your data warehouse:

* [List All Orders](https://docs.stay.ai/reference/query-orders)
* [List All Subscriptions](https://docs.stay.ai/reference/query-all-subscriptions)

## Stay Ai Schema

The Daasity Stay Ai extractor creates these tables using the endpoints and replication methods listed. The data is mapped from source API endpoint to the table based on the mapping logic outlined in each table.

* [Subscriptions](#subscriptions)
* [Subscription Line Items](#subscription-line-items)
* [Orders](#orders)
* [Order Line Items](#order-line-items)

### Subscriptions

* Endpoint: List All Subscriptions
* Update Method: UPSERT
* Table Name: \[`stay_ai.subscriptions`]

<table><thead><tr><th width="392">JSON Element</th><th width="323">Column</th></tr></thead><tbody><tr><td>$.cancellationReason</td><td>cancellation_reason</td></tr><tr><td>$.cancelledAt</td><td>cancelled_at</td></tr><tr><td>$.churnedAt</td><td>churned_at</td></tr><tr><td>$.createdAt</td><td>created_at</td></tr><tr><td>$.currency</td><td>currency</td></tr><tr><td>$.customerId</td><td>customer_id</td></tr><tr><td>$.deliveryAddress.address1</td><td>delivery_address__address1</td></tr><tr><td>$.deliveryAddress.address2</td><td>delivery_address__address2</td></tr><tr><td>$.deliveryAddress.city</td><td>delivery_address__city</td></tr><tr><td>$.deliveryAddress.company</td><td>delivery_address__company</td></tr><tr><td>$.deliveryAddress.country</td><td>delivery_address__country</td></tr><tr><td>$.deliveryAddress.countryCode</td><td>delivery_address__country_code</td></tr><tr><td>$.deliveryAddress.firstName</td><td>delivery_address__first_name</td></tr><tr><td>$.deliveryAddress.lastName</td><td>delivery_address__last_name</td></tr><tr><td>$.deliveryAddress.phone</td><td>delivery_address__phone</td></tr><tr><td>$.deliveryAddress.province</td><td>delivery_address__province</td></tr><tr><td>$.deliveryAddress.provinceCode</td><td>delivery_address__province_code</td></tr><tr><td>$.deliveryAddress.zip</td><td>delivery_address__zip</td></tr><tr><td>$.deliveryPrice</td><td>delivery_price</td></tr><tr><td>$.dunningExitedAt</td><td>dunning_exited_at</td></tr><tr><td>$.dunningStartedAt</td><td>dunning_started_at</td></tr><tr><td>$.emailAddress</td><td>email_address</td></tr><tr><td>$.firstName</td><td>first_name</td></tr><tr><td>$.id</td><td>id</td></tr><tr><td>$.lastChargeDate</td><td>last_charge_date</td></tr><tr><td>$.lastName</td><td>last_name</td></tr><tr><td>$.nextBillingDate</td><td>next_billing_date</td></tr><tr><td>$.orderIntervalFrequency</td><td>order_interval_frequency</td></tr><tr><td>$.orderIntervalUnit</td><td>order_interval_unit</td></tr><tr><td>$.pausedUntil</td><td>paused_until</td></tr><tr><td>$.price</td><td>price</td></tr><tr><td>$.status</td><td>status</td></tr><tr><td>$.subscriptionId</td><td>subscription_id</td></tr><tr><td>$.updatedAt</td><td>updated_at</td></tr><tr><td>MD5($.id)</td><td>__sync_key</td></tr></tbody></table>

### Subscription Line Items

* Endpoint: List All Subscriptions
* Update Method: UPSERT
* Table Name: \[`stay_ai.subscription_line_items`]

<table><thead><tr><th width="372">JSON Element</th><th width="315">Column</th></tr></thead><tbody><tr><td>$.lineItems[].isOneTime</td><td>is_one_time</td></tr><tr><td>$.lineItems[].lineId</td><td>line_id</td></tr><tr><td>$.lineItems[].productTitle</td><td>product_title</td></tr><tr><td>$.lineItems[].quantity</td><td>quantity</td></tr><tr><td>$.lineItems[].shopifyProductId</td><td>shopify_product_id</td></tr><tr><td>$.lineItems[].shopifyVariantId</td><td>shopify_variant_id</td></tr><tr><td>$.lineItems[].sku</td><td>sku</td></tr><tr><td>$.lineItems[].subscriptionId</td><td>subscription_id</td></tr><tr><td>$.lineItems[].subtotalPrice</td><td>subtotal_price</td></tr><tr><td>$.lineItems[].unitPrice</td><td>unit_price</td></tr><tr><td>$.lineItems[].variantTitle</td><td>variant_title</td></tr><tr><td>MD5($.lineItems[].line_id + $.lineItems[].subscription_id)</td><td>__sync_key</td></tr></tbody></table>

### Orders

* Endpoint: List All Orders
* Update Method: UPSERT
* Table Name: \[`stay_ai.orders`]

| JSON Element           | Column                    |
| ---------------------- | ------------------------- |
| $.customerId           | customer\_id              |
| $.address.address1     | address\_\_address1       |
| $.address.address2     | address\_\_address2       |
| $.address.city         | address\_\_city           |
| $.address.company      | address\_\_company        |
| $.address.country      | address\_\_country        |
| $.address.countryCode  | address\_\_country\_code  |
| $.address.firstName    | address\_\_first\_name    |
| $.address.lastName     | address\_\_last\_name     |
| $.address.phone        | address\_\_phone          |
| $.address.province     | address\_\_province       |
| $.address.provinceCode | address\_\_province\_code |
| $.address.zip          | address\_\_zip            |
| $.cartDiscountAmount   | cart\_discount\_amount    |
| $.createdAt            | created\_at               |
| $.currency             | currency                  |
| $.currentTotalTax      | current\_total\_tax       |
| $.customerId           | customer\_id              |
| $.fulfillmentStatus    | fulfillment\_status       |
| $.orderId              | order\_id                 |
| $.orderName            | order\_name               |
| $.subscriptionId       | subscription\_id          |
| $.tags                 | tags                      |
| $.totalPrice           | total\_price              |
| $.totalShippingPrice   | total\_shipping\_price    |
| $.updatedAt            | updated\_at               |
| MD5($.order\_id)       | \_\_sync\_key             |

### Order Line Items

* Endpoint: List All Orders
* Update Method: UPSERT
* Table Name: \[`stay_ai.order_line_items`]

| $.lineItems\[].lineId           | line\_id             |
| ------------------------------- | -------------------- |
| $.lineItems\[].productTitle     | product\_title       |
| $.lineItems\[].quantity         | quantity             |
| $.lineItems\[].shopifyProductId | shopify\_product\_id |
| $.lineItems\[].shopifyVariantId | shopify\_variant\_id |
| $.lineItems\[].sku              | sku                  |
| $.lineItems\[].subtotalPrice    | subtotal\_price      |
| $.lineItems\[].variantTitle     | variant\_title       |
| $.customerId                    | customer\_id         |
| $.orderId                       | order\_id            |
| $.subscriptionId                | subscription\_id     |
| MD5($.lineItems\[].line\_id)    | \_\_sync\_key        |


---

# Agent Instructions: 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:

```
GET https://help.daasity.com/core-concepts/data-integrations/setup-guides/digital-integrations/stay-ai/integration-specifications.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
