shopify_pro_sdk library
shopify_pro_sdk — Enterprise-grade Flutter SDK for Shopify Storefront API.
Developed and maintained by Abrar Ali — NEURALXCIPHER (PRIVATE) LIMITED https://neuralxcipher.com
Classes
- AuthRepository
- AuthService
-
High-level auth API exposed via
ShopifyClient.auth. - CacheTtl
- Time-to-live configuration attached to a cache entry.
- Cart
- Represents a Shopify Storefront Cart (Cart API, 2022-01+).
- CartAttribute
- A custom key-value attribute on a cart line.
- CartCost
- The cost breakdown of a Shopify cart.
- CartDiscountAllocation
- An applied discount on a cart line.
- CartDiscountCode
- An applied discount code on a cart.
- CartLine
- A single line item inside a Shopify cart.
- CartLineAttribute
- A cart-level key-value attribute.
- CartLineInput
- Input for adding a new line to the cart.
- CartLineUpdateInput
- Input for updating an existing cart line quantity.
- CartRepository
- CartService
-
High-level cart API exposed via
ShopifyClient.cart. - Checkout
-
Lightweight checkout representation — the Cart API's
checkoutUrlhandles the actual checkout flow in a browser / WebView. - CheckoutRepository
- CheckoutService
-
High-level checkout API exposed via
ShopifyClient.checkout. - Collection
- A Shopify storefront collection of products.
- CollectionRepository
- CollectionService
- High-level collection API exposed on ShopifyClient.collections.
- Customer
- Represents an authenticated Shopify customer.
- CustomerAccessToken
- Represents a Shopify customer access token with its expiry time.
- CustomerAddress
- A shipping/billing address associated with a Shopify customer.
- CustomerOrder
- An order placed by an authenticated customer.
- CustomerRepository
- CustomerService
-
High-level customer profile API exposed via
ShopifyClient.customer. - Debouncer
- Collapses rapid successive calls into a single deferred execution.
- GraphQLEngine
- Core GraphQL execution engine.
- GraphQLError
-
Represents a single error entry from the GraphQL
errorsarray. - GraphQLErrorLocation
- Line/column reference within a GraphQL document.
- GraphQLRequest
- Immutable GraphQL request payload.
- GraphQLRequestBuilder
- Fluent builder for constructing GraphQLRequest instances.
-
GraphQLResponse<
T> - Typed result returned by the GraphQL engine for every query and mutation.
- Metafield
- Represents a Shopify metafield attached to any resource.
- OrderLineItem
- A single line item within a customer order.
- PaginationArgs
- Standard arguments for forward cursor pagination.
- PredictiveSearchResult
- A single predictive search suggestion (product, collection, or query).
- Product
- Full representation of a Shopify Storefront product.
- ProductImage
- A single image associated with a Shopify product or variant.
- ProductOption
- A selectable option on a Shopify product (e.g. Size, Color).
- ProductPriceRange
- Min/max price range for a product across all variants.
- ProductRepository
- Defines the data-access contract for the products feature.
- ProductSeo
- SEO metadata for a product.
- ProductService
- High-level product API exposed on ShopifyClient.products.
- ProductVariant
- A specific purchasable variant of a Shopify product.
- QueryCost
- Shopify Storefront API query cost (useful for rate-limit budgeting).
- SearchRepository
- SearchResult
- A unified search result that may contain products, collections, or pages.
- SearchService
-
High-level search API exposed via
ShopifyClient.search. - SelectedOption
- A key-value pair representing a chosen option on a variant (e.g. Size: Large).
- SellingPlan
- A single selling plan (e.g. "Subscribe and Save 10% — Monthly").
- SellingPlanGroup
- A group of selling plans (subscriptions / deferred purchase options).
- ShopifyCacheManager
- Thread-safe two-tier cache used by the GraphQL engine.
- ShopifyClient
- The primary entry-point for the shopify_pro_sdk.
- ShopifyConfig
- All configuration required to connect to a Shopify store.
- ShopifyLogger
- Singleton logger used throughout the SDK.
-
ShopifyPage<
T> - A typed page of results from a Shopify paginated connection.
- ThrottleStatus
- Shopify Storefront throttle status from the query cost extension.
Enums
- CachePolicy
- Controls how the two-tier cache (memory + disk) is consulted.
- ShopifyLogLevel
- Controls how much output shopify_pro_sdk writes to the console.
Extensions
-
ShopifyListX
on List<
T> - ShopifyMoneyX on double
- ShopifyStringX on String
Constants
- kDefaultApiVersion → const String
- Shopify Storefront API version used by the SDK.
Exceptions / Errors
- ShopifyAuthException
- Thrown on HTTP 401 / invalid / expired access token.
- ShopifyConfigException
- Thrown when configuration is invalid or incomplete.
- ShopifyDeserializationException
- Thrown when JSON deserialization fails on an API response.
- ShopifyException
- Base class for all SDK exceptions.
- ShopifyGraphQLException
- Thrown when the Shopify API returns one or more GraphQL errors.
- ShopifyNetworkException
- Thrown when a network call fails (timeout, no connection, DNS failure).
- ShopifyNotFoundException
- Thrown when a requested resource (product, collection, etc.) is not found.
- ShopifyRateLimitException
- Thrown when the API returns HTTP 429 or a throttled error code.