ShipStation Extractor Documentation

This article 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

Key Topics:

Click on the links below to take you to the section where you can learn more about this integration and where it is used and how it is created

Integration Availability

This integration is available for:

  • Pro

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

Extraction Overview

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)

Endpoints

Carriers

The [carriers] table is generated using the List Carriers API endpoint

  • Update method: UPSERT
API Field Database Column
MD5(shippingProviderId + accountNumber) id
name name
code code
accountNumber account_number
requiresFundedAccount requires_funded_account
balance balance
shippingProviderId shipping_provider_id
nickname nickname
primary is_primary

Carrier Packages

The [carrier_packages] table is generated using the List Packages API endpoint

  • Update method: UPSERT
API Field Database Column
MD5(carrierCode + code) id
carrierCode carrier_code
code code
name name
domestic domestic
international international

Carrier Services

The [carrier_services] table is generated using the List Services API endpoint

  • Update method: UPSERT
API Field Database Column
MD5(carrierCode + code) id
carrierCode carrier_code
code code
name name
domestic domestic
international international

Orders

The [orders] table is generated using the List Orders API endpoint

  • Update method: UPSERT
API Field Database Column
orderId id
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

The [order_items] table is generated using the List Orders API endpoint and extracting the nested JSON from items

  • Update method: UPSERT
API Field Database Column
MD5(productId + orderId + orderItemId) key
orderID order_id
orderItemID order_item_id
lineItemKey line_item_key
sku sku
name name
quantity quantity
unitPrice unit_price
taxAmount tax_amount
shippingAmount shipping_amount
productID product_id
fulfillmentSku fulfillment_sku
upc upc
modifyDate modify_date
createDate create_date

Shipments

The [shipments] table is generated using the List Shipments API endpoint

  • Update method: UPSERT
API Field Database Column
shipmentId id
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 confirmation
warehouseId warehouse_id
voided 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

The [shipment_line_items] table is generated using the List Shipments API endpoint

  • Update method: UPSERT
API Field Database Column
MD5(productId + shipmentId + orderItemId) key
shipmentId shipment_id
orderItemId order_item_id
LineItemKey line_item_key
sku sku
name name
quantity quantity
unitPrice unit_price
taxAmount tax_amount
shippingAmount shipping_amount
warehouseLocation warehouse_location
productId product_id
fulfillmentSku fulfillment_sku
upc upc

SKUs

The [skus] table is generated using the List Products API endpoint

  • Update method: UPSERT
API Field Database Column
productId id
productId product_id
sku sku
name name
price price
defaultCost default_cost
length length
width width
height height
weightOz weight_oz
fulfillmentSku fulfillment_sku
createDate created_at
modifyDate modified_at
active active
productType product_type
warehouseLocation warehouse_location

SKU Attributes

The [sku_attributes] table is generated using the List Products API endpoint

  • Update method: UPSERT
API Field Database Column
MD5(productId + tag_id) key
productId product_id
tag_id tag_id
name name

Users

The [users] table is generated using the List Users API endpoint

  • Update method: UPSERT
API Field Database Column
userId id
userName user_name
name name
active active

Warehouses

The [warehouses] table is generated using the List Warehouses API endpoint

  • Update method: UPSERT
API Field Database Column
warehouseId id
warehouseId warehouse_id
warehouseName name

Release Updates

  • 2022-03-24: Added Users table and related fields

Related Resources