Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Expected Shippo Data

Shippo Info
This integration was created by Stitch for Singer, an open-source, composable ETL platform. Check out & contribute to the repo on GitHub.

Shippo is currently in Open Beta. The info in this article is subject to change.

Now that Shippo is successfully connected to your Stitch account, what comes next? In this article, we'll cover:

  1. How Stitch replicates Shippo data
  2. The tables that will be created in your data warehouse

Replicating Shippo Data

Historical Sync

By default, a historical sync of Shippo data goes back one year from the Stitch connection date.

Frequency

Stitch will replicate Shippo data based on the frequency you define. The default setting is every 30 minutes, but you can change it better suit your needs.

Replication Method

When Stitch replicates Shippo data, it does so using Incremental Replication. This means that every time Braintree data is queued for replication, only new and updated data will be replicated.

Shippo Tables in Your Data Warehouse

Below is a list of the Shippo tables that will be created in your data warehouse. Because Shippo uses nested arrays to structure data in some of its API's endpoints, Stitch will de-nest these arrays and create subtables if your data warehouse doesn't natively support nested structures. Refer to the Handling of Nested Data Structures doc for more info.

Nested arrays are marked with a *.

Click the table names to check out Shippo's API docs.

addresses
Replication Method: Incremental
Primary Key: object_id

The addresses table contains info about address objects. These are used to create shipments, obtain rates, and print labels.

Attributes include:

  • object_id
  • object_state
  • object_purpose
  • object_source
  • object_created
  • object_updated
  • object_owner
  • name
  • company
  • street1
  • street2
  • city
  • state
  • zip
  • country
  • phone
  • email
  • is_residential
  • metadata
  • type
  • messages*

parcels
Replication Method: Incremental
Primary Key: object_id

The parcels table contains info about parcel objects. Parcels are used to create shipments, obtain rates, and print labels.

Attributes include:

  • object_id
  • object_state
  • object_purpose
  • object_source
  • object_created
  • object_updated
  • object_owner
  • template
  • length
  • width
  • height
  • distance_unit
  • weight
  • mass_unit
  • extra
  • test

refunds
Replication Method: Incremental
Primary Key: object_id

The refunds table contains info about refunds, which are reimbursements for successfully created but unused transactions.

If the data in this table doesn’t look like you’d expect it to, keep in mind that refunds can take up to 14 days to be processed.

Attributes include:

  • object_id
  • object_state
  • object_purpose
  • object_created
  • object_updated
  • object_owner
  • transaction
  • test

shipments
Replication Method: Incremental
Primary Key: object_id

The shipments table contains info about shipment objects. Shipment objects are made up of to and from addresses and the parcel to be shipped.

Attributes include:

  • object_id
  • object_state
  • object_purpose
  • object_created
  • object_updated
  • object_owner
  • object_from
  • object_to
  • object_return
  • object_parcel
  • submission-date
  • insurance_amount
  • insurance_currency
  • extra
  • customs_declaration
  • reference1
  • reference2
  • rates_url
  • rates_list
  • carrier_accounts
  • metadata
  • test
  • messages*

transactions
Replication Method: Incremental
Primary Key: object_id

The transactions table contains info about transactions, which are the purchases of shipping labels from a shipping provider for a specific service.

Attributes include:

  • object_id
  • object_state
  • object_purpose
  • object_created
  • object_updated
  • object_owner
  • test
  • rate
  • tracking_number
  • tracking_status
  • tracking_history
  • tracking_url_provider
  • label_url
  • commercial_invoice_url
  • metadata
  • messages*

Related

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!