Shopify

Creating the data source

Method 1: Dev Dashboard (recommended)

This is the simplest way: no Shopify Partners account, redirect URL or installation link needed. The app is created from your own store admin.

Requirements: be the store owner or a staff member allowed to develop apps.

⚠️ Note: with this method Shopify only returns orders from the last 60 days (the read_all_orders scope is not available to apps created from the store Dev Dashboard). Products, customers, inventory and other objects have no such limit. If you need the full order history, use Method 2: Partner Dashboard.

In your store admin (admin.shopify.com), go to Settings > Apps > Develop apps and click Build apps in Dev Dashboard.
In the Dev Dashboard, click Create app and give it a name (e.g., "Kondado").
In Scopes, paste the list below and click Release (twice, to confirm):
read_all_cart_transforms,read_analytics,read_app_proxy,read_assigned_fulfillment_orders,read_audit_events,read_cart_transforms,read_cash_tracking,read_channels,read_checkout_branding_settings,read_checkouts,read_companies,read_content,read_custom_fulfillment_services,read_custom_pixels,read_customer_data_erasure,read_customer_events,read_customer_merge,read_customers,read_delivery_customizations,read_delivery_option_generators,read_discounts,read_discovery,read_draft_orders,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_locales,read_marketing_events,read_marketing_integrated_campaigns,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_customizations,read_payment_terms,read_pixels,read_price_rules,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_shipping,read_shopify_payments_accounts,read_shopify_payments_bank_accounts,read_shopify_payments_disputes,read_shopify_payments_payouts,read_shopify_payments_provider_accounts_sensitive,read_store_credit_account_transactions,read_store_credit_accounts,read_themes,read_third_party_fulfillment_orders,read_translations,read_validations
On the app page, click Install app, choose your store and click Install.
In Settings, copy the Client ID and the Client secret.
In Kondado, go to app.kondado.com.br/sources/new/96, choose the Dev Dashboard method, enter the store subdomain (e.g., my-store.myshopify.com), the Client ID and the Client secret and click Save.

⚠️ The Client secret is a sensitive credential. Do not share it publicly.

Method 2: Partner Dashboard (full order history)

Use this method if you need orders older than 60 days. It requires a Shopify Partners account and Shopify approval of the read_all_orders scope.

⚠️ 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.
⚠️ Can't see the Distribution tab?

This happens when the app was created with your store account (merchant) instead of a Shopify Partners account. The Distribution tab only exists for apps created within a Partner organization.

How to fix:
1. Open an incognito / private browser window
2. Create a free account at Shopify Partners (step 1 above)
3. Access the Dev Dashboard via: App distribution → All apps → View Dev Dashboard
4. Create the app again in this session
Important: The distribution method cannot be changed after selection. If you already chose "Custom distribution", you cannot switch to another method — you must create a new app from scratch if you need to change.
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

Abandoned checkouts represent shopping carts that customers started but did not complete, meaning checkouts that were never converted into orders. Each record captures the checkout's contents, totals, currency, customer and address details, and a recovery URL. A checkout stays abandoned while completed_at is null; once the customer finishes the purchase through the recovery URL, completed_at is populated.

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	[en] The GraphQL global ID (GID) of the customer.
customer_created_at	timestamp	[en] The date and time (ISO 8601 format) when the customer record was created.
customer_default_address_province	text	[en] The name of the state or province of the customer's default address.
customer_default_address_address1	text	[en] The street address of the customer's default address.
customer_default_address_address2	text	[en] An optional additional field for the street address of the customer's default address.
customer_default_address_city	text	[en] The city of the customer's default address.
customer_default_address_company	text	[en] The company of the customer's default address.
customer_default_address_country	text	[en] The name of the country of the customer's default address.
customer_default_address_country_code	text	[en] The two-letter code (ISO 3166-1 alpha-2 format) for the country of the customer's default address.
customer_default_address_country_name	text	[en] The normalized country name of the customer's default address.
customer_default_address_customer_id	text	[en] The ID of the customer that the default address belongs to. Customers > > customer_id
customer_default_address_first_name	text	[en] The first name of the person associated with the customer's default address.
customer_default_address_id	text	[en] The ID of the customer's default address. Customers > > customer_id
customer_default_address_last_name	text	[en] The last name of the person associated with the customer's default address.
customer_default_address_name	text	[en] The full name of the person associated with the customer's default address.
customer_default_address_phone	text	[en] The phone number at the customer's default address.
customer_default_address_province_code	text	[en] The two-letter abbreviation of the state or province of the customer's default address.
customer_default_address_zip	text	[en] The zip or postal code of the customer's default address.
customer_email	text	[en] The email address of the customer.
customer_first_name	text	[en] The customer's first name.
customer_id	text	[en] A unique identifier for the customer. Customers > > customer_id
customer_last_name	text	[en] The customer's last name.
customer_last_order_id	text	[en] The ID of the customer's last order.
customer_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.
customer_multipass_identifier	text	[en] A unique identifier for the customer that's used with Multipass login.
customer_note	text	[en] A note about the customer.
customer_orders_count	float	[en] The number of orders associated with this customer. Test and archived orders aren't counted.
customer_phone	text	[en] The unique phone number (E.164 format) for this customer.
customer_sms_marketing_consent	text	[en] The marketing consent information describing when and how the customer consented to receiving marketing material by SMS.
customer_state	text	[en] The state of the customer's account with the shop. Possible values include: disabled (the customer doesn't have an active account), invited (the customer has received an invite to create an account), enabled (the customer has created an account), and declined (the customer declined the invite to create an account).
customer_tags	text	[en] Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.
customer_tax_exempt	boolean	[en] Whether the customer is exempt from paying taxes on their orders.
customer_tax_exemptions	text	[en] The list of specific tax exemptions that apply to the customer (Canadian taxes only).
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.
customer_locale	text	[en] The two or three-letter language code, optionally followed by a region modifier. Example values: en, en-CA.
name	text	[en] A human-readable identifier for the checkout, shown as a number preceded by a # symbol.
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	[en] The name of the country of the shipping address.
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 the shop's 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 the shop's currency.
total_duties	text	[en] The total duties of the checkout, in the shop's currency.
total_line_items_price	float	[en] The sum of the prices of all line items in the checkout, in the shop's currency.
total_price	float	[en] The sum of line item prices, all discounts, shipping costs, and taxes for the checkout, in the shop's currency.
total_tax	float	[en] The sum of all the taxes applied to the checkout, in the shop's 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

