# Shippo

### Snapshot

| Features                        | Details                                                 |
| ------------------------------- | ------------------------------------------------------- |
| Release Status                  | Released                                                |
| Source API Version              | v1.2                                                    |
| Table Selection                 | Yes                                                     |
| Column Selection                | Yes                                                     |
| Edit Integration                | Yes                                                     |
| Replication Type Selection      | No                                                      |
| Authentication Parameters       | <p>Shippo email<br>Shippo password</p>                  |
| Replication Type                | <p>Full Based Replication <br>Key-Based Replication</p> |
| Replication Key                 | <p>NA<br>lastRunDate</p>                                |
| Suggested Replication Frequency | 24 hrs                                                  |

| Tables/APIs Supported |                        |
| --------------------- | ---------------------- |
| Adressess             | Parcels                |
| Shipments             | ShippingLables         |
| CustomItems           | CustomItemDeclarations |
| Refunds               | Manifests              |
| CarrierAccounts       | Orders                 |

### Integrate Shippo with Daton

1. Signin to Daton&#x20;
2. Select shippo 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&#x20;
4. Provide your shippo email and password to authorize Daton to periodically extract data from constantcontact.
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

### SHIPPO Data

**Adressess**

Purpose: Returns the list of all addresses

Source API Documentation  <https://api.goshippo.com/addresses/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| is\_complete    | BOOLEAN         |
| object\_created | TIMESTAMP       |
| object\_updated | TIMESTAMP       |
| object\_id      | STRING          |
| object\_owner   | STRING          |
| name            | STRING          |
| street1         | STRING          |
| street2         | STRING          |
| city            | STRING          |
| state           | STRING          |
| zip             | INTEGER         |
| country         | STRING          |
| phone           | INTEGER         |
| email           | STRING          |
| is\_residential | BOOLEAN         |
| metadata        | STRING          |
| test            | BOOLEAN         |

**Parcels**

Purpose: Returns the list of all parcels.

Source API Documentation:  <https://api.goshippo.com/parcels/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| object\_state   | STRING          |
| object\_created | TIMESTAMP       |
| object\_updated | TIMESTAMP       |
| object\_id      | STRING          |
| object\_owner   | STRING          |
| template        | STRING          |
| length          | STRING          |
| width           | STRING          |
| height          | STRING          |
| distance\_unit  | STRING          |
| weight          | STRING          |
| mass\_unit      | STRING          |
| metadata        | STRING          |
| test            | BOOLEAN         |

**Shipments**

Purpose:Returns the list of all shipments.

Source API Documentation:  <https://api.goshippo.com/shipments/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| object\_created     | TIMESTAMP       |
| object\_updated     | TIMESTAMP       |
| object\_id          | STRING          |
| object\_owner       | STRING          |
| status              | STRING          |
| adress\_from        | RECORD          |
| adrees\_to          | RECORD          |
| parcels             | RECORD          |
| shipment\_date      | TIMESTAMP       |
| adress\_return      | RECORD          |
| extra               | RECORD          |
| custom\_declaration | STRING          |
| rates               | RECORD          |
| carrier\_accounts   | STRING          |
| messages            | RECORD          |
| metdata             | STRING          |
| test                | BOOLEAN         |

**ShippingLables**

Purpose:Returns the list of all shippinglables.

Source API Documentation:  <https://api.goshippo.com/shippinglables/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| object\_state            | STRING          |
| status                   | STRING          |
| object\_created          | STRING          |
| object\_updated          | STRING          |
| object\_id               | STRING          |
| object\_owner            | STRING          |
| test                     | BOOLEAN         |
| rate                     | STRING          |
| tracking\_number         | STRING          |
| tracking\_status         | STRING          |
| tracking\_url\_provider  | STRING          |
| eta                      | STRING          |
| lable\_url               | STRING          |
| commercial\_invoice\_url | STRING          |
| messages                 | STRING          |
| metdata                  | STRING          |

