Integration Specifications

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

Integration Overview

Order Desk automates and streamlines order management workflow with integrations to hundreds of e-commerce services.

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 Order Desk extractor is built based on this Order Desk API documentation. The following endpoint is used by Daasity to replicate data from Order Desk:

Entity Relationship Diagram (ERD)

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

Order Desk Schema

The Daasity Order Desk 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: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.orders]

JSON Element
Database Column

id

id

email

email

shipping_method

shipping_method

quantity_total

quantity_total

weight_total

weight_total

product_total

product_total

shipping_total

shipping_total

handling_total

handling_total

tax_total

tax_total

discount_total

discount_total

order_total

order_total

cc_number_masked

cc_number_masked

cc_exp

cc_exp

processor_response

processor_response

payment_type, limit: 64

payment_type

payment_status, limit: 18

payment_status

processor_balance

processor_balance

refund_total

refund_total

customer_id

customer_id

email_count

email_count

ip_address

ip_address

source_name, limit: 64

source_name

fulfillment_name

fulfillment_name

fulfillment_id

fulfillment_id

folder_id

folder_id

date_added

date_added

date_updated

date_updated

shipping::first_name, limit: 64

shipping_first_name

shipping::last_name, limit: 64

shipping_last_name

shipping::company, limit: 64

shipping_company

shipping::address1

shipping_address1

shipping::address2

shipping_address2

shipping::address3

shipping_address3

shipping::address4

shipping_address4

shipping::city, limit: 64

shipping_city

shipping::state, limit: 2

shipping_state

shipping::postal_code, limit: 64

shipping_postal_code

shipping::country, limit: 64

shipping_country

shipping::phone, limit: 64

shipping_phone

customer::first_name, limit: 64

customer_first_name

customer::last_name, limit: 64

customer_last_name

customer::company, limit: 64

customer_company

customer::address1

customer_address1

customer::address2

customer_address2

customer::city

customer_city

customer::state, limit: 2

customer_state

customer::postal_code, limit: 64

customer_postal_code

customer::country, limit: 64

customer_country

customer::phone, limit: 64

customer_phone

return_address::title, limit: 64

return_address_title

return_address::name, limit: 64

return_address_name

return_address::company, limit: 64

return_address_company

return_address::address1

return_address_address1

return_address::address2

return_address_address2

return_address::city

return_address_city

return_address::state, limit: 2

return_address_state

return_address::postal_code, limit: 64

return_address_postal_code

return_address::country, limit: 64

return_address_country

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + source_id)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Checkout Data

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_checkout_data]

JSON Element
Database Column

MD5(id + checkout_data::first)

order_checkout_data_id

id

order_id

custom_data::first, limit: 4095

order_checkout_data_custom_key

custom_data::last, limit: 4095

order_checkout_data_custom_value

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + checkout_data::first)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Metadata

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_metadata]

JSON Element
Database Column

MD5(id + custom_data.first)

order_metadata_id

id

order_id

custom_data::first, limit: 4095

order_metadata_custom_key

custom_data::last, limit: 4095

order_metadata_custom_value

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + checkout_data::first)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Discount List

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_discount_list]

JSON Element
Database Column

MD5(id + discount::name + discount::amount)

order_discount_id

id

order_id

discount::name, limit: 64

name

discount::code, limit: 64

code

discount::amount

amount

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + discount::name + discount::amount)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Notes

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_notes]

JSON Element
Database Column

MD5(id + note::date_added + note::user_name + note::content)

order_note_id

id

order_id

note::date_added

date_added

note::user_name, limit: 64

user_name

note::content, limit: 64

content

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + note::date_added + note::user_name + note::content)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Items

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_items]

JSON Element
Database Column

MD5(id + item::id)

order_item_id

id

order_id

item::id

id

item::name

name

item::price

price

item::quantity

quantity

item::weight

weight

item::code, limit: 64

code

item::delivery_type, limit: 64

delivery_type

item::category_code, limit:64

category_code

item::metadata

metadata

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + item::id)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Items Variation List

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_items_variation_list]

JSON Element
Database Column

MD5(id + custom_data.first)

order_item_variation_id

id

order_id

custom_data::first, limit: 4095

order_item_variation_custom_key

custom_data::last, limit: 4095

order_item_variation_custom_value

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + custom_data.first)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Order Shipments

  • Endpoint: Orders

  • Update Method: UPSERT

  • Table Name: [order_desk.order_shipments]

JSON Element
Database Column

MD5(id + shipping::tracking_number + shipping::carrier_code)

order_shipment_id

id

order_id

shipping::tracking_number

tracking_number

shipping::carrier_code

carrier_code

shipping::shipment_method

shipment_method

shipping::weight

weight

shipping::cost

cost

shipping::status, limit: 32

status

shipping::tracking_url, limit: 4095

tracking_url

shipping::label_format, limit: 64

label_format

shipping::label_image

label_image

shipping::print_status, limit: 64

print_status

shipping::order_items

order_items

shipping::source, limit: 64

source

shipping::cart_shipment_id, limit: 64

cart_shipment_id

shipping::label_shipment_id, limit: 64

label_shipment_id

shipping::date_shipped

date_shipped

shipping::date_added

date_added

source_id, limit: 64

__source_id

Daasity: shop_id

__shop_id

seller_id

seller_id

marketplace_id

marketplace_id

Daasity: account_id

_account_id

Daasity: MD5(id + shipping::tracking_number + shipping::carrier_code)

__sync_key

Daasity: timestamp when loaded into DB

__synced_at

Last updated