Shopify

Creating the data source

⚠️ Important recommendation before starting

If you have access to more than one Shopify store, we strongly recommend that the entire process below be performed in an incognito / private browser window.

This prevents Shopify from using an already authenticated session and accidentally connecting to the wrong store during app creation or authorization.

Requirements

A Shopify Partners account (free)
You must be the store owner of your Shopify store

⚠️ Security: The Client Secret is a sensitive credential. Do not share it publicly.

Instructions

Create a Shopify Partners account

Go to accounts.shopify.com/signup and create your account. During signup:
- Choose "Create new Partner"
- Select the goal "Build Apps"
- Complete the registration with your information
Access the Dev Dashboard

After verifying your email, in the sidebar click App distribution → All apps → View Dev Dashboard.
Create a new app

In the Dev Dashboard, click Create app and set a name (e.g., "Kondado Integration").
Configure Redirect URL, scopes and publish the app

In the Redirect URLs field, enter:

https://app.kondado.com.br/sources/new/96

In Access > Scopes, copy and paste the following scopes:

read_analytics,read_app_proxy,read_assigned_fulfillment_orders,read_audit_events,read_customer_events,read_cart_transforms,read_all_cart_transforms,read_validations,read_cash_tracking,read_channels,read_checkout_branding_settings,read_checkouts,read_companies,read_custom_fulfillment_services,read_custom_pixels,read_customers,read_customer_data_erasure,read_customer_merge,read_delivery_customizations,read_price_rules,read_discounts,read_discounts_allocator_functions,read_discovery,read_draft_orders,write_files,read_fulfillment_constraint_rules,read_fulfillments,read_gift_card_transactions,read_gift_cards,read_inventory,read_inventory_shipments,read_inventory_shipments_received_items,read_inventory_transfers,read_legal_policies,read_delivery_option_generators,read_locales,write_locations,read_marketing_integrated_campaigns,read_marketing_events,read_markets,read_markets_home,read_merchant_managed_fulfillment_orders,read_metaobject_definitions,read_metaobjects,read_online_store_navigation,read_online_store_pages,read_order_edits,read_orders,read_packing_slip_templates,read_payment_terms,read_payment_customizations,read_pixels,read_privacy_settings,read_product_feeds,read_product_listings,read_products,read_publications,read_purchase_options,read_reports,read_resource_feedbacks,read_returns,read_script_tags,read_shopify_payments_provider_accounts_sensitive,read_shipping,read_shopify_payments_accounts,read_shopify_payments_payouts,read_shopify_payments_bank_accounts,read_shopify_payments_disputes,read_content,read_store_credit_account_transactions,read_store_credit_accounts,read_themes,read_third_party_fulfillment_orders,read_translations,customer_read_companies,customer_read_customers,customer_read_draft_orders,customer_read_markets,customer_read_orders,customer_read_quick_sale,customer_read_store_credit_account_transactions,customer_read_store_credit_accounts,unauthenticated_write_bulk_operations,unauthenticated_read_bulk_operations,unauthenticated_read_bundles,unauthenticated_read_checkouts,unauthenticated_read_customers,unauthenticated_read_customer_tags,unauthenticated_read_metaobjects,unauthenticated_read_product_pickup_locations,unauthenticated_read_product_inventory,unauthenticated_read_product_listings,unauthenticated_read_product_tags,unauthenticated_read_selling_plans,unauthenticated_read_shop_pay_installments_pricing,unauthenticated_read_content

Then click Release to publish the version.
Configure app distribution

In the left sidebar, go to the Distribution tab and select Custom distribution. This allows installing the app on specific stores.
Authorize the Shopify app and install on your store

After configuring distribution, you will need to enter your store domain to generate the installation authorization link.

To get your store domain, access the admin panel at admin.shopify.com. After logging in, on the Home page you will see your store domain. Copy this domain.

⚠️ Pay attention to the domain format:

Use only the domain in the format: example.myshopify.com

Do not include:
- Prefixes like https:// or http://
- Additional paths or parameters, such as /new_store, ?param=...
Incorrect examples:
- https://example.myshopify.com
- example.myshopify.com/new_store
With the link generated by Shopify, copy and paste it in your browser to be directed to the installation.

Now choose the store to install your app.

Click Install.
Copy the app credentials

Return to the Dev Dashboard, open your app and go to Settings. Copy:
- Client ID
- Client Secret
Connect on Kondado

At app.kondado.com.br/sources/new/96, fill in:
- Client ID
- Client Secret
- Store domain
Click Next and then connect with Shopify.

Note: The Shopify authorization screen may appear again at this step. If this happens, click Install to proceed.
Save the connection