Discount codes applied on the abandoned checkout.

Campo	Tipo
checkout_id	text	[en] The ID of the abandoned checkout to which this discount code belongs. Abandoned Checkouts > > id
discount_codes_amount	float	[en] The total discount amount applied to the abandoned checkout, expressed in the presentment currency (the currency shown to the customer at checkout). Monetary value reported as a decimal; when the checkout has more than one discount code, this checkout-level total is repeated on each code row.
discount_codes_code	text	[en] A discount code applied to the abandoned checkout (the code entered by the customer to claim the discount). When more than one code is applied to the same checkout, each code is reported on its own row.

Campo

Tipo

checkout_id

text

[en] The ID of the abandoned checkout to which this discount code belongs.

Abandoned Checkouts > > id

discount_codes_amount

float

[en] The total discount amount applied to the abandoned checkout, expressed in the presentment currency (the currency shown to the customer at checkout). Monetary value reported as a decimal; when the checkout has more than one discount code, this checkout-level total is repeated on each code row.

discount_codes_code

text

[en] A discount code applied to the abandoned checkout (the code entered by the customer to claim the discount). When more than one code is applied to the same checkout, each code is reported on its own row.

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

Line items of abandoned checkouts: each row is a product/variant added to a checkout that was never completed, with quantity, unit price, compare-at price, SKU, weight and variant details. Grain: one row per item of the abandoned checkout.

Campo	Tipo
checkout_id	text	[en] The unique identifier of the abandoned checkout this line item belongs to. Abandoned Checkouts > > id
compare_at_price	float	[en] The variant compare-at price: the original or reference unit price shown next to the selling price to indicate a discount, expressed in the store base currency. May be empty when no compare-at price is set.
gift_card	boolean	[en] Whether the product in this line item is a gift card. True for gift card products, false otherwise.
grams	float	[en] The weight of a single unit of the item, expressed in grams.
key	text	[en] A unique identifier for this line item within the abandoned checkout.
line_price	float	[en] The original unit price of the item, expressed in the customer presentment currency.
presentment_title	text	[en] The product title as presented to the customer.
presentment_variant_title	text	[en] The product variant title as presented to the customer.
price	float	[en] The original unit price of the item, expressed in the store base currency.
product_id	text	[en] The unique identifier of the product associated with this line item.
quantity	float	[en] The number of units of the item added to the checkout.
sku	text	[en] The stock keeping unit (SKU) of the item: a merchant-defined code that identifies the product variant.
taxable	boolean	[en] Whether the item is subject to taxes. True when taxes apply to the item, false otherwise.
title	text	[en] The title of the product associated with this line item.
variant_id	text	[en] The unique identifier of the product variant associated with this line item. Products: variants > > id
variant_price	float	[en] The variant compare-at price: its original or reference unit price in the store base currency. May be empty when no compare-at price is set.
variant_title	text	[en] The title of the product variant associated with this line item.
vendor	text	[en] The name of the product vendor or 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

Abandoned checkout note attributes (name/value pairs).

Campo	Tipo
checkout_id	float	[en] The ID of the abandoned checkout that this note attribute belongs to; links each name/value pair back to its checkout. Abandoned Checkouts > > id
note_attributes_name	text	[en] Key (name) of a custom name/value attribute attached to the abandoned checkout. These are free-form fields defined by the store or its apps to store extra information collected during checkout (for example a gift message label, a delivery instruction, or an additional address field). The set of possible names is not fixed and varies by store.
note_attributes_value	text	[en] Text value associated with the corresponding attribute name for the abandoned checkout. Content is free-form and defined by the store or its apps; it has no fixed format or enumerated set of values.

Campo

Tipo

checkout_id

float

[en] The ID of the abandoned checkout that this note attribute belongs to; links each name/value pair back to its checkout.

Abandoned Checkouts > > id

note_attributes_name

text

[en] Key (name) of a custom name/value attribute attached to the abandoned checkout. These are free-form fields defined by the store or its apps to store extra information collected during checkout (for example a gift message label, a delivery instruction, or an additional address field). The set of possible names is not fixed and varies by store.

note_attributes_value

text

[en] Text value associated with the corresponding attribute name for the abandoned checkout. Content is free-form and defined by the store or its apps; it has no fixed format or enumerated set of values.

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

