Integrations
      Back to home
      1. Help Center
      2. Technical Documentation
      3. Integrations

      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

      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)

      The embedded diagram houses the ERD for the Daasity Shipstation integration illustrating the different tables and keys to join across tables.  Hover over the embedded diagram to reveal controls to zoom and scroll.

      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) 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

      • Endpoint: List Packages
      • Update method: UPSERT
      • Table name: shipstation.carrier_packages
      API Field Database Column
      MD5(carrierCode + code) id
      carrierCode carrier_code
      code code
      name name
      domestic domestic
      international international

      Carrier Services

      • Endpoint: List Services 
      • Update method: UPSERT
      • Table name: shipstation.carrier_services
      API Field Database Column
      MD5(carrierCode + code) id
      carrierCode carrier_code
      code code
      name name
      domestic domestic
      international international

      Orders

      • Endpoint: List Orders 
      • Update method: UPSERT
      • Table name: shipstation.orders
      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

      • 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 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

      • Endpoint: List Shipments
      • Update method: UPSERT
      • Table name: shipstation.shipments
      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

      • 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 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

      • Endpoint: List Products 
      • Update method: UPSERT
      • Table name: shipstation.skus
      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

      • 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 tag_id
      name name

      Users

      • Endpoint: List Users 
      • Update method: UPSERT
      • Table name: shipstation.user
      API Field Database Column
      userId id
      userName user_name
      name name
      active active

      Warehouses

      • Endpoint: List Warehouses
      • Update method: UPSERT
      • Table name: shipstation.warehouses
      API Field Database Column
      warehouseId id
      warehouseId warehouse_id
      warehouseName name

      Release Updates

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

      Related Resources