Integration Specifications

This page will help you learn about how Daasity replicates data from ShipStation, limitations to the data we can extract and where the data is stored in the ShipStation schema

Integration Overview

ShipStation is a web-based shipping platform that helps businesses manage their small parcel shipping and e-commerce fulfillment.

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 available for:

Enterprise
Growth

NOTE: A code block exists to include shipping costs into Daasity data model (UOS) from ShipStation

API Endpoints

The Daasity integration with ShipStation extracts data from a number of endpoints from the ShipStation API.

The following endpoints are currently included in the Integration and currently refreshed on a daily basis:

Entity Relationship Diagram (ERD)

Click here to view the ERD for the Daasity Shipstation integration illustrating the different tables and keys to join across tables.

ShipStation Schema

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

Carriers

Endpoint: List Carriers
Update method: UPSERT
Table name: [shipstation.carriers]

API Field

Database Column

MD5(shippingProviderId + accountNumber)

name

code

accountNumber

account_number

requiresFundedAccount

requires_funded_account

balance

shippingProviderId

shipping_provider_id

nickname

primary

is_primary

Carrier Packages

Endpoint: List Packages
Update method: UPSERT
Table name: [shipstation.carrier_packages]

API Field

Database Column

MD5(carrierCode + code)

carrierCode

carrier_code

code

name

domestic

international

Carrier Services

Endpoint: List Services
Update method: UPSERT
Table name: [shipstation.carrier_services]

API Field

Database Column

MD5(carrierCode + code)

carrierCode

carrier_code

code

name

domestic

international

Orders

Endpoint: List Orders
Update method: UPSERT
Table name: [shipstation.orders]

API Field

Database Column

orderId

order_id

orderNumber

order_number

orderKey

order_key

orderDate

order_date

createDate

create_date

modifyDate

modify_date

paymentDate

payment_date

shipByDate

ship_by_date

orderStatus

order_status

customerId

customer_id

customerUsername

customer_username

customerEmail

customer_email

shipTo::name

ship_to_name

shipTo::company

ship_to_company

shipTo::street1

ship_to_street1

shipTo::street2

ship_to_street2

shipTo::city

ship_to_city

shipTo::state

ship_to_state

shipTo::postalCode

ship_to_postal_code

shipTo::country

ship_to_country

shipTo::phone

ship_to_phone

orderTotal

order_total

amountPaid

amount_paid

taxAmount

tax_amount

shippingAmount

shipping_amount

paymentMethod

payment_method

carrierCode

carrier_code

serviceCode

service_code

packageCode

package_code

shipDate

ship_date

holdUntilDate

hold_until_date

advanced_options::warehouseId

warehouse_id

Order Items

Endpoint: List Orders
Update method: UPSERT
Table name: [shipstation.order_items]

API Field

Database Column

MD5(productId + orderId + orderItemId)

key

orderID

order_id

orderItemID

order_item_id

lineItemKey

line_item_key

sku

name

quantity

unitPrice

unit_price

taxAmount

tax_amount

shippingAmount

shipping_amount

productID

product_id

fulfillmentSku

fulfillment_sku

upc

modifyDate

modify_date

createDate

create_date

Shipments

Endpoint: List Shipments
Update method: UPSERT
Table name: [shipstation.shipments]

API Field

Database Column

shipmentId

shipment_id

orderId

order_id

orderKey

order_key

customerEmail

customer_email

orderNumber

order_number

createDate

create_date

shipDate

ship_date

shipmentCost

shipment_cost

insuranceCost

insurance_cost

trackingNumber

tracking_number

isReturnLabel

is_return_label

batchNumber

batch_number

carrierCode

carrier_code

serviceCode

service_code

packageCode

package_code

confirmation

warehouseId

warehouse_id

voided

voidDate

void_date

shipTo::name

ship_to_name

shipTo::company

ship_to_company

shipTo::street1

ship_to_street1

shipTo::street2

ship_to_steet2

shipTo::city

ship_to_city

shipTo::state

ship_to_state

shipTo::postalCode

ship_to_postal_code

shipTo::country

ship_to_country

userId

user_id

Shipment Line Items

Endpoint: List Shipments
Update method: UPSERT
Table name: [shipstation.shipment_line_items]

API Field

Database Column

MD5(productId + shipmentId + orderItemId)

key

shipmentId

shipment_id

orderItemId

order_item_id

LineItemKey

line_item_key

sku

name

quantity

unitPrice

unit_price

taxAmount

tax_amount

shippingAmount

shipping_amount

warehouseLocation

warehouse_location

productId

product_id

fulfillmentSku

fulfillment_sku

upc

SKUs

Endpoint: List Products
Update method: UPSERT
Table name: [shipstation.skus]

API Field

Database Column

productId

product_id

sku

name

price

defaultCost

default_cost

length

width

height

weightOz

weight_oz

fulfillmentSku

fulfillment_sku

createDate

created_at

modifyDate

modified_at

active

productType

product_type

warehouseLocation

warehouse_location

SKU Attributes

Endpoint: List Products
Update method: UPSERT
Table name: [shipstation.sku_attributes]

API Field

Database Column

MD5(productId + tag_id)

key

productId

product_id

tag_id

name

Users

Endpoint: List Users
Update method: UPSERT
Table name: [shipstation.user]

API Field

Database Column

userId

userName

user_name

name

active

Warehouses

Endpoint: List Warehouses
Update method: UPSERT
Table name: [shipstation.warehouses]

API Field

Database Column

warehouseId

warehouse_id

warehouseName

name

PreviousIntegration Setup NextWorkflow Configuration Setup

Was this helpful?