Store customers: contact, addresses, total spent, order count and marketing consent.

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] The date and time 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 that this address belongs to.
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 on this address.
default_address_id	text	[en] A unique identifier for the address.
default_address_last_name	text	[en] The customer's last name on this address.
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. Possible values: single_opt_in, confirmed_opt_in, and unknown.
email_marketing_consent_state	text	[en] The current email marketing state for the customer. Possible values: subscribed, not_subscribed, pending, and unsubscribed.
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	[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. Possible values: single_opt_in, confirmed_opt_in, and unknown.
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	[en] The state of the customer account with the shop. Possible values: disabled (the account has never been created), invited (the customer has been emailed an invite to create an account), enabled (the customer has created an account), and declined (the customer declined the invite to create an account).
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, in the shop currency.
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

Store events: log of actions that happened on objects (orders, products, etc.), with type, description and date.

Campo	Tipo
event_id	text	[en] The unique identifier of the event.
arguments	text	[en] Values referenced by the event message, such as an order number, a customer name or a resource title. Provided by the API as a list.
author	text	[en] Who originated the event: the name of a staff member, the store name, or "Shopify" when the event was generated automatically by the system.
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, such as links to the related resource.
path	text	[en] A relative URL to the resource the event refers to, when applicable. May be empty for events without a navigable resource.
subject_id	text	[en] The ID of the resource that generated the event (for example the related order, product or price rule). Products > > id Orders > > id
subject_type	text	[en] The type of resource that generated the event, such as Order, Product, Collection, PriceRule or Article.
verb	text	[en] The action described by the event. Different resources emit different actions, such as create, update, destroy, confirmed, cancelled, closed, placed, published or unpublished.

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

Inventory items: unit cost, tracked-or-not, and per-SKU data used for per-location stock control.

Campo	Tipo
inventory_item_id	text	[en] The unique identifier of the inventory item. Each inventory item corresponds to a single product variant and is used to track its stock. Products: variants > > inventory_item_id
available	float	[en] The available (sellable) quantity of the inventory item. Returns null when the item is not set to track inventory.
location_id	text	[en] The ID of the location associated with this inventory record. Each row represents one inventory item at a single stock location.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the inventory level at this location 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

Data source created with the Dev Dashboard method: Shopify only returns orders created in the last 60 days. Older orders are not brought. For the full history, create the data source with the Partner Dashboard method (read_all_orders scope).

Replication type: Incremental

Parameters:

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

Relationships:

order_id → Orders > id

Store events: log of actions that happened on objects (orders, products, etc.), with type, description and date.

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] Values referencing the resources involved in the event (such as the names of items or collections), presented as a single text.
author	text	[en] Who generated the event. Can be the platform itself for automated/system events, or the name of the staff member or app responsible for the action.
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 action represented by the event. Covers the order lifecycle (e.g. placed, confirmed, closed, cancelled), payments (e.g. sale, paid, paid externally), fulfillment (e.g. fulfilled, shipping label purchased, items restocked), returns (e.g. goods returned, return approved) and manual notes (comment), among others. 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

Store orders (completed checkout): customer, totals, financial and fulfillment status, discounts, currency and order attributes. Grain: one row per order.

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	[en] Whether the order has been confirmed
contact_email	text	[en] The customer's contact email address used for the order
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	[en] The current subtotal of the order (reflecting order edits, returns, and refunds), expressed in the presentment currency shown to the customer at checkout
currentsubtotalpricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the current subtotal
currentsubtotalpriceshopamount	float	[en] The current subtotal of the order (reflecting order edits, returns, and refunds), expressed in the shop's default currency
currentsubtotalpriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the current subtotal
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	[en] The current total discounts of the order (reflecting order edits, returns, and refunds), expressed in the presentment currency shown to the customer at checkout
currenttotaldiscountspresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the current total discounts
currenttotaldiscountsshopamount	float	[en] The current total discounts of the order (reflecting order edits, returns, and refunds), expressed in the shop's default currency
currenttotaldiscountsshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the current total discounts
currenttotaldutiespresentmentamount	float	[en] The current total duties (import taxes) of the order (reflecting order edits, returns, and refunds), expressed in the presentment currency shown to the customer at checkout
currenttotaldutiespresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the current total duties
currenttotaldutiesshopamount	float	[en] The current total duties (import taxes) of the order (reflecting order edits, returns, and refunds), expressed in the shop's default currency
currenttotaldutiesshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the current total duties
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	[en] The current total price of the order (reflecting order edits, returns, and refunds), expressed in the presentment currency shown to the customer at checkout
currenttotalpricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the current total price
currenttotalpriceshopamount	float	[en] The current total price of the order (reflecting order edits, returns, and refunds), expressed in the shop's default currency
currenttotalpriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the current total price
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	[en] The current total tax of the order (reflecting order edits, returns, and refunds), expressed in the presentment currency shown to the customer at checkout
currenttotaltaxpresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the current total tax
currenttotaltaxshopamount	float	[en] The current total tax of the order (reflecting order edits, returns, and refunds), expressed in the shop's default currency
currenttotaltaxshopcode	text	[en] The three-letter ISO 4217 currency code of the shop currency for the current total tax
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	[en] The original total duties (import taxes) of the order at the time it was created, expressed in the presentment currency shown to the customer at checkout
originaltotaldutiespresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the original total duties
originaltotaldutiesshopamount	float	[en] The original total duties (import taxes) of the order at the time it was created, expressed in the shop's default currency
originaltotaldutiesshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the original total duties
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	[en] The ID of the order placed on the originating platform or channel. This value does not correspond to the Shopify ID that is generated from a completed draft order
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	[en] The order subtotal (after discounts, before shipping, taxes, and tips), expressed in the presentment currency shown to the customer at checkout
subtotalpricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the subtotal
subtotalpriceshopamount	float	[en] The order subtotal (after discounts, before shipping, taxes, and tips), expressed in the shop's default currency
subtotalpriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the subtotal
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	[en] The total discounts applied to the order, expressed in the presentment currency shown to the customer at checkout
totaldiscountspresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the total discounts
totaldiscountsshopamount	float	[en] The total discounts applied to the order, expressed in the shop's default currency
totaldiscountsshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the total discounts
total_line_items_price	float	[en] The sum of all line item prices in the shop currency
totallineitemspricepresentmentamount	float	[en] The sum of all line item prices in the order, expressed in the presentment currency shown to the customer at checkout
totallineitemspricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the total line items price
totallineitemspriceshopamount	float	[en] The sum of all line item prices in the order, expressed in the shop's default currency
totallineitemspriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the total line items price
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	[en] The total price of the order (line items, discounts, shipping, taxes, and tips), expressed in the presentment currency shown to the customer at checkout
totalpricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the total price
totalpriceshopamount	float	[en] The total price of the order (line items, discounts, shipping, taxes, and tips), expressed in the shop's default currency
totalpriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the total price
totalshippingpricepresentmentamount	float	[en] The total shipping cost of the order, expressed in the presentment currency shown to the customer at checkout
totalshippingpricepresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the total shipping price
totalshippingpriceshopamount	float	[en] The total shipping cost of the order, expressed in the shop's default currency
totalshippingpriceshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the total shipping price
total_tax	float	[en] The sum of all the taxes applied to the order in the shop currency. Must be positive
totaltaxpresentmentamount	float	[en] The total tax applied to the order, expressed in the presentment currency shown to the customer at checkout
totaltaxpresentmentcurrency	text	[en] The three-letter ISO 4217 currency code of the presentment currency for the total tax
totaltaxshopamount	float	[en] The total tax applied to the order, expressed in the shop's default currency
totaltaxshopcurrency	text	[en] The three-letter ISO 4217 currency code of the shop currency for the total tax
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