After authorization, you will be redirected to Kondado. Click Save to finish.

Pipelines

Summary

Abandoned Checkouts
Abandoned Checkouts: discount codes
Abandoned Checkouts: line items
Abandoned Checkouts: note attributes
Customers
Events
Inventory: items
Order timeline events
Orders
Orders Details
Orders Discount Applications
Orders Discount Codes
Orders Fulfillments
Orders Line Items
Orders Line Items: custom properties
Orders Note Attributes
Orders Refunds
Orders Shipping Lines
Orders Transactions
Orders Visits UTM Parameters
Products
Products: images
Products: options
Products: variants

Relationship chart

Click to expand

Abandoned Checkouts

This pipeline requires at least the following scopes:

read_customers
read_inventory
read_marketplace_orders
read_orders
read_products

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

customer_default_address_customer_id → Customers > customer_id

Campo	Tipo
id	text	[en] The ID for the checkout.
abandoned_checkout_url	text	[en] The recovery URL that's sent to a customer so they can recover their checkout.
billing_address_address1	text	[en] The street address of the billing address.
billing_address_address2	text	[en] An optional additional field for the street address of the billing address.
billing_address_city	text	[en] The city of the billing address.
billing_address_company	text	[en] The company of the person associated with the billing address.
billing_address_country	text	[en] The name of the country of the billing address.
billing_address_country_code	text	[en] The two-letter code (ISO 3166-1 alpha-2 format) for the country of the billing address.
billing_address_first_name	text	[en] The first name of the person associated with the payment method.
billing_address_last_name	text	[en] The last name of the person associated with the payment method.
billing_address_latitude	float	[en] The latitude of the billing address.
billing_address_longitude	float	[en] The longitude of the billing address.
billing_address_name	text	[en] The full name of the person associated with the payment method.
billing_address_phone	text	[en] The phone number at the billing address.
billing_address_province	text	[en] The name of the state or province of the billing address.
billing_address_province_code	text	[en] The two-letter abbreviation of the state or province of the billing address.
billing_address_zip	text	[en] The zip or postal code of the billing address.
cart_token	text	[en] The ID for the cart that's attached to the checkout.
completed_at	timestamp	[en] The date and time (ISO 8601 format) when the checkout was completed. For abandoned checkouts, this value is null until a customer completes the checkout using the recovery URL.
created_at	timestamp	[en] The date and time (ISO 8601 format) when the checkout was created.
currency	text	[en] The three-letter code (ISO 4217 format) of the shop's default currency at the time of checkout. For the currency that the customer used at checkout, see presentment_currency.
customer_admin_graphql_api_id	text
customer_created_at	timestamp
customer_default_address_province	text
customer_default_address_address1	text
customer_default_address_address2	text
customer_default_address_city	text
customer_default_address_company	text
customer_default_address_country	text
customer_default_address_country_code	text
customer_default_address_country_name	text
customer_default_address_customer_id	text	Customers > > customer_id
customer_default_address_first_name	text
customer_default_address_id	text	Customers > > customer_id
customer_default_address_last_name	text
customer_default_address_name	text
customer_default_address_phone	text
customer_default_address_province_code	text
customer_default_address_zip	text
customer_email	text
customer_first_name	text
customer_id	text	Customers > > customer_id
customer_last_name	text
customer_last_order_id	text
customer_last_order_name	text
customer_multipass_identifier	text
customer_note	text
customer_orders_count	float
customer_phone	text
customer_sms_marketing_consent	text
customer_state	text
customer_tags	text
customer_tax_exempt	boolean
customer_tax_exemptions	text
customer_total_spent	float
customer_updated_at	timestamp
customer_verified_email	boolean
customer_locale	text	[en] The two or three-letter language code, optionally followed by a region modifier. Example values: en, en-CA.
name	text
note	text	[en] The text of an optional note that a shop owner can attach to the order.
presentment_currency	text	[en] The three-letter code (ISO 4217 format) of the currency that the customer used at checkout. For the shop's default currency, see currency.
shipping_address_address1	text	[en] The street address of the shipping address.
shipping_address_address2	text	[en] An optional additional field for the street address of the shipping address.
shipping_address_city	text	[en] The city of the shipping address.
shipping_address_company	text	[en] The company of the person associated with the shipping address.
shipping_address_country	text
shipping_address_country_code	text	[en] The two-letter code (ISO 3166-1 alpha-2 format) for the country of the shipping address.
shipping_address_first_name	text	[en] The first name of the person associated with the shipping address.
shipping_address_last_name	text	[en] The last name of the person associated with the shipping address.
shipping_address_latitude	float	[en] The latitude of the shipping address.
shipping_address_longitude	float	[en] The longitude of the shipping address.
shipping_address_name	text	[en] The full name of the person associated with the shipping address.
shipping_address_phone	text	[en] The phone number at the shipping address.
shipping_address_province	text	[en] The name of the state or province of the shipping address.
shipping_address_province_code	text	[en] The two-letter abbreviation of the state or province of the shipping address.
shipping_address_zip	text	[en] The zip or postal code of the shipping address.
subtotal_price	float	[en] The price of the checkout in presentment currency before shipping and taxes.
taxes_included	boolean	[en] Whether taxes are included in the price.
total_discounts	float	[en] The total amount of discounts to be applied in presentment currency.
total_duties	text	[en] The total duties of the checkout in presentment currency.
total_line_items_price	float	[en] The sum of the prices of all line items in the checkout in presentment currency.
total_price	float	[en] The sum of line item prices, all discounts, shipping costs, and taxes for the checkout in presentment currency.
total_tax	float	[en] The sum of all the taxes applied to the checkout in presentment currency.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the checkout was last modified.