**CustomItems**

Purpose:Returns the list of all customitems.

Source API Documentation:  <https://api.goshippo.com/customitems/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| object\_created | TIMESTAMP       |
| object\_updated | TIMESTAMP       |
| object\_id      | STRING          |
| object\_owner   | STRING          |
| object\_state   | STRING          |
| description     | STRING          |
| quantity        | NUMERIC         |
| net\_weight     | STRING          |
| mass\_unit      | STRING          |
| value\_amount   | STRING          |
| value\_currency | STRING          |
| origin\_country | STRING          |
| tariff\_number  | STRING          |
| metdata         | STRING          |
| test            | BOOLEAN         |

**CustomItemDeclarations**

Purpose:Returns the list of all customitemdeclarations.

Source API Documentation:  <https://api.goshippo.com/customitemdeclarations/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| object\_created       | TIMESTAMP       |
| object\_updated       | TIMESTAMP       |
| object\_id            | STRING          |
| object\_owner         | STRING          |
| object\_state         | STRING          |
| certify\_signer       | STRING          |
| certify               | BOOLEAN         |
| items                 | STRING          |
| non\_delivery\_option | STRING          |
| contents\_type        | STRING          |
| contents\_explanation | STRING          |
| exporter\_reference   | STRING          |
| importer\_reference   | STRING          |
| invoice               | STRING          |
| commercial\_invoice   | BOOLEAN         |
| license               | STRING          |
| certificate           | STRING          |
| notes                 | STRING          |
| eel\_pfc              | STRING          |
| aes\_itn              | STRING          |
| disclaimer            | STRING          |
| incoterm              | STRING          |
| metdata               | STRING          |
| test                  | BOOLEAN         |

**Refunds**

Purpose:Returns the list of all refunds.

Source API Documentation:  <https://api.goshippo.com/refunds/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| object\_created | TIMESTAMP       |
| object\_updated | TIMESTAMP       |
| object\_id      | STRING          |
| object\_owner   | STRING          |
| status          | STRING          |
| transactions    | STRING          |
| test            | BOOLEAN         |

**Manifests**

Purpose:Returns the list of all mainfest.

Source API Documentation  <https://api.goshippo.com/manifests/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name             | Target Datatype |
| ---------------- | --------------- |
| object\_created  | TIMESTAMP       |
| object\_updated  | TIMESTAMP       |
| object\_id       | STRING          |
| object\_owner    | STRING          |
| status           | STRING          |
| carrier\_account | STRING          |
| shipment\_date   | STRING          |
| adress\_from     | STRING          |
| transactions     | STRING          |
| documents        | STRING          |

**CarrierAccounts**

Purpose:Returns the list of list all carrier accounts.

Source API Documentation  <https://api.goshippo.com/carrieraccounts/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name          | Target Datatype |
| ------------- | --------------- |
| object\_id    | STRING          |
| object\_owner | STRING          |
| carrier       | STRING          |
| account\_id   | STRING          |
| test          | BOOLEAN         |
| active        | BOOLEAN         |

**Orders**

Purpose:Returns the list of all orders.

Source API Documentation  <https://api.goshippo.com/orders/>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                     | Target Datatype |
| ------------------------ | --------------- |
| object\_id               | STRING          |
| object\_owner            | STRING          |
| order\_number            | STRING          |
| order\_status            | STRING          |
| placed\_at               | STRING          |
| to\_address              | RECORD          |
| from\_address            | STRING          |
| line\_items              | RECORD          |
| shipping\_cost           | STRING          |
| shipping\_cost\_currency | STRING          |
| shipping\_method         | STRING          |
| shop\_app                | STRING          |
| subtotal\_price          | STRING          |
| total\_price             | STRING          |
| total\_tax               | STRING          |
| currency                 | STRING          |
| transactions             | STRING          |
| weight                   | STRING          |
| weight\_unit             | STRING          |
| notes                    | STRING          |