Customer data attached to the order (snapshot captured at purchase time).

Campo	Tipo
order_id	text	[en] The order's unique numeric identifier assigned by Shopify. Orders > > id
billing_address_address1	text	[en] The street address of the billing address associated with the order's payment method.
billing_address_address2	text	[en] An additional line of the billing address, such as an apartment, suite, or unit.
billing_address_city	text	[en] The city, town, or village of the billing address.
billing_address_company	text	[en] The company or organization name of the billing address.
billing_address_country	text	[en] The full country name of the billing address.
billing_address_country_code	text	[en] The two-letter country code of the billing address, in ISO 3166-1 alpha-2 format (e.g. BR, US).
billing_address_first_name	text	[en] The first name of the person associated with the billing address.
billing_address_last_name	text	[en] The last name of the person associated with the billing address.
billing_address_latitude	text	[en] The latitude coordinate of the billing address.
billing_address_longitude	text	[en] The longitude coordinate of the billing address.
billing_address_name	text	[en] The full name (first and last) of the person associated with the billing address.
billing_address_phone	text	[en] The phone number of the billing address.
billing_address_province	text	[en] The name of the region (such as a state, province, or prefecture) of the billing address.
billing_address_province_code	text	[en] The abbreviated code of the region (such as a state or province) of the billing address (e.g. SP).
billing_address_zip	text	[en] The postal or ZIP code of the billing address.
customer_accepts_marketing	boolean	[en] Whether the customer has consented to receive marketing material by email.
customer_accepts_marketing_updated_at	timestamp	[en] The date and time (ISO 8601 format) when the customer's marketing consent was last updated.
customer_created_at	timestamp	[en] The date and time (ISO 8601 format) when the customer was created.
customer_default_address_address1	text	[en] The street address of the customer's default address.
customer_default_address_address2	text	[en] An additional line of the customer's default address, such as an apartment, suite, or unit.
customer_default_address_city	text	[en] The city, town, or village of the customer's default address.
customer_default_address_company	text	[en] The company or organization name of the customer's default address.
customer_default_address_country	text	[en] The full country name of the customer's default address.
customer_default_address_country_code	text	[en] The two-letter country code of the customer's default address, in ISO 3166-1 alpha-2 format (e.g. BR, US).
customer_default_address_country_name	text	[en] The normalized full country name of the customer's default address.
customer_default_address_customer_id	text	[en] The unique identifier of the customer that this default address belongs to.
customer_default_address_default	boolean	[en] Whether this address is the customer's default address.
customer_default_address_first_name	text	[en] The first name of the person at the customer's default address.
customer_default_address_id	text	[en] The unique identifier of the customer's default address.
customer_default_address_last_name	text	[en] The last name of the person at the customer's default address.
customer_default_address_name	text	[en] The full name (first and last) of the person at the customer's default address.
customer_default_address_phone	text	[en] The phone number of the customer's default address.
customer_default_address_province	text	[en] The name of the region (such as a state, province, or prefecture) of the customer's default address.
customer_default_address_province_code	text	[en] The abbreviated code of the region (such as a state or province) of the customer's default address (e.g. RJ).
customer_default_address_zip	text	[en] The postal or ZIP code of the customer's default address.
customer_email	text	[en] The email address of the customer.
customer_first_name	text	[en] The first name of the customer.
customer_id	text	[en] The unique identifier of the customer. Customers > > customer_id
customer_last_name	text	[en] The last name of the customer.
customer_last_order_id	text	[en] The unique identifier of the customer's most recent order.
customer_last_order_name	text	[en] The name (order number, such as #1001) of the customer's most recent order.
customer_multipass_identifier	text	[en] The unique identifier used by the customer to log in with Multipass.
customer_note	text	[en] A free-form note that the merchant has attached to the customer.
customer_orders_count	float	[en] The number of orders associated with this customer. Test and archived orders aren't counted.
customer_phone	text	[en] The phone number of the customer, in E.164 format.
customer_state	text	[en] The state of the customer's account with the shop. Possible values include: 'disabled', 'invited', 'enabled', and 'declined'.
customer_tags	text	[en] A comma-separated list of tags applied to the customer for categorization and filtering.
customer_tax_exempt	boolean	[en] Whether the customer is exempt from paying taxes on their orders.
customer_tax_exemptions	text	[en] A list of tax exemption codes applied to the customer (for example, regional or status-based exemptions).
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	[en] The list of payment gateways used to process the order's transactions.
shipping_address_address1	text	[en] The street address of the shipping address where the order is delivered.
shipping_address_address2	text	[en] An additional line of the shipping address, such as an apartment, suite, or unit.
shipping_address_city	text	[en] The city, town, or village of the shipping address.
shipping_address_company	text	[en] The company or organization name of the shipping address.
shipping_address_country	text	[en] The full country name of the shipping address.
shipping_address_country_code	text	[en] The two-letter country code of the shipping address, in ISO 3166-1 alpha-2 format (e.g. BR, US).
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 coordinate of the shipping address.
shipping_address_longitude	float	[en] The longitude coordinate of the shipping address.
shipping_address_name	text	[en] The full name (first and last) of the person associated with the shipping address.
shipping_address_phone	text	[en] The phone number of the shipping address.
shipping_address_province	text	[en] The name of the region (such as a state, province, or prefecture) of the shipping address.
shipping_address_province_code	text	[en] The abbreviated code of the region (such as a state or province) of the shipping address (e.g. SP).
shipping_address_zip	text	[en] The postal or ZIP code of the shipping address.

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

Discounts applied to the order (by code, automatic or manual) with type, target and granted value.

Campo	Tipo
order_id	text	[en] The ID of the order to which this discount application belongs. Orders > > id
allocation_method	text	[en] How the discount amount is distributed across the lines it applies to. Possible values include ACROSS (the amount is spread proportionally across all entitled lines), EACH (the amount is applied to each entitled line individually) and ONE (the amount is applied a single time).
code	text	[en] Identifier of the discount applied to the order. For code-based discounts this is the discount code entered at checkout; for manual, script-based or automatic discounts it carries the name/title of the discount instead. Empty when the discount has no associated code or title.
target_selection	text	[en] Which lines of the order the discount applies to. Possible values include ALL (every line is eligible), ENTITLED (only the lines that meet the discount conditions) and EXPLICIT (only specific lines explicitly chosen for the discount).
target_type	text	[en] Whether the discount targets the products or the shipping of the order. Possible values include LINE_ITEM (the discount applies to product line items) and SHIPPING_LINE (the discount applies to shipping).
type	text	[en] The kind/origin of the discount application. Possible values include DiscountCodeApplication (a discount triggered by a code entered at checkout), ManualDiscountApplication (a discount applied manually by the merchant), ScriptDiscountApplication (a discount applied by a Shopify Script) and AutomaticDiscountApplication (a discount applied automatically by a store rule).
value	float	[en] The magnitude of the discount. When value_type is fixed_amount this is a monetary amount in the shop currency; when value_type is percentage this is the percentage of the price that is discounted.
value_type	text	[en] Indicates how the value field should be interpreted. Possible values are fixed_amount (the discount is a monetary amount in the shop currency) and percentage (the discount is a percentage of the price).

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

Discount codes used on the order, with the amount granted by each code.

Campo	Tipo
order_id	text	[en] The ID of the order to which this discount code belongs. Orders > > id
amount	float	[en] The magnitude of the discount applied through this code. When type is fixed_amount this is a monetary value in the shop currency that is deducted from the order; when type is percentage this is the percentage of the order that is discounted.
code	text	[en] The discount identifier applied to the order. For code-based discounts this is the discount code entered at checkout; for manual or script-based discounts it carries the discount title instead. May be empty for automatic discounts that have no associated code or title.
type	text	[en] How the discount amount should be interpreted. Possible values are fixed_amount (amount is a monetary value in the shop currency that is deducted from the order) and percentage (amount is the percentage of the order that is discounted).

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

Order fulfillments (shipments): shipped items, tracking number, carrier and delivery status.

Campo	Tipo
order_id	text	[en] Identifier of the order that this fulfillment belongs to. Orders > > id
id	text	[en] Unique identifier of the fulfillment, assigned by the platform.
created_at	timestamp	[en] Date and time when the fulfillment was created (ISO 8601 format, with time zone offset).
location_id	text	[en] Identifier of the location from which the items are fulfilled (e.g. the warehouse or store).
name	text	[en] Human-readable name of the fulfillment, derived from the order number (e.g. the order name followed by a fulfillment sequence).
service	text	[en] Fulfillment service handling the shipment (e.g. manual or a third-party logistics provider).
status	text	[en] Current status of the fulfillment. Possible values include: pending, open, success, cancelled, error and failure.
tracking_company	text	[en] Name of the shipping carrier responsible for transporting the shipment (e.g. the postal or courier service).
tracking_number	text	[en] Tracking number provided by the carrier for the shipment.
tracking_url	text	[en] URL where the shipment can be tracked on the carrier site.
updated_at	timestamp	[en] Date and time when the fulfillment was last updated (ISO 8601 format, with time zone offset).

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
variant_id → Products: variants > id

Order line items: each purchased product/variant, with quantity, unit price, discounts and taxes. Grain: one row per item of the order.

Campo	Tipo
order_id	text	[en] ID of the parent order this line item belongs to. Orders > > id
id	text	[en] The ID of the line item (unique identifier of the item within the order).
fulfillment_status	text	[en] The line item's fulfillment status. One of: 'fulfilled' (the whole quantity has been fulfilled/shipped), 'partial' (only part of the quantity has been fulfilled), or null/empty (nothing fulfilled yet).
gift_card	boolean	[en] Returns true if the product associated with the line item is a gift card.
grams	float	[en] The weight of a single unit of the line item, in grams.
name	text	[en] The name of the product, including the variant, as it appears on the order — a combination of the product title and the variant title, separated by a hyphen.
destination_location_address1	text	[en] First address line of the destination location: where the line item is shipped to.
destination_location_address2	text	[en] Second/complementary address line of the destination location (where the line item is shipped to).
destination_location_city	text	[en] City of the destination location (where the line item is shipped to).
destination_location_country_code	text	[en] Two-letter ISO 3166-1 alpha-2 country code of the destination location.
destination_location_id	text	[en] Identifier of the destination location (where the line item is shipped to).
destination_location_name	text	[en] Name of the destination location (where the line item is shipped to).
destination_location_province	text	[en] State/province (name or code) of the destination location.
destination_location_zip	text	[en] Postal/ZIP code of the destination location.
origin_location_address1	text	[en] First address line of the origin location: where the line item is shipped from.
origin_location_address2	text	[en] Second/complementary address line of the origin location (where the line item is shipped from).
origin_location_city	text	[en] City of the origin location (where the line item is shipped from).
origin_location_country_code	text	[en] Two-letter ISO 3166-1 alpha-2 country code of the origin location.
origin_location_id	text	[en] Identifier of the origin location (where the line item is shipped from).
origin_location_name	text	[en] Name of the origin location (where the line item is shipped from).
origin_location_province	text	[en] State/province (name or code) of the origin location.
origin_location_zip	text	[en] Postal/ZIP code of the origin location.
price	float	[en] The price of the line item per unit, in the shop currency, before discounts and taxes.
price_set_presentment_money_currency_code	text	[en] Currency code (ISO 4217) of the unit price expressed in the presentment currency (the currency shown to the customer).
price_set_presentment_money_amount	float	[en] Unit price amount expressed in the presentment currency (the currency shown to the customer).
price_set_shop_money_currency_code	text	[en] Currency code (ISO 4217) of the unit price expressed in the shop currency.
price_set_shop_money_amount	text	[en] Unit price amount expressed in the shop currency.
product_exists	boolean	[en] Returns true if the product associated with the line item still exists in the store; false if it has been deleted.
product_id	text	[en] The ID of the line item's product. Products > > id
quantity	float	[en] The number of units of this line item that were ordered.
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 (stock keeping unit) 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, a combination of the product title and the variant title, separated by a hyphen.
total_discount	float	[en] The total amount of discounts allocated to this line item, in the shop currency.
total_discount_set_presentment_money_currency_code	text	[en] Currency code (ISO 4217) of the total line item discount expressed in the presentment currency.
total_discount_set_presentment_money_amount	float	[en] Total line item discount amount expressed in the presentment currency.
total_discount_set_shop_money_currency_code	text	[en] Currency code (ISO 4217) of the total line item discount expressed in the shop currency.
total_discount_set_shop_money_amount	float	[en] Total line item discount amount expressed in the shop currency.
variant_id	text	[en] The ID of the line item's product variant. Products: variants > > id
variant_title	text	[en] The title of the product variant associated with the line item (for example, the size or color).
vendor	text	[en] The vendor of the product/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

Custom properties per line item (shop-defined name/value pairs, e.g., engraving, note).

Campo	Tipo
order_id	text	[en] Identifier of the order that contains the line item this custom property belongs to Orders Line Items > > order_id
order_line_item_id	text	[en] Identifier of the line item (product/variant entry within the order) that carries this custom property Orders Line Items > > id
property_name	text	[en] Name/key of a custom property attached to the line item, defined by the store or theme (e.g. engraving text, gift message, custom color, bundle component or subscription detail)
property_value	text	[en] Value paired with the corresponding name/key of the custom property attached to the line item

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

Additional order note attributes (name/value pairs defined by the shop or checkout).

Campo	Tipo
order_id	text	[en] Identifier of the order this custom attribute belongs to Orders > > id
name	text	[en] Name/key of a custom name/value attribute attached to the order by the store or theme (e.g. gift message, delivery date, custom checkout field)
value	text	[en] Value paired with the corresponding name/key of the custom attribute attached to the order

Campo

Tipo

order_id

text

[en] Identifier of the order this custom attribute belongs to

Orders > > id

name

text

[en] Name/key of a custom name/value attribute attached to the order by the store or theme (e.g. gift message, delivery date, custom checkout field)

value

text

[en] Value paired with the corresponding name/key of the custom attribute attached to 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

Order refunds: total or partial reversals, with refunded items, amounts and reason. Grain: one row per refund.

Campo	Tipo
order_id	text	[en] The ID of the order that the refund belongs to. Orders > > id
id	text	[en] The unique identifier of the refund.
created_at	timestamp	[en] The date and time when the refund was created.
note	text	[en] An optional note attached to the refund, typically describing the reason for or details of the refund.
processed_at	timestamp	[en] The date and time when the refund was processed. This is the timestamp used as the effective date of the refund in reports.

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

Order shipping lines: shipping method, charged price and shipping taxes.

Campo	Tipo
order_id	text	[en] The id of the order that this shipping line belongs to. Orders > > id
id	text	[en] A unique identifier for this shipping line.
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; otherwise it may be empty.
code	text	[en] A reference code identifying the shipping rate, as defined by the shipping service or carrier.
delivery_category	text	[en] The general classification of the delivery method for this shipping line, for example a standard shipment versus a local delivery. Often empty.
discounted_price	float	[en] The price of this shipping line after line-level discounts have been applied, in the shop currency.
discounted_price_set_presentment_money_amount	float	[en] The discounted price of this shipping line in the presentment currency (the currency shown to the customer at checkout).
discounted_price_set_presentment_money_currency_code	text	[en] The ISO 4217 currency code of the presentment money for the discounted shipping price (the currency shown to the customer at checkout).
discounted_price_set_shop_money_currency_code	text	[en] The ISO 4217 currency code of the shop money for the discounted shipping price (the default currency of the store).
discounted_price_set_shop_money_amount	float	[en] The discounted price of this shipping line in the shop currency (the default currency of the store).
phone	text	[en] The phone number associated with this shipping line, when provided, used by some carriers as a delivery contact. Often empty.
price	float	[en] The price of this shipping line before discounts, in the shop currency. Cannot be negative.
price_set_presentment_money_amount	float	[en] The price of this shipping line before discounts, in the presentment currency (the currency shown to the customer at checkout).
price_set_presentment_money_currency_code	text	[en] The ISO 4217 currency code of the presentment money for the shipping price (the currency shown to the customer at checkout).
price_set_shop_money_amount	float	[en] The price of this shipping line before discounts, in the shop currency (the default currency of the store).
price_set_shop_money_currency_code	text	[en] The ISO 4217 currency code of the shop money for the shipping price (the default currency of the store).
requested_fulfillment_service_id	text	[en] A reference to the fulfillment service requested for this shipping method.
source	text	[en] The source of the shipping rate, i.e. the channel or application that generated it (such as the online store at checkout or a third-party shipping app).
title	text	[en] The title of the shipping method as shown to the customer at checkout (for example, the carrier or rate name).

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

Order financial transactions (authorization, capture, refund, void) with amount, gateway, payment method and status.

Campo	Tipo
order_id	float	[en] The ID for the order that the transaction is associated with. Orders > > id
transaction_id	float	[en] The unique identifier of the transaction.
amount	float	[en] The amount of money included in the transaction, in the shop currency.
authorization	text	[en] The authorization code returned by the payment provider for the transaction.
created_at	timestamp	[en] The date and time when the transaction was created.
currency	text	[en] The three-letter ISO 4217 code for the currency used in the transaction.
error_code	text	[en] A standardized error code, present when the transaction fails (e.g. incorrect_number, card_declined, expired_card, processing_error).
gateway	text	[en] The name of the payment gateway the transaction was processed through.
kind	text	[en] The transaction type. One of: authorization (reserves the amount), sale (authorization plus capture), capture (collects an amount previously authorized), void (cancels an authorization) and refund (reverses a previously captured amount).
location_id	text	[en] The ID of the physical location where the transaction was processed, when applicable (e.g. point of sale).
parent_id	text	[en] The ID of an associated transaction — for example, the authorization that a capture, void or refund relates to.
processed_at	timestamp	[en] The date and time when the transaction was processed by the gateway.
receipt_x_account_id	text	[en] Gateway-specific receipt field: the payment account identifier reported by the gateway. The contents of the receipt vary depending on which gateway processed the transaction.
receipt_x_amount	float	[en] Gateway-specific receipt field: the transaction amount as reported by the payment gateway.
receipt_x_currency	text	[en] Gateway-specific receipt field: the three-letter currency code reported by the gateway.
receipt_x_gateway_reference	text	[en] Gateway-specific receipt field: the gateway's own reference identifier for the transaction.
receipt_x_reference	float	[en] Gateway-specific receipt field: the reference identifier the gateway associates with the transaction.
receipt_x_result	text	[en] Gateway-specific receipt field: the result reported by the gateway for the transaction (e.g. 'completed', 'pending').
receipt_x_signature	text	[en] Gateway-specific receipt field: the signature/hash returned by the gateway to validate the receipt authenticity.
receipt_x_test	text	[en] Gateway-specific receipt field: indicates whether the gateway processed the transaction in test mode.
receipt_x_timestamp	text	[en] Gateway-specific receipt field: the timestamp the gateway recorded for the transaction.
source_name	text	[en] The origin/sales channel of the transaction (e.g. 'web' for the online store, 'pos' for point of sale, or an identifier of the app/sales channel).
status	text	[en] The status of the transaction. One of: success, failure, pending and error.
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

Order UTM source parameters (campaign, source, medium, term, content) extracted from the session landing site.

Campo	Tipo
order_id	float	[en] The unique identifier of the order these UTM parameters are associated with Orders > > id
utmparameters_campaign	text	[en] The name of the marketing campaign that drove the visit (utm_campaign parameter), such as a seasonal promotion or product launch
utmparameters_content	text	[en] Identifies specific content in a marketing campaign (utm_content parameter). Used to differentiate between similar content or links within the same campaign to determine which is the most effective
utmparameters_medium	text	[en] The medium through which the visit reached the store (utm_medium parameter), such as a banner, email newsletter, cost-per-click (cpc) or social network
utmparameters_source	text	[en] The source of the traffic that brought the visitor to the merchant's store (utm_source parameter), such as a search engine, a social network or an email newsletter
utmparameters_term	float	[en] The paid search terms associated with the marketing campaign (utm_term parameter), typically the keywords of a paid search ad
occurred_at	timestamp	[en] The date and time when the customer's session that generated these UTM parameters 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

Store catalog products: title, type, vendor, tags, status and publishing 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	[en] Alternative text describing the product's featured (first) image, used for accessibility and SEO. Can be empty.
image_created_at	timestamp	[en] The date and time (ISO 8601 format) when the product's featured (first) image was created.
image_height	float	[en] Height of the product's featured (first) image, in pixels.
image_id	text	[en] Unique identifier of the product's featured (first) image.
image_position	float	[en] Position of this image in the product's image gallery, starting at 1 (position 1 is the featured image).
image_src	text	[en] Public URL of the product's featured (first) image.
image_updated_at	timestamp	[en] The date and time (ISO 8601 format) when the product's featured (first) image was last modified.
image_width	float	[en] Width of the product's featured (first) image, in pixels.
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] Indicates whether the product is published to the Point of Sale (POS) channel in addition to the online store.
status	text	[en] The status of the product. Common 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