Abandoned Checkouts: discount codes

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

checkout_id → Abandoned Checkouts > id

Campo

Tipo

checkout_id

text

[en] The ID for the checkout.

Abandoned Checkouts > > id

discount_codes_amount

float

[en] The amount of the discount in presentment currency.

discount_codes_code

text

[en] The discount code.

Abandoned Checkouts: line items

This pipeline requires at least the following scopes:

read_assigned_fulfillment_orders
read_inventory
read_locations
read_marketplace_fulfillment_orders
read_marketplace_orders
read_markets_home
read_merchant_managed_fulfillment_orders
read_orders
read_products
read_third_party_fulfillment_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

checkout_id → Abandoned Checkouts > id
variant_id → Products: variants > id

Campo	Tipo
checkout_id	text	[en] The ID for the checkout. Abandoned Checkouts > > id
compare_at_price	float
gift_card	boolean
grams	float	[en] The weight of the item in grams
key	text
line_price	float
presentment_title	text
presentment_variant_title	text
price	float	[en] The price of the item in presentment currency
product_id	text	[en] The product ID od the item
quantity	float	[en] The number of products that were purchased
sku	text	[en] A unique identifier for the item in the shop
taxable	boolean
title	text	[en] The title of the product
variant_id	text	[en] The product variant ID of item Products: variants > > id
variant_price	float
variant_title	text	[en] The title of the product variant
vendor	text	[en] The name of the item's supplier

Abandoned Checkouts: note attributes

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

checkout_id → Abandoned Checkouts > id

Campo	Tipo
checkout_id	float	[en] The ID for the checkout. Abandoned Checkouts > > id
note_attributes_name	text
note_attributes_value	text

Campo

Tipo

checkout_id

float

[en] The ID for the checkout.

Abandoned Checkouts > > id

note_attributes_name

text

note_attributes_value

text

Customers

This pipeline requires at least the following scopes:

read_customers
read_marketplace_orders
read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Campo	Tipo
customer_id	text	[en] A unique identifier for the customer.
accepts_marketing	boolean	[en] Whether the customer has consented to receive marketing material by email.
accepts_marketing_updated_at	timestamp	[en] when the customer consented or objected to receiving marketing material by email.
created_at	timestamp	[en] The date and time (ISO 8601 format) when the customer was created.
currency	text	[en] The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order.
default_address_address1	text	[en] The customer's mailing address.
default_address_address2	text	[en] An additional field for the customer's mailing address.
default_address_city	text	[en] The customer's city, town, or village.
default_address_company	text	[en] The customer's company.
default_address_country	text	[en] The customer's country.
default_address_country_code	text	[en] The two-letter country code corresponding to the customer's country.
default_address_country_name	text	[en] The customer's normalized country name.
default_address_customer_id	text	[en] A unique identifier for the customer.
default_address_default	boolean	[en] Whether this address is the default address for the customer.
default_address_first_name	text	[en] The customer's first name.
default_address_id	text	[en] A unique identifier for the address.
default_address_last_name	text	[en] The customer's last name.
default_address_name	text	[en] The customer's first and last names.
default_address_phone	text	[en] The customer's phone number at this address.
default_address_province	text	[en] The customer's region name. Typically a province, a state, or a prefecture.
default_address_province_code	text	[en] The code for the region of the address, such as the province, state, or district.
default_address_zip	text	[en] The customer's postal code, also known as zip, postcode, Eircode, etc.
email	text	[en] The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.
email_marketing_consent_consent_updated_at	timestamp	[en] The date and time when the customer consented to receive marketing material by email.
email_marketing_consent_opt_in_level	text	[en] The marketing subscription opt-in level, as described in the M3AAWG Sender Best Common Practices, that the customer gave when they consented to receive marketing material by email.
email_marketing_consent_state	text	[en] The current email marketing state for the customer.
first_name	text	[en] The customer's first name.
last_name	text	[en] The customer's last name.
last_order_id	text	[en] The ID of the customer's last order.
last_order_name	text	[en] The name of the customer's last order. This is directly related to the name field on the Order resource.
marketing_opt_in_level	text
multipass_identifier	text	[en] A unique identifier for the customer that's used with Multipass login.
note	text	[en] A note about the customer.
orders_count	float	[en] The number of orders associated with this customer. Test and archived orders aren't counted.
state	text
tags	text	[en] Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.
tax_exempt	boolean	[en] Whether the customer is exempt from paying taxes on their order.
total_spent	float	[en] The total amount of money that the customer has spent across their order history.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the customer information was last updated.
verified_email	boolean	[en] Whether the customer has verified their email address.

