feat(ds): shopify endpoint beta (#41933)

Author: andrewjmcgehee

posthog/temporal/data_imports/sources/shopify/constants.py

@@ -5,6 +5,8 @@
 from .queries.collections import COLLECTIONS_QUERY
 from .queries.customers import CUSTOMERS_QUERY
 from .queries.discount_nodes import DISCOUNT_NODES_QUERY
+from .queries.orders import ORDERS_QUERY
+from .queries.products import PRODUCTS_QUERY
 from .utils import ShopifyGraphQLObject
 
 SHOPIFY_API_VERSION = "2025-10"
@@ -36,6 +38,9 @@
 SHOP = "shop"
 SUBSCRIPTION_CONTRACTS = "subscriptionContracts"
 
+# graphql will reject the orders endpoint query for "complexity cost" if the page size is above ~35
+SHOPIFY_PAGE_SIZE_OVERRIDES = {ORDERS: 20}
+
 
 # NOTE: some of the permissions queries may seem random. not every field on a given graphql object
 # have the same access requirements
@@ -76,6 +81,16 @@
         display_name="discountCodes",
         permissions_query="{ discountNodes(first: 1) { nodes { id } } }",
     ),
+    ORDERS: ShopifyGraphQLObject(
+        name=ORDERS,
+        query=ORDERS_QUERY,
+        permissions_query="{ orders(first: 1) { nodes { id } } }",
+    ),
+    PRODUCTS: ShopifyGraphQLObject(
+        name=PRODUCTS,
+        query=PRODUCTS_QUERY,
+        permissions_query="{ products(first: 1) { nodes { id } } }",
+    ),
 }
 
 

posthog/temporal/data_imports/sources/shopify/queries/abandoned_checkouts.py

@@ -1,8 +1,9 @@
-from .fragments import KV_FRAGMENT, MAILING_ADDRESS_FRAGMENT, MONEY_BAG_FRAGMENT
+from .fragments import CUSTOMER_FRAGMENT, KV_FRAGMENT, MAILING_ADDRESS_FRAGMENT, MONEY_BAG_FRAGMENT
 
 ABANDONED_CHECKOUTS_SORTKEY = "CREATED_AT"
 
 # NOTE: 250 is the max allowable query size for line items
+# NOTE lineItems in abandonedCheckouts are not the same as the LineItem object
 ABANDONED_CHECKOUTS_QUERY = f"""
 query PaginatedAbandonedCheckouts($pageSize: Int!, $cursor: String, $query: String) {{
     abandonedCheckouts(
@@ -15,55 +16,7 @@
             completedAt
             createdAt
             customAttributes {KV_FRAGMENT}
-            customer {{
-                addresses {MAILING_ADDRESS_FRAGMENT}
-                amountSpent {{
-                    amount
-                    currencyCode
-                }}
-                createdAt
-                defaultAddress {MAILING_ADDRESS_FRAGMENT}
-                defaultEmailAddress {{
-                    emailAddress
-                    marketingOptInLevel
-                    marketingState
-                    marketingUpdatedAt
-                    openTrackingLevel
-                    validFormat
-                }}
-                defaultPhoneNumber {{
-                    marketingCollectedFrom
-                    marketingOptInLevel
-                    marketingState
-                    marketingUpdatedAt
-                    phoneNumber
-                }}
-                displayName
-                firstName
-                id
-                lastName
-                lastOrder {{
-                    id
-                    name
-                }}
-                legacyResourceId
-                lifetimeDuration
-                locale
-                multipassIdentifier
-                note
-                numberOfOrders
-                productSubscriberStatus
-                state
-                statistics {{
-                    predictedSpendTier
-                    rfmGroup
-                }}
-                tags
-                taxExempt
-                taxExemptions
-                updatedAt
-                verifiedEmail
-            }}
+            customer {CUSTOMER_FRAGMENT}
             discountCodes
             id
             lineItems(first: 250) {{

posthog/temporal/data_imports/sources/shopify/queries/fragments.py

@@ -1,3 +1,28 @@
+ID_NAME_FRAGMENT = """{
+    id
+    name
+}"""
+
+ID_NAME_CREATED_FRAGMENT = """{
+    id
+    name
+    createdAt
+}"""
+
+ID_NAME_CREATED_UPDATED_FRAGMENT = """{
+    id
+    name
+    createdAt
+    updatedAt
+}"""
+
+ID_TITLE_CREATED_UPDATED_FRAGMENT = """{
+    id
+    title
+    createdAt
+    updatedAt
+}"""
+
 NODE_CONNECTION_ID_FRAGMENT = """{
     nodes {
         id
@@ -18,11 +43,19 @@
     validFormat
 }"""
 
+FULFILLMENT_FRAGMENT = """{
+    id
+    name
+    createdAt
+    updatedAt
+}"""
+
 KV_FRAGMENT = """{
     key
     value
 }"""
 
+
 MAILING_ADDRESS_FRAGMENT = """{
     address1
     address2
@@ -79,3 +112,73 @@
     marketingUpdatedAt
     phoneNumber
 }"""
+
+TAX_LINES_FRAGMENT = f"""{{
+    priceSet {MONEY_BAG_FRAGMENT}
+    rate
+    ratePercentage
+    source
+    title
+}}"""
+
+LINE_ITEM_FRAGMENT = f"""{{
+    id
+    currentQuantity
+    customAttributes {KV_FRAGMENT}
+    discountedTotalSet {MONEY_BAG_FRAGMENT}
+    discountedUnitPriceSet {MONEY_BAG_FRAGMENT}
+    isGiftCard
+    name
+    nonFulfillableQuantity
+    originalTotalSet {MONEY_BAG_FRAGMENT}
+    originalUnitPriceSet {MONEY_BAG_FRAGMENT}
+    product {{
+        id
+    }}
+    quantity
+    refundableQuantity
+    requiresShipping
+    restockable
+    sku
+    taxable
+    taxLines(first: 250) {TAX_LINES_FRAGMENT}
+    title
+    totalDiscountSet {MONEY_BAG_FRAGMENT}
+    unfulfilledDiscountedTotalSet {MONEY_BAG_FRAGMENT}
+    unfulfilledOriginalTotalSet {MONEY_BAG_FRAGMENT}
+    unfulfilledQuantity
+    variant {{
+        id
+    }}
+    vendor
+}}"""
+
+CUSTOMER_FRAGMENT = f"""{{
+    addresses {MAILING_ADDRESS_FRAGMENT}
+    amountSpent {MONEY_V2_FRAGMENT}
+    createdAt
+    defaultAddress {MAILING_ADDRESS_FRAGMENT}
+    defaultEmailAddress {EMAIL_ADDRESS_FRAGMENT}
+    defaultPhoneNumber {PHONE_NUMBER_FRAGMENT}
+    displayName
+    firstName
+    id
+    lastName
+    lastOrder {ID_NAME_FRAGMENT}
+    lifetimeDuration
+    locale
+    multipassIdentifier
+    note
+    numberOfOrders
+    productSubscriberStatus
+    state
+    statistics {{
+        predictedSpendTier
+        rfmGroup
+    }}
+    tags
+    taxExempt
+    taxExemptions
+    updatedAt
+    verifiedEmail
+}}"""