Integration Specifications
This page will help you learn about how Daasity replicates data from Fairing, limitations to the data we can extract and where the data is stored in the Shipwire schema.
Integration Overview
Shipwire is a logistics and operations platform that optimizes order fulfillments through their network of global warehouses and technology stack.
The Daasity Shipwire integration provides merchants with data on order fulfillments. 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
API Endpoints
The Daasity Shipwire extractor is built based on this Shipwire API documentation. The following endpoints are used by Daasity to replicate data from Shipwire:
Entity Relationship Diagram (ERD)
Click here to view the ERD for the Daasity Shipwire integration illustrating the different tables and keys to join across tables.
Shipwire Schema
The Daasity Shipwire extractor creates these tables using the endpoints and replication methods listed. The data is mapped from source API endpoint to the table based on the mapping logic outlined in each table.
Orders
Endpoint: Order
Update Method: UPSERT
Table Name: [shipwire.orders
]
JSON Element | Database Column |
---|---|
order::id | id |
order::externalId | external_id |
order::orderNo | order_no |
order::commerceName | commerce_name |
order::processAfterDate | process_after_date |
order::lastUpdatedDate | last_updated_date |
order::status | status |
order::vendorId | vendor_id |
order::vendorExternalId | vendor_external_id |
order::purchaseOrderId | purchase_order_id |
order::purchaseOrderExternalId | purchase_order_external_id |
order::purchaseOrderNo | purchase_order_no |
order::transactionId | transaction_id |
order::vendorName | vendor_name |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Options
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.order_options
]
JSON Element | Database Column |
---|---|
order.options::order_id | order_id |
order.options::warehouseId | warehouse_id |
order.options::serviceLevelCode | shipping_service_level |
order.options::carrierCode | carrier_code |
order.options::carrierId | carrier_id |
order.options::thirdPartyCarrierCodeRequested | third_party_carrier_code_requested |
order.options::billingType | billing_type |
order.options::channelName | channel_name |
order.options::referrer | referrer |
order.options::carrierType | carrier_type |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Routing
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.order_routing
]
JSON Element | Database Column |
---|---|
order.routing::order_id | order_id |
order.routing::warehouseId | warehouse_id |
order.routing::warehouseName | warehouse_name |
order.routing::originLongitude | origin_longitude |
order.routing::originLatitude | origin_latitude |
order.routing::destinationLongitude | destination_longitude |
order.routing::destinationLatitude | destination_latitude |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Addresses
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.order_addresses
]
JSON Element | Database Column |
---|---|
order.ship_to::order_id | order_id |
'shipping' | type |
order.ship_to::email | |
order.ship_to::name | name |
order.ship_to::company | company |
order.ship_to::address1 | address1 |
order.ship_to::address2 | address2 |
order.ship_to::city | city |
order.ship_to::state | state |
order.ship_to::postalCode | postal_code |
order.ship_to::country | country |
order.ship_to::isCommercial | is_commercial |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Events
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.order_events
]
JSON Element | Database Column |
---|---|
order.events::order_id | order_id |
order.events::createdDate | created_date |
order.events::processedDate | processed_date |
order.events::submittedDate | submitted_date |
order.events::pickedUpDate | picked_up_date |
order.events::expectedSubmittedDate | expected_submitted_date |
order.events::expectedCompletedDate | expected_completed_date |
order.events::completedDate | completed_date |
order.events::cancelledDate | cancelled_date |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Shipping
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.order_shipping
]
JSON Element | Database Column |
---|---|
order.pricing::order_id | order_id |
order.pricing::shipping | shipping_cost |
order.estimates::shipping | shipping_estimate |
order.pricing::packaging | packaging_cost |
order.estimates::packaging | packaging_estimate |
order.pricing::insurance | insurance_cost |
order.estimates::insurance | insurance_estimate |
order.pricing::handling | handling_cost |
order.estimates::handling | handling_estimate |
order.pricing::total | total_cost |
order.estimates::total | total_estimate |
order.freight::totalWeight | total_weight |
order.freight::weightUnit | weight_unit |
order.freight::measurementType | measurement_type |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Order Items
Endpoint: Order
Update Method: UPSERT
Table Name: [shipwire.order_items]
JSON Element | Database Column |
---|---|
order.items::id | id |
order.items::orderId | order_id |
order.items::productId | product_id |
order.items::ordered | ordered |
order.items::backordered | backordered |
order.items::reserved | reserved |
order.items::shipping | shipping |
order.items::shipped | shipped |
order.items::sku | sku |
order.items::quantity | quantity |
order.items::description | description |
account_id | account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Packages
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.packages
]
JSON Element | Database Column |
---|---|
MD5(order::id + order.pieces::id) | key |
order::id | order_id |
package::id | package_id |
package::dimensions::resource::length | package_length |
package::dimensions::resource::lengthUnit | package_length_unit |
package::dimensions::resource::width | package_width |
package::dimensions::resource::widthUnit | package_width_unit |
package::dimensions::resource::height | package_height |
package::dimensions::resource::heightUnit | package_height_unit |
package::dimensions::resource::weight | package_weight |
package::dimensions::resource::weightUnit | package_weight_unit |
package::dimensions::resource::weightType | package_weight_type |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Package Weights
Endpoint: Order
Update Method: UPSERT
Table Name: [shipwire.package_weights]
JSON Element | Database Column |
---|---|
MD5(order::id + package::item::resource::amount + package::item::resource::units + package::item::resource::type) | key |
order::id | order_id |
package::id | package_id |
package::item::resource::amount | package_weight_amount |
package::item::resource::units | package_weight_unit |
package::item::resource::type | package_weight_type |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Package Trackings
Endpoint: Order
Update Method: UPSERT
Table Name: [
shipwire.package_trackings
]
JSON Element | Database Column |
---|---|
MD5(order::id + package::id + tracking::id) | key |
order::id | order_id |
package::id | package_id |
package::item::resource::id | tracking_id |
package::item::resource::tracking | tracking_number |
package::item::resource::carrier | carrier |
package::item::resource::carrierCode | carrier_code |
package::item::resource::url | tracking_url |
package::item::resource::summary | shipment_status |
package::item::resource::trackedDate | tracked_date |
package::item::resource::deliveredDate | delivered_date |
package::item::resource::createdDate | created_date |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Warehouses
Endpoint: Warehouse
Update Method: UPSERT
Table Name: [
shipwire.warehouses
]
JSON Element | Database Column |
---|---|
warehouse::id | id |
warehouse::name | name |
warehouse::code | code |
warehouse::isActive | is_active |
warehouse::latitude | latitude |
warehouse::longitude | longitude |
warehouse.address::address1 | address1 |
warehouse.address::address2 | address2 |
warehouse.address::address3 | address3 |
warehouse.address::city | city |
warehouse.address::state | state |
warehouse.address::postalCode | postal_code |
warehouse.address::country | country |
account_id | __account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Stocks
Endpoint: Stock
Update Method: UPSERT
Table Name: [
shipwire.stocks
]
JSON Element | Database Column |
---|---|
MD5(stock::warehouseId + stock::sku + stock::productId) | id |
stock::productId | product_id |
stock::sku | sku |
stock::isBundle | is_bundle |
stock::warehouseRegion | warehouse_region |
stock::warehouseId | warehouse_id |
stock::pending | pending |
stock::good | good |
stock::reserved | reserved |
stock::backordered | backordered |
stock::shipping | shipping |
stock::shipped | shipped |
stock::creating | creating |
stock::created | created |
stock::consuming | consuming |
stock::consumed | consumed |
stock::damaged | damaged |
stock::returned | returned |
stock::inreview | inreview |
stock::shippedLastDay | shipped_last_day |
stock::shippedLastWeek | shipped_last_week |
stock::shippedLast4Weeks | shipped_last_4weeks |
stock::orderedLastDay | ordered_last_day |
stock::orderedLastWeek | ordered_last_week |
stock::orderedLast4Weeks | ordered_last_4weeks |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Products
Endpoint: Product
Update Method: UPSERT
Table Name: [
shipwire.products
]
JSON Element | Database Column |
---|---|
product::id | id |
product::sku | sku |
product::description | description |
product::creationDate | creation_date |
product::status | status |
product::storageConfiguration | storage_configuration |
product::batteryConfiguration | battery_configuration |
product::classification | classification |
product::category | category |
product::itemCount | item_count |
costs::costValueCurrency | cost_value_currency |
costs::wholesaleValue | wholesale_value |
costs::costValue | cost_value |
costs:wholesaleValueCurrency | wholesale_value_currency |
costs::retailValue | retail_value |
costs::retailValueCurrency | retail_value_currency |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Receivings
Endpoint: Receiving
Update Method: UPSERT
Table Name: [
shipwire.receivings
]
JSON Element | Database Column |
---|---|
receiving::id | id |
receiving::orderNo | order_no |
receiving::transactionId | transaction_id |
receiving::commerceName | commerce_name |
receiving::lastUpdatedDate | last_updated_date |
receiving::status | status |
receiving.routing::warehouseId | warehouse_id |
receiving.routing::warehouseName | warehouse_name |
receiving.routing::originLongitude | origin_longitude |
receiving.routing::originLatitude | origin_latitude |
receiving.ship_from::email | |
receiving.ship_from::name | name |
receiving.ship_from::address1 | address1 |
receiving.ship_from::city | city |
receiving.ship_from::state | state |
receiving.ship_from::postalCode | postal_code |
receiving.ship_from::country | country |
receiving.events::createdDate | created_date |
receiving.events::pickedUpDate | picked_up_date |
receiving.events::submittedDate | submitted_date |
receiving.events::processedDate | processed_date |
receiving.events::completedDate | completed_date |
receiving.events::expectedDate | expected_date |
receiving.events::cancelledDate | cancelled_date |
receiving.events::returnedDate | returned_date |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Receiving Items
Endpoint: Receiving
Update Method: UPSERT
Table Name: [
shipwire.receiving_items
]
JSON Element | Database Column |
---|---|
receiving.items::id | id |
receving::id | receiving_id |
receiving.items::sku | sku |
receiving.items::quantity | quantity |
receiving.items::productId | product_id |
receiving.items::productExternalId | product_external_id |
receiving.items::orderId | order_id |
receiving.items::orderExternalId | order_external_id |
receiving.items::expected | expected |
receiving.items::pending | pending |
receiving.items::good | good |
receiving.items::inReview | in_review |
receiving.items::damaged | damaged |
account_id | _account_id |
Daasity: timestamp when loaded into DB | __synced_at |
Last updated