Events

This pipeline requires at least the following scopes:

read_customers
read_products
read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

subject_id → Products > id
subject_id → Orders > id

Campo	Tipo
event_id	text	[en] The ID of the event.
arguments	text	[en] Refers to a certain event and its resources.
author	text
created_at	timestamp	[en] The date and time when the event was created.
message	text	[en] A human readable description of the event. Can contain some HTML formatting.
path	text	[en] A relative URL to the resource the event is for, if applicable.
subject_id	text	[en] The ID of the resource that generated the event. Products > > id Orders > > id
subject_type	text	[en] The type of the resource that generated the event.
verb	text	[en] The type of event that occurred. Different resources generate different types of event.

Inventory: items

This pipeline requires at least the following scopes:

read_inventory
read_locations

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

inventory_item_id → Products: variants > inventory_item_id

Campo	Tipo
inventory_item_id	text	[en] The ID for the inventory item. Products: variants > > inventory_item_id
available	float	[en] The available quantity of an inventory item at the inventory level's associated location. Returns null if the inventory item is not tracked.
location_id	text	[en] A comma-separated list of location IDs.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the inventory level was last modified.

Order timeline events

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
event_id	text	[en] The ID of the event.
order_id	text	[en] The ID of the order that generated the event. Orders > > id
arguments	text	[en] Refers to a certain event and its resources.
author	text
created_at	timestamp	[en] The date and time when the event was created.
description	text	[en] A human readable description of the event.
message	text	[en] A human readable description of the event. Can contain some HTML formatting.
path	text	[en] A relative URL to the resource the event is for, if applicable.
verb	text	[en] The type of event that occurred. Different resources generate different types of event.