Product images: URL, gallery position and variants associated with each image.

Campo	Tipo
product_id	text	[en] Unique identifier of the product this image belongs to. Products > > id
alt	text	[en] Alternative text describing the image, used for accessibility and SEO. Can be empty.
created_at	timestamp	[en] The date and time (ISO 8601 format) when the image was added to the product.
height	float	[en] Height of the image, in pixels.
id	text	[en] Unique identifier of the product image.
position	float	[en] Position of this image within the product's image gallery, starting at 1 (position 1 is the featured image).
src	text	[en] Public URL where the product image is hosted.
updated_at	timestamp	[en] The date and time (ISO 8601 format) when the image was last updated.
width	float	[en] Width of the image, in pixels.

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

Product options (e.g., size, color) and their possible values.

Campo	Tipo
product_id	text	[en] Identifier of the product this option belongs to. Products > > id
option_id	text	[en] Unique identifier of the product option.
options_name	text	[en] Name/label of the product option, such as Size, Color or Material. Products that do not have configured options carry a single default option named "Title" whose value is "Default Title".
options_position	float	[en] Ordinal position of this option within the product, starting at 1. A product can have up to three options, so this value ranges from 1 to 3 and defines the order in which the options are presented.
options_values	text	[en] List of the possible values this option can take (e.g. for a Size option: P, M, G; for a Color option: Black, Brown), serialized as text. Each combination of option values across the product's options corresponds to one product variant.

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

