• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsShopify

    Shopify

    The Shopify connector is a Palantir-provided driver for Shopify.

    To create a new Shopify source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Shopify-specific configuration and networking. For the complete property reference, see the official Shopify driver documentation ↗.

    Supported capabilities

    CapabilityStatus
    Exploration🟢 Generally available
    Batch syncs🟢 Generally available
    Incremental🟢 Generally available
    OAuth 2.0 authentication🟢 Generally available
    Table exports🟢 Generally available

    Configuration

    The properties below are mandatory or recommended.

    PropertyRequired?DescriptionDefault
    ShopURL ↗MandatoryThe full URL of your Shopify shop.https://{shopURL}
    AccessToken ↗RecommendedAdmin API Access Token for a custom app.—
    AuthScheme ↗RecommendedThe type of authentication to use when connecting to Shopify.AccessToken
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    OAuthClientId ↗RecommendedSpecifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.—
    OAuthClientSecret ↗RecommendedSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server.—
    Schema ↗RecommendedSpecify the Shopify server version to connect with.GRAPHQL-2024-07

    Networking

    The table below lists the domains that the source must be able to access to run.

    For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead. The agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.

    DomainRequired
    <ShopURL>Always. ShopURL connection property

    OAuth 2.0 authentication

    This connector supports OAuth 2.0 authentication. Follow the OAuth 2.0 guidance for Palantir-provided drivers to configure and authorize the connection.

    Table exports

    This connector supports table exports. Learn how to set up a table export.