> For the complete documentation index, see [llms.txt](https://daton-sarasanalytics.gitbook.io/daton/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/advertising/upscribe.md).

# Upscribe

Upscribe ETL connector for data replication

## Snapshot

| Features                        | Details                                                             |
| ------------------------------- | ------------------------------------------------------------------- |
| Release Status                  | Released                                                            |
| Source API Version              | v2                                                                  |
| Table Selection                 | Yes                                                                 |
| Column Selection                | Yes                                                                 |
| Edit Integration                | Yes                                                                 |
| Replication Type Selection      | No                                                                  |
| Authentication Parameters       | <p>Upscribe Email<br>Upscribe password<br>Upscribe Store Domain</p> |
| Replication Type                | Key based Replication                                               |
| Replication Key                 | datetime                                                            |
| Suggested Replication Frequency | 24 hours                                                            |

## Tables/APIs supported

| subscription | subscription\_history\_report |
| ------------ | ----------------------------- |
| customers    | products                      |
| collections  | refunds                       |
| orders       |                               |

## Integrate Upscribe with Daton

1. Sign in to Daton
2. Select Upscribe from Integrations page
3. Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later
4. Provide your Upscribe account Email and Password and provide your store URL
5. Post successful authentication you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

## Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

## Upscribe Data

### **subscription**

Purpose: Returns all the List of subscriptions associated with upscribe account and your given domain.

Source API Documentation  <https://api.upscribe.io/#list-subscriptions>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name                                | Target Datatype |
| ----------------------------------- | --------------- |
| activated\_on                       | STRING          |
| active                              | BOOLEAN         |
| billing\_address                    | RECORD          |
| cancellation\_reason                | STRING          |
| cancellation\_comment               | STRING          |
| cancellation\_reminder\_sent        | BOOLEAN         |
| cancelled\_on                       | TIMESTAMP       |
| charge\_limit                       | NUMERIC         |
| coupon\_discount                    | STRING          |
| created\_at                         | TIMESTAMP       |
| id                                  | NUMERIC         |
| import\_id                          | STRING          |
| interval                            | NUMERIC         |
| items                               | RECORD          |
| next                                | RECORD          |
| order\_count                        | NUMERIC         |
| original\_total\_line\_items\_price | STRING          |
| original\_total\_price              | STRING          |
| original\_total\_tax                | STRING          |
| payment\_customer\_id               | STRING          |
| payment\_method\_id                 | STRING          |
| payment\_type                       | STRING          |
| period                              | STRING          |
| quantity\_discount                  | STRING          |
| requires\_customer\_update          | BOOLEAN         |
| requires\_update                    | BOOLEAN         |
| shipping\_address                   | RECORD          |
| shipping\_discount                  | STRING          |
| shipping\_lines                     | RECORD          |
| shopify\_customer\_email            | STRING          |
| shopify\_customer\_id               | NUMERIC         |
| shopify\_discount                   | STRING          |
| shopify\_order\_id                  | NUMERIC         |
| store\_id                           | NUMERIC         |
| subscription\_discount              | STRING          |
| tax\_discount                       | STRING          |
| total\_discount                     | STRING          |
| total\_discount\_inc\_tax           | STRING          |
| total\_line\_items\_price           | NUMERIC         |
| total\_price                        | NUMERIC         |
| total\_tax                          | NUMERIC         |
| tracking\_codes                     | RECORD          |
| updated\_at                         | TIMESTAMP       |

### **subscription\_history\_report**

Purpose: Returns all the List of subscriptions changelogs associated with upscribe account and your given domain.

Source API Documentation: <https://api.upscribe.io/#list-subscription-queues>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name              | Data Type |
| ----------------- | --------- |
| admin\_email      | STRING    |
| admin\_id         | STRING    |
| created\_at       | STRING    |
| field             | STRING    |
| id                | STRING    |
| is\_admin         | STRING    |
| item\_id          | STRING    |
| new\_value        | STRING    |
| old\_value        | STRING    |
| product\_title    | STRING    |
| queue\_id         | STRING    |
| requested\_by\_ip | STRING    |
| store\_id         | STRING    |
| subscription\_id  | STRING    |
| updated\_at       | STRING    |
| variant\_title    | STRING    |

### **customers**

Purpose: Returns all the List of customer information and cards associated with upscribe account and your given domain.

Source API Documentation: <https://api.upscribe.io/#get-customer>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name                          | Target Datatype |
| ----------------------------- | --------------- |
| accepts\_marketing            | BOOLEAN         |
| active\_subscription\_count   | NUMERIC         |
| addresses                     | RECORD          |
| created\_at                   | TIMESTAMP       |
| default\_address              | RECORD          |
| email                         | STRING          |
| first\_name                   | STRING          |
| id                            | NUMERIC         |
| inactive\_subscription\_count | NUMERIC         |
| language                      | STRING          |
| last\_name                    | STRING          |
| state                         | STRING          |
| store\_id                     | NUMERIC         |
| updated\_at                   | TIMESTAMP       |

### **products**

Purpose: Returns all the List of product information associated with upscribe account and your given domain.

Source API Documentation <https://api.upscribe.io/#list-subscription-products>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name               | Target Datatype |
| ------------------ | --------------- |
| body\_html         | STRING          |
| collections        | RECORD          |
| created\_at        | TIMESTAMP       |
| handle             | STRING          |
| id                 | NUMERIC         |
| image              | RECORD          |
| images             | RECORD          |
| in\_sales\_channel | BOOLEAN         |
| is\_subscription   | BOOLEAN         |
| metafields         | RECORD          |
| options            | RECORD          |
| store\_id          | NUMERIC         |
| template\_suffix   | STRING          |
| title              | STRING          |
| updated\_at        | TIMESTAMP       |
| variants           | RECORD          |
| vendor             | STRING          |

### **collections**

Purpose: Returns all the List of collections information associated with upscribe account and your given domain.

Source API Documentation&#x20;

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| body\_html  | STRING          |
| created\_at | TIMESTAMP       |
| handle      | STRING          |
| id          | NUMERIC         |
| image       | STRING          |
| sort\_order | STRING          |
| store\_id   | NUMERIC         |
| title       | STRING          |
| updated\_at | TIMESTAMP       |

### **refunds**

Purpose:Returns all the List of refunds associated with upscribe account and your given domain.

Source API Documentation <https://api.upscribe.io/#list-refunds>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| amount              | NUMERIC         |
| created\_at         | TIMESTAMP       |
| currency            | STRING          |
| id                  | STRING          |
| payment\_charge\_id | STRING          |
| reason              | STRING          |
| shopify\_order\_id  | NUMERIC         |
| status              | STRING          |
| store\_id           | NUMERIC         |
| type                | STRING          |
| updated\_at         | TIMESTAMP       |

### **orders**

Purpose: Returns all the List of order information associated with upscribe account and your given domain.

Source API Documentation <https://api.upscribe.io/#get-order>

Replication: Key-Based Replication

Replication Key: updated\_at\_min, updated\_at\_max

**Fields**

| Name                        | Target Datatype |
| --------------------------- | --------------- |
| analytics                   | STRING          |
| billing\_address            | RECORD          |
| cancel\_reason              | STRING          |
| cancelled\_at               | TIMESTAMP       |
| contact\_email              | STRING          |
| create\_subscription        | BOOLEAN         |
| created\_at                 | TIMESTAMP       |
| customer                    | RECORD          |
| discount\_applications      | RECORD          |
| discount\_codes             | RECORD          |
| email                       | STRING          |
| financial\_status           | STRING          |
| fulfillment\_status         | STRING          |
| fulfillments                | RECORD          |
| guest\_checkout             | BOOLEAN         |
| id                          | NUMERIC         |
| line\_items                 | RECORD          |
| name                        | STRING          |
| note                        | STRING          |
| number                      | NUMERIC         |
| order\_number               | NUMERIC         |
| payment\_charge\_id         | STRING          |
| payment\_customer\_id       | STRING          |
| payment\_method\_id         | STRING          |
| payment\_type               | STRING          |
| phone                       | STRING          |
| presentment\_currency       | STRING          |
| processed\_at               | TIMESTAMP       |
| refunds                     | RECORD          |
| shipping\_address           | RECORD          |
| shipping\_lines             | RECORD          |
| shopify\_customer\_id       | NUMERIC         |
| store\_id                   | NUMERIC         |
| subtotal\_price             | NUMERIC         |
| tags                        | STRING          |
| tax\_lines                  | RECORD          |
| token                       | STRING          |
| total\_discounts            | NUMERIC         |
| total\_line\_items\_price   | NUMERIC         |
| total\_price                | NUMERIC         |
| total\_shipping\_price\_set | RECORD          |
| total\_tax                  | NUMERIC         |
| tracking\_codes             | RECORD          |
| updated\_at                 | TIMESTAMP       |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/advertising/upscribe.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.