Product variants: SKU, price, compare-at price, barcode, weight, inventory and selected options.

Campo	Tipo
product_id	text	[en] The unique numeric identifier of the parent product that this variant belongs to Products > > id
id	text	[en] The unique numeric identifier for the product variant
inventory_item_id	text	[en] The unique numeric identifier of the inventory item associated with the variant, used to track stock
sku	text	[en] The stock keeping unit (SKU): a code that identifies the product variant in the shop's inventory. Can be empty
barcode	text	[en] The barcode, UPC, or ISBN number of the product variant. Can be empty
compare_at_price	float	[en] The original (reference) price of the variant before a discount or sale, in the shop's currency. Empty when there is no comparison price
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 of the product image associated with the variant. Empty when no image is assigned
inventory_policy	text	[en] Whether customers can place an order for the variant when it is out of stock. One of: 'deny' (block ordering) or 'continue' (allow ordering)
inventory_quantity	float	[en] The total quantity of the variant in stock, aggregated across all locations
option1	text	[en] The value of the product's first option (for example a size or color) for this variant. Defaults to 'Default Title' when the product has no options
option2	text	[en] The value of the product's second option for this variant. Empty when the product has fewer than two options
option3	text	[en] The value of the product's third option for this variant. Empty when the product has fewer than three options
position	float	[en] The position of the variant in the product's list of variants, starting at 1
price	float	[en] The selling price of the product variant, in the shop's currency
taxable	boolean	[en] Whether a tax is charged when the product variant is sold
title	text	[en] The title of the product variant, formed by concatenating the option1, option2, and option3 values
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 defined by weight_unit
weight_unit	text	[en] The unit of measurement for the variant's weight. One of: 'g', 'kg', 'oz', or 'lb'

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

Written by

Thassyo Pereira·Published 2023-06-16·Updated 2025-05-09