Orders

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_customers
read_apps
read_locations

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Campo	Tipo
id	text	[en] The ID of the order, used for API purposes. This is different from the order_number property, which is the ID used by the shop owner and customer
app_id	text	[en] The ID of the app that created the order.
browser_ip	text	[en] The IP address of the browser used by the customer when they placed the order
buyer_accepts_marketing	boolean	[en] Whether the customer consented to receive email updates from the shop
cancel_reason	text	[en] The reason why the order was canceled. Valid values:customer: The customer canceled the order. fraud: The order was fraudulent. inventory: Items in the order were not in inventory. declined: The payment was declined. other: A reason not in this list.
cancelled_at	timestamp	[en] The date and time when the order was canceled - in order's timezone
closed_at	timestamp	[en] The date and time when the order was closed - in order's timezone
confirmed	boolean
contact_email	text
created_at	timestamp	[en] The autogenerated date and time when the order was created in Shopify - in order's timezone
currency	text	[en] The three-letter code (ISO 4217 format) for the shop currency.
currentsubtotalpricepresentmentamount	float
currentsubtotalpricepresentmentcurrency	text
currentsubtotalpriceshopamount	float
currentsubtotalpriceshopcurrency	text
current_total_discounts	float	[en] The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds
currenttotaldiscountspresentmentamount	float
currenttotaldiscountspresentmentcurrency	text
currenttotaldiscountsshopamount	float
currenttotaldiscountsshopcurrency	text
currenttotaldutiespresentmentamount	float
currenttotaldutiespresentmentcurrency	text
currenttotaldutiesshopamount	float
currenttotaldutiesshopcurrency	text
current_total_price	float	[en] The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds
currenttotalpricepresentmentamount	float
currenttotalpricepresentmentcurrency	text
currenttotalpriceshopamount	float
currenttotalpriceshopcurrency	text
current_total_tax	float	[en] The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds
currenttotaltaxpresentmentamount	float
currenttotaltaxpresentmentcurrency	text
currenttotaltaxshopamount	float
currenttotaltaxshopcode	text
customer_locale	text	[en] The two or three-letter language code, optionally followed by a region modifier
email	text	[en] The customer's email address
financial_status	text	[en] The status of payments associated with the order. Can only be set when the order is created. Valid values: pending: The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully; authorized: The payments have been authorized; partially_paid: The order have been partially paid; paid: The payments have been paid; partially_refunded: The payments have been partially refunded; refunded: The payments have been refunded; voided: The payments have been voided
fulfillment_status	text	[en] The order's status in terms of fulfilled line items. Valid values:fulfilled: Every line item in the order has been fulfilled.; empty: None of the line items in the order have been fulfilled.; partial: At least one line item in the order has been fulfilled.; restocked: Every line item in the order has been restocked and the order canceled.
gateway	text	[en] The payment gateway used
landing_site	text	[en] The URL for the page where the buyer landed when they entered the shop.
landing_site_ref	text	[en] The URL of the webpage where the customer clicked a link that sent them to your online store
location_id	text	[en] The ID of the physical location where the order was processed. This property refers to the POS location. location_id will always be set to empty for online orders
name	text	[en] The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings. This is different from the id property, which is the ID of the order used by the API.
note	text	[en] An optional note that a shop owner can attach to the order.
order_number	text	[en] The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001
order_status_url	text	[en] The URL where the customer can check the order`s current status.
originaltotaldutiespresentmentamount	float
originaltotaldutiespresentmentcurrency	text
originaltotaldutiesshopamount	float
originaltotaldutiesshopcurrency	text
phone	text	[en] The customer's phone number for receiving SMS notifications
presentment_currency	text	[en] The presentment currency that was used to display prices to the customer
processed_at	timestamp	[en] The date and time when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports. By default, it matches the created_at value. If you're importing orders from an app or another platform, then you can set processed_at to a date and time in the past to match when the original order was created - in order's timezone
referring_site	text	[en] The website where the customer clicked a link to the shop
source_identifier	text
source_name	text	[en] Where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for Shopify channels are protected and cannot be assigned by other API clients: web, pos, shopify_draft_order, iphone, and android. Orders created via the API can be assigned any other string of your choice. If unspecified, then new orders are assigned the value of your app's ID
source_url	text	[en] The URL of the source that the order originated from, if found in the domain registry.
subtotal_price	float	[en] The price of the order in the shop currency after discounts but before shipping, taxes, and tips
subtotalpricepresentmentamount	float
subtotalpricepresentmentcurrency	text
subtotalpriceshopamount	float
subtotalpriceshopcurrency	text
tags	text	[en] Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length
taxes_included	boolean	[en] Whether taxes are included in the order subtotal
test	boolean	[en] Whether this is a test order
total_discounts	float	[en] The total discounts applied to the price of the order in the shop currency
totaldiscountspresentmentamount	float
totaldiscountspresentmentcurrency	text
totaldiscountsshopamount	float
totaldiscountsshopcurrency	text
total_line_items_price	float	[en] The sum of all line item prices in the shop currency
totallineitemspricepresentmentamount	float
totallineitemspricepresentmentcurrency	text
totallineitemspriceshopamount	float
totallineitemspriceshopcurrency	text
total_outstanding	float	[en] The total outstanding amount of the order in the shop currency
total_price	float	[en] The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive
totalpricepresentmentamount	float
totalpricepresentmentcurrency	text
totalpriceshopamount	float
totalpriceshopcurrency	text
totalshippingpricepresentmentamount	float
totalshippingpricepresentmentcurrency	text
totalshippingpriceshopamount	float
totalshippingpriceshopcurrency	text
total_tax	float	[en] The sum of all the taxes applied to the order in th shop currency. Must be positive)
totaltaxpresentmentamount	float
totaltaxpresentmentcurrency	text
totaltaxshopamount	float
totaltaxshopcurrency	text
total_tip_received	float	[en] The sum of all the tips in the order in the shop currency
total_weight	float	[en] The sum of all line item weights in grams
updated_at	timestamp	[en] The date and time when the order was last modified. This value can change when no visible fields of an order have been updated

Orders Details

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_customers
read_apps
read_locations
read_marketing_events

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id
customer_id → Customers > customer_id

Campo	Tipo
order_id	text	Orders > > id
billing_address_address1	text
billing_address_address2	text
billing_address_city	text
billing_address_company	text
billing_address_country	text
billing_address_country_code	text
billing_address_first_name	text
billing_address_last_name	text
billing_address_latitude	text
billing_address_longitude	text
billing_address_name	text
billing_address_phone	text
billing_address_province	text
billing_address_province_code	text
billing_address_zip	text
customer_accepts_marketing	boolean
customer_accepts_marketing_updated_at	timestamp
customer_created_at	timestamp	[en] The date and time (ISO 8601 format) when the customer was created.
customer_default_address_address1	text	[en] The customer's mailing address.
customer_default_address_address2	text	[en] An additional field for the customer's mailing address.
customer_default_address_city	text	[en] The customer's city, town, or village.
customer_default_address_company	text	[en] The customer's company.
customer_default_address_country	text	[en] he customer's country.
customer_default_address_country_code	text	[en] The two-letter country code corresponding to the customer's country.
customer_default_address_country_name	text	[en] The customer's normalized country name.
customer_default_address_customer_id	text	[en] A unique identifier for the customer.
customer_default_address_default	boolean	[en] Whether this address is the default address for the customer.
customer_default_address_first_name	text	[en] The customer's first name.
customer_default_address_id	text	[en] A unique identifier for the address.
customer_default_address_last_name	text	[en] The customer's last name.
customer_default_address_name	text	[en] The customer's first and last names.
customer_default_address_phone	text	[en] The customer's phone number at this address.
customer_default_address_province	text	[en] The customer's region name. Typically a province, a state, or a prefecture.
customer_default_address_province_code	text	[en] The code for the region of the address.
customer_default_address_zip	text
customer_email	text
customer_first_name	text
customer_id	text	Customers > > customer_id
customer_last_name	text
customer_last_order_id	text
customer_last_order_name	text
customer_multipass_identifier	text
customer_note	text
customer_orders_count	float	[en] The number of orders associated with this customer. Test and archived orders aren't counted.
customer_phone	text
customer_state	text	[en] The state of the customer's account with a shop.
customer_tags	text
customer_tax_exempt	boolean
customer_tax_exemptions	text
customer_total_spent	float	[en] The total amount of money that the customer has spent across their order history.
customer_updated_at	timestamp	[en] The date and time (ISO 8601 format) when the customer information was last updated.
customer_verified_email	boolean	[en] Whether the customer has verified their email address.
payment_gateway_names	text
shipping_address_address1	text
shipping_address_address2	text
shipping_address_city	text
shipping_address_company	text
shipping_address_country	text
shipping_address_country_code	text
shipping_address_first_name	text
shipping_address_last_name	text
shipping_address_latitude	float
shipping_address_longitude	float
shipping_address_name	text
shipping_address_phone	text
shipping_address_province	text
shipping_address_province_code	text
shipping_address_zip	text

Orders Discount Applications

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
allocation_method	text
code	text
target_selection	text
target_type	text	[en] Whether the discount is applied on line items or shipping lines.
type	text
value	float	[en] The value of the discount application.
value_type	text

Orders Discount Codes

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
amount	float	[en] The amount that's deducted from the order total
code	text	[en] When the associated discount application is of type code, this property returns the discount code that was entered at checkout. Otherwise this property returns the title of the discount that was applied
type	text	[en] The type of discount: fixed_amount: Applies amount as a unit of the store's currency. For example, if amount is 30 and the store's currency is USD, then 30 USD is deducted from the order total when the discount is applied; percentage: Applies a discount of amount as a percentage of the order total; shipping: Applies a free shipping discount on orders that have a shipping rate less than or equal to amount. For example, if amount is 30, then the discount will give the customer free shipping for any shipping rate that is less than or equal to $30

Orders Fulfillments

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_fulfillments
read_locations

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
id	text	[en] Fulfillments id
created_at	timestamp	[en] The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed.
location_id	text
name	text
service	text
status	text	[en] Orders of a given fulfillment status.
tracking_company	text	[en] The name of the fulfillment service.
tracking_number	text	[en] The fulfillment's tracking number.
tracking_url	text
updated_at	timestamp	[en] A timestamp for when the fulfillment's was updated.

Orders Line Items

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_fulfillments
read_locations
read_products
read_inventory

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id
product_id → Products > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
id	text	[en] The ID of the line item.
fulfillment_status	text	[en] The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. Use
gift_card	boolean	[en] Returns true if the product associated with the line item is a gift card.
grams	float	[en] The weight of the line item in the store's default weight unit.
name	text
destination_location_address1	text
destination_location_address2	text
destination_location_city	text
destination_location_country_code	text
destination_location_id	text
destination_location_name	text
destination_location_province	text
destination_location_zip	text
origin_location_address1	text
origin_location_address2	text
origin_location_city	text
origin_location_country_code	text
origin_location_id	text
origin_location_name	text
origin_location_province	text
origin_location_zip	text
price	float
price_set_presentment_money_currency_code	text
price_set_presentment_money_amount	float
price_set_shop_money_currency_code	text
price_set_shop_money_amount	text
product_exists	boolean
product_id	text	[en] The ID of the line item's product. Products > > id
quantity	float	[en] The quantity of the line item.
requires_shipping	boolean	[en] Returns true if the variant associated with the line item requires shipping. Returns false if not.
sku	text	[en] The sku of the variant associated with the line item.
taxable	boolean	[en] Returns true if taxes should be charged on the line item. Returns false if not.
title	text	[en] The title of the line item. The title is a combination of line_item.product.title and line_item.variant.title, separated by a hyphen.
total_discount	float
total_discount_set_presentment_money_currency_code	text
total_discount_set_presentment_money_amount	float
total_discount_set_shop_money_currency_code	text
total_discount_set_shop_money_amount	float
variant_id	text	[en] The ID of the line item's variant.
variant_title	text
vendor	text	[en] The vendor of the variant associated with the line item.

Orders Line Items: custom properties

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id > properties → Orders Line Items > order_id
order_line_item_id > properties → Orders Line Items > id

Campo	Tipo
order_id	text	[en] Order id Orders Line Items > > order_id
order_line_item_id	text	[en] The ID of the line item. Orders Line Items > > id
property_name	text	[en] The name (key) of the property.
property_value	text	[en] The value of the property.

Orders Note Attributes

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo

Tipo

order_id

text

[en] Order id

Orders > > id

name

text

[en] Name/key of the additional detail about the order

value

text

[en] Value of the name/key of the additional detail about the order

Orders Refunds

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
id	text
created_at	timestamp
note	text
processed_at	timestamp

Orders Shipping Lines

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	text	[en] Order id Orders > > id
id	text	[en] shipping id
carrier_identifier	text	[en] A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
code	text	[en] A reference to the shipping method.
delivery_category	text
discounted_price	float	[en] The price of the shipping method after line-level discounts have been applied.
discounted_price_set_presentment_money_amount	float
discounted_price_set_presentment_money_currency_code	text
discounted_price_set_shop_money_currency_code	text
discounted_price_set_shop_money_amount	float
phone	text
price	float	[en] The price of this shipping method in the shop currency. Can't be negative.
price_set_presentment_money_amount	float
price_set_presentment_money_currency_code	text
price_set_shop_money_amount	float
price_set_shop_money_currency_code	text
requested_fulfillment_service_id	text	[en] A reference to the fulfillment service that is being requested for the shipping method.
source	text	[en] The source of the shipping method.
title	text	[en] The title of the shipping method.

Orders Transactions

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_customers
read_locations
read_payment_terms

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	float	[en] The ID for the order that the transaction is associated with. Orders > > id
transaction_id	float	[en] Transaction Id
amount	float	[en] The amount of money included in the transaction.
authorization	text	[en] The authorization code associated with the transaction.
created_at	timestamp	[en] The date and time when the transaction was created.
currency	text	[en] The three-letter code for the currency used for the payment.
error_code	text	[en] A standardized error code.
gateway	text	[en] The name of the gateway the transaction was issued through.
kind	text	[en] The transaction's type.
location_id	text	[en] The ID of the physical location where the transaction was processed.
parent_id	text	[en] The ID of an associated transaction.
processed_at	timestamp	[en] The date and time when a transaction was processed.
receipt_x_account_id	text
receipt_x_amount	float
receipt_x_currency	text
receipt_x_gateway_reference	text
receipt_x_reference	float
receipt_x_result	text
receipt_x_signature	text
receipt_x_test	text
receipt_x_timestamp	text
source_name	text	[en] The origin of the transaction.
status	text	[en] The status of the transaction.
test	boolean	[en] Whether the transaction is a test transaction.

Orders Visits UTM Parameters

Limitation: Shopify API limits order access to the last 60 days by default. For full history, request the read_all_orders scope in Partner Dashboard. See instructions.

This pipeline requires at least the following scopes:

read_orders
read_customers
read_marketing_events

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

order_id → Orders > id

Campo	Tipo
order_id	float	[en] The id of the order Orders > > id
utmparameters_campaign	text	[en] The name of a marketing campaign.
utmparameters_content	text	[en] Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective
utmparameters_medium	text	[en] The medium of a marketing campaign, such as a banner or email newsletter
utmparameters_source	text	[en] The source of traffic to the merchant's store, such as Google or an email newsletter
utmparameters_term	float	[en] Paid search terms used by a marketing campaign
occurred_at	timestamp	[en] The date and time when the customer's session occurred.

Products

This pipeline requires at least the following scopes:

read_products

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Campo	Tipo
id	text	[en] An unsigned 64-bit integer that's used as a unique identifier for the product.
body_html	text	[en] A description of the product. Supports HTML formatting.
created_at	timestamp	[en] The date and time (ISO 8601 format) when the product was created.
handle	text	[en] A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects.
image_alt	text
image_created_at	timestamp
image_height	float
image_id	text	[en] Id of the product's first image
image_position	float
image_src	text
image_updated_at	timestamp
image_width	float
product_type	text	[en] A categorization for the product used for filtering and searching products.
published_at	timestamp	[en] The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel.
published_scope	boolean	[en] Whether the product is published to the Point of Sale channel.
status	text	[en] The status of the product. Valid values: active, archived, draft
tags	text	[en] A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags.
template_suffix	text	[en] The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called 'product.suffix.liquid', where 'suffix' is the value of this property. If this property is or null, then the product page uses the default template 'product.liquid'. (default: null)
title	text	[en] The name of the product.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the product was last modified.
vendor	text	[en] The name of the product's vendor.

Products: images

This pipeline requires at least the following scopes:

read_products
read_product_listings

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

product_id → Products > id

Campo	Tipo
product_id	text	Products > > id
alt	text
created_at	timestamp
height	float
id	text
position	float
src	text
updated_at	timestamp
width	float

Products: options

This pipeline requires at least the following scopes:

read_products

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

product_id → Products > id

Campo	Tipo
product_id	text	[en] Product's id Products > > id
option_id	text	[en] Product option id
options_name	text
options_position	float
options_values	text

Products: variants

This pipeline requires at least the following scopes:

read_products
read_inventory
read_locations

Replication type: Incremental

Parameters:

Read start date (Savepoint): Start date to replicate data

Relationships:

product_id → Products > id

Campo	Tipo
product_id	text	[en] The id of the product Products > > id
id	text	[en] The unique numeric identifier for the product variant
inventory_item_id	text	[en] The unique identifier for the inventory item
sku	text	[en] A unique identifier for the product variant in the shop
barcode	text	[en] The barcode, UPC, or ISBN number for the product
compare_at_price	float	[en] The original price of the item before an adjustment or a sale
created_at	timestamp	[en] The date and time when the product variant was created
grams	float	[en] The weight of the product variant in grams
image_id	text	[en] The unique numeric identifier for a product's image
inventory_policy	text	[en] Whether customers are allowed to place an order for the product variant when it's out of stock
inventory_quantity	float	[en] An aggregate of inventory across all locations
option1	text	[en] The custom property #1 that a shop owner uses to define product variants
option2	text	[en] The custom property #2 that a shop owner uses to define product variants
option3	text	[en] The custom property #3 that a shop owner uses to define product variants
position	float	[en] The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed
price	float	[en] The price of the product variant
taxable	boolean	[en] Whether a tax is charged when the product variant is sold
title	text	[en] The title of the product variant. The title field is a concatenation of the option1, option2, and option3 fields
updated_at	timestamp	[en] The date and time when the product variant was last modified
weight	float	[en] The weight of the product variant in the unit system specified with weight_unit
weight_unit	text	[en] The unit of measurement that applies to the product variant's weight

Notes

Scopes

Some of the scopes required for each pipeline were identified with the help of artificial intelligence. Let us know if you find any inconsistencies

🔗⚠️ Warning: Protected Customer Data (PII)

Billing address (billing_address_*) and shipping address (shipping_address_*) fields are considered Protected Customer Data (PII - Level 2) by Shopify.

Availability by Shopify plan:

❌ Basic and Starter: Not available - fields will return NULL
✅ Grow, Shopify, Advanced, and Plus: Available

If you are on a Basic/Starter plan and need this data, you will need to upgrade your Shopify plan.

Source: Shopify Protected Customer Data Documentation

Requesting Full Order History Access

By default, Shopify API limits order access to the last 60 days. For full history, request the read_all_orders scope.

Steps:

Go to partners.shopify.com
Apps → [your app] → API access
Under "Access requests", click "Request access" on the "Read all orders scope" card
Describe your justification (e.g., "I need access to full order history for data integration")
Wait for Shopify approval (may take a few days)
Once approved, re-authorize the app in the Shopify store
Re-create integrations in Kondado

Note: This request must be made by the Partner app creator.

Part of this documentation was automatically generated by AI and may contain errors. We recommend verifying critical information