@ehrenkind/shopify-lib 0.0.5 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +98 -31
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +767 -161
- package/dist/index.d.ts +18874 -3
- package/dist/index.mjs +96 -30
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -4
- package/dist/generated-api-types/2025-04/admin.generated.d.ts +0 -181
- package/dist/generated-api-types/2025-04/admin.generated.d.ts.map +0 -1
- package/dist/generated-api-types/2025-04/admin.generated.js +0 -5
- package/dist/generated-api-types/2025-04/admin.generated.js.map +0 -1
- package/dist/generated-api-types/2025-04/admin.types.d.ts +0 -57664
- package/dist/generated-api-types/2025-04/admin.types.d.ts.map +0 -1
- package/dist/generated-api-types/2025-04/admin.types.js +0 -11356
- package/dist/generated-api-types/2025-04/admin.types.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -3
- package/dist/index.js.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.d.ts +0 -4
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.d.ts.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.js +0 -56
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.js.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.mock.d.ts +0 -3
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.mock.d.ts.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.mock.js +0 -11
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.mock.js.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.test.d.ts +0 -2
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.test.d.ts.map +0 -1
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.test.js +0 -11
- package/dist/mutations/productVariantsBulkUpdate/connectMetaObjectToProductVariant.test.js.map +0 -1
- package/dist/queries/orders/getOrderByName.d.ts +0 -26
- package/dist/queries/orders/getOrderByName.d.ts.map +0 -1
- package/dist/queries/orders/getOrderByName.js +0 -117
- package/dist/queries/orders/getOrderByName.js.map +0 -1
- package/dist/queries/orders/getOrderByName.mock.d.ts +0 -21
- package/dist/queries/orders/getOrderByName.mock.d.ts.map +0 -1
- package/dist/queries/orders/getOrderByName.mock.js +0 -55
- package/dist/queries/orders/getOrderByName.mock.js.map +0 -1
- package/dist/queries/orders/getOrderByName.queries.d.ts +0 -3
- package/dist/queries/orders/getOrderByName.queries.d.ts.map +0 -1
- package/dist/queries/orders/getOrderByName.queries.js +0 -335
- package/dist/queries/orders/getOrderByName.queries.js.map +0 -1
- package/dist/queries/orders/getOrderByName.test.d.ts +0 -2
- package/dist/queries/orders/getOrderByName.test.d.ts.map +0 -1
- package/dist/queries/orders/getOrderByName.test.js +0 -28
- package/dist/queries/orders/getOrderByName.test.js.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.d.ts +0 -21
- package/dist/queries/productVariants/getLeanProductVariants.d.ts.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.js +0 -81
- package/dist/queries/productVariants/getLeanProductVariants.js.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.mock.d.ts +0 -3
- package/dist/queries/productVariants/getLeanProductVariants.mock.d.ts.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.mock.js +0 -33
- package/dist/queries/productVariants/getLeanProductVariants.mock.js.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.test.d.ts +0 -2
- package/dist/queries/productVariants/getLeanProductVariants.test.d.ts.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.test.js +0 -38
- package/dist/queries/productVariants/getLeanProductVariants.test.js.map +0 -1
- package/dist/utils/logger.d.ts +0 -11
- package/dist/utils/logger.d.ts.map +0 -1
- package/dist/utils/logger.js +0 -50
- package/dist/utils/logger.js.map +0 -1
- package/dist/utils/mswHandlers.d.ts +0 -2
- package/dist/utils/mswHandlers.d.ts.map +0 -1
- package/dist/utils/mswHandlers.js +0 -32
- package/dist/utils/mswHandlers.js.map +0 -1
- package/dist/utils/shopifyClient.d.ts +0 -6
- package/dist/utils/shopifyClient.d.ts.map +0 -1
- package/dist/utils/shopifyClient.js +0 -82
- package/dist/utils/shopifyClient.js.map +0 -1
- package/dist/utils/shopifyClient.mock.d.ts +0 -3
- package/dist/utils/shopifyClient.mock.d.ts.map +0 -1
- package/dist/utils/shopifyClient.mock.js +0 -19
- package/dist/utils/shopifyClient.mock.js.map +0 -1
- package/dist/utils/shopifyClient.test.d.ts +0 -2
- package/dist/utils/shopifyClient.test.d.ts.map +0 -1
- package/dist/utils/shopifyClient.test.js +0 -27
- package/dist/utils/shopifyClient.test.js.map +0 -1
- package/dist/utils/shopifyFetch.d.ts +0 -19
- package/dist/utils/shopifyFetch.d.ts.map +0 -1
- package/dist/utils/shopifyFetch.js +0 -60
- package/dist/utils/shopifyFetch.js.map +0 -1
- package/dist/utils/shopifyFetch.test.d.ts +0 -2
- package/dist/utils/shopifyFetch.test.d.ts.map +0 -1
- package/dist/utils/shopifyFetch.test.js +0 -17
- package/dist/utils/shopifyFetch.test.js.map +0 -1
- package/dist/utils/test-setup.d.ts +0 -2
- package/dist/utils/test-setup.d.ts.map +0 -1
- package/dist/utils/test-setup.js +0 -13
- package/dist/utils/test-setup.js.map +0 -1
- package/dist/utils/zod.d.ts +0 -3
- package/dist/utils/zod.d.ts.map +0 -1
- package/dist/utils/zod.js +0 -19
- package/dist/utils/zod.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -86,7 +86,11 @@ type Scalars = {
|
|
|
86
86
|
output: any;
|
|
87
87
|
};
|
|
88
88
|
};
|
|
89
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* A permission that controls access to [GraphQL Admin API](https://shopify.dev/docs/api/usage/access-scopes#authenticated-access-scopes) or [Storefront API](https://shopify.dev/docs/api/usage/access-scopes#unauthenticated-access-scopes) types. Each scope defines what data an [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) can read or write, following the format `{action}_{resource}` where action is typically "read" or "write".
|
|
91
|
+
*
|
|
92
|
+
* Apps declare required and optional access scopes in their configuration. During installation, merchants review and grant these permissions, determining what shop data the app can access. The granted scopes remain active until the merchant uninstalls the app or revokes them. Apps can programmatically revoke their own dynamically granted optional scopes using [`appRevokeAccessScopes`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/appRevokeAccessScopes).
|
|
93
|
+
*/
|
|
90
94
|
type AccessScope = {
|
|
91
95
|
__typename?: 'AccessScope';
|
|
92
96
|
/** A description of the actions that the access scope allows an app to perform. */
|
|
@@ -125,7 +129,11 @@ type AddAllProductsOperation = Node & ResourceOperation & {
|
|
|
125
129
|
/** The status of this operation. */
|
|
126
130
|
status: ResourceOperationStatus;
|
|
127
131
|
};
|
|
128
|
-
/**
|
|
132
|
+
/**
|
|
133
|
+
* Additional fees applied to an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) beyond the standard product and shipping costs. Additional fees typically include duties, import fees, or other special handling charges that need separate tracking from regular [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) objects.
|
|
134
|
+
*
|
|
135
|
+
* Each fee includes its name, price in both shop and presentment currencies, and any applicable taxes broken down by [`TaxLine`](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine).
|
|
136
|
+
*/
|
|
129
137
|
type AdditionalFee = Node & {
|
|
130
138
|
__typename?: 'AdditionalFee';
|
|
131
139
|
/** A globally-unique ID. */
|
|
@@ -149,7 +157,11 @@ type AllDiscountItems = {
|
|
|
149
157
|
/** Whether all items are eligible for the discount. This value always returns `true`. */
|
|
150
158
|
allItems: Scalars['Boolean']['output'];
|
|
151
159
|
};
|
|
152
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* A Shopify application that extends store functionality. Apps integrate with Shopify through APIs to add features, automate workflows, or connect external services.
|
|
162
|
+
*
|
|
163
|
+
* Provides metadata about the app including its developer information and listing details in the Shopify App Store. Use the [`installation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App#field-App.fields.installation) field to determine if the app is currently installed on the shop and access installation-specific details like granted [`AccessScope`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) objects. Check [`failedRequirements`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App#field-App.fields.failedRequirements) before installation to identify any prerequisites that must be met.
|
|
164
|
+
*/
|
|
153
165
|
type App = Node & {
|
|
154
166
|
__typename?: 'App';
|
|
155
167
|
/** A unique application API identifier. */
|
|
@@ -187,7 +199,7 @@ type App = Node & {
|
|
|
187
199
|
icon: Image;
|
|
188
200
|
/** A globally-unique ID. */
|
|
189
201
|
id: Scalars['ID']['output'];
|
|
190
|
-
/** Webpage where you can install the app. */
|
|
202
|
+
/** Webpage where you can install the app, if app requires explicit user permission. */
|
|
191
203
|
installUrl?: Maybe<Scalars['URL']['output']>;
|
|
192
204
|
/**
|
|
193
205
|
* Corresponding AppInstallation for this shop and App.
|
|
@@ -251,7 +263,20 @@ type AppConnection = {
|
|
|
251
263
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
252
264
|
pageInfo: PageInfo;
|
|
253
265
|
};
|
|
254
|
-
/**
|
|
266
|
+
/**
|
|
267
|
+
* Represents monetary credits that merchants can apply toward future app purchases, subscriptions, or usage-based billing within their Shopify store. App credits provide a flexible way to offer refunds, promotional credits, or compensation without processing external payments.
|
|
268
|
+
*
|
|
269
|
+
* For example, if a merchant experiences service downtime, an app might issue credits equivalent to the affected billing period. These credits can apply to future charges, reducing the merchant's next invoice or extending their subscription period.
|
|
270
|
+
*
|
|
271
|
+
* Use the `AppCredit` object to:
|
|
272
|
+
* - Issue refunds for service interruptions or billing disputes
|
|
273
|
+
* - Provide promotional credits for new merchant onboarding
|
|
274
|
+
* - Compensate merchants for app-related issues or downtime
|
|
275
|
+
* - Create loyalty rewards or referral bonuses within your billing system
|
|
276
|
+
* - Track credit balances and application history for accounting purposes
|
|
277
|
+
*
|
|
278
|
+
* For comprehensive billing strategies and credit management patterns, see the [subscription billing guide](https://shopify.dev/docs/apps/launch/billing/subscription-billing).
|
|
279
|
+
*/
|
|
255
280
|
type AppCredit = Node & {
|
|
256
281
|
__typename?: 'AppCredit';
|
|
257
282
|
/** The amount that can be used towards future app purchases in Shopify. */
|
|
@@ -384,7 +409,11 @@ type AppFeedback = {
|
|
|
384
409
|
/** Conveys the state of the feedback and whether it requires merchant action or not. */
|
|
385
410
|
state: ResourceFeedbackState;
|
|
386
411
|
};
|
|
387
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* An app installed on a shop. Each installation tracks the permissions granted to the app through [`AccessScope`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) objects, along with billing subscriptions and [`Metafield`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) objects.
|
|
414
|
+
*
|
|
415
|
+
* The installation provides metafields that only the owning [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) can access. These metafields store app-specific configuration that merchants and other apps can't modify. The installation also provides URLs for launching and uninstalling the app, along with any active [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) objects or [`AppPurchaseOneTime`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppPurchaseOneTime) purchases.
|
|
416
|
+
*/
|
|
388
417
|
type AppInstallation = HasMetafields & Node & {
|
|
389
418
|
__typename?: 'AppInstallation';
|
|
390
419
|
/** The access scopes granted to the application by a merchant during installation. */
|
|
@@ -431,7 +460,13 @@ type AppInstallation = HasMetafields & Node & {
|
|
|
431
460
|
/** The URL to uninstall the application. */
|
|
432
461
|
uninstallUrl?: Maybe<Scalars['URL']['output']>;
|
|
433
462
|
};
|
|
434
|
-
/**
|
|
463
|
+
/**
|
|
464
|
+
* Contains the pricing details for the app plan that a merchant has subscribed to within their current billing arrangement.
|
|
465
|
+
*
|
|
466
|
+
* This simplified object focuses on the essential pricing information merchants need to understand their current subscription costs and billing structure.
|
|
467
|
+
*
|
|
468
|
+
* Details about subscription management and pricing strategies are available in the [app billing documentation](https://shopify.dev/docs/apps/launch/billing).
|
|
469
|
+
*/
|
|
435
470
|
type AppPlanV2 = {
|
|
436
471
|
__typename?: 'AppPlanV2';
|
|
437
472
|
/** The plan billed to a shop on a recurring basis. */
|
|
@@ -473,7 +508,22 @@ type AppPurchase = {
|
|
|
473
508
|
/** Whether the app purchase is a test transaction. */
|
|
474
509
|
test: Scalars['Boolean']['output'];
|
|
475
510
|
};
|
|
476
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* Represents a one-time purchase of app services or features by a merchant, tracking the transaction details and status throughout the billing lifecycle. This object captures essential information about non-recurring charges, including price and merchant acceptance status.
|
|
513
|
+
*
|
|
514
|
+
* One-time purchases are particularly valuable for apps offering premium features, professional services, or digital products that don't require ongoing subscriptions. For instance, a photography app might sell premium filters as one-time purchases, while a marketing app could charge for individual campaign setups or advanced analytics reports.
|
|
515
|
+
*
|
|
516
|
+
* Use the `AppPurchaseOneTime` object to:
|
|
517
|
+
* - Track the status of individual feature purchases and service charges
|
|
518
|
+
* - Track payment status for premium content or digital products
|
|
519
|
+
* - Access purchase details to enable or disable features based on payment status
|
|
520
|
+
*
|
|
521
|
+
* The purchase status indicates whether the charge is pending merchant approval, has been accepted and processed, or was declined. This status tracking is crucial for apps that need to conditionally enable features based on successful payment completion.
|
|
522
|
+
*
|
|
523
|
+
* Purchase records include creation timestamps, pricing details, and test flags to distinguish between production charges and development testing. The test flag ensures that development and staging environments don't generate actual charges while maintaining realistic billing flow testing.
|
|
524
|
+
*
|
|
525
|
+
* For detailed implementation patterns and billing best practices, see the [one-time-charges page](https://shopify.dev/docs/apps/launch/billing/one-time-charges).
|
|
526
|
+
*/
|
|
477
527
|
type AppPurchaseOneTime = AppPurchase & Node & {
|
|
478
528
|
__typename?: 'AppPurchaseOneTime';
|
|
479
529
|
/** The date and time when the app purchase occurred. */
|
|
@@ -547,7 +597,25 @@ type AppRecurringPricing = {
|
|
|
547
597
|
/** The amount and currency to be charged to the subscribing shop every billing interval. */
|
|
548
598
|
price: MoneyV2;
|
|
549
599
|
};
|
|
550
|
-
/**
|
|
600
|
+
/**
|
|
601
|
+
* Tracks revenue that was captured outside of Shopify's billing system but needs to be attributed to the app for comprehensive revenue reporting and partner analytics. This object enables accurate revenue tracking when apps process payments through external systems while maintaining visibility into total app performance.
|
|
602
|
+
*
|
|
603
|
+
* External revenue attribution is essential for apps that offer multiple payment channels or process certain transactions outside Shopify's billing infrastructure. For example, an enterprise app might process large custom contracts through external payment processors, or a marketplace app could handle direct merchant-to-merchant transactions that still generate app commissions.
|
|
604
|
+
*
|
|
605
|
+
* Use the `AppRevenueAttributionRecord` object to:
|
|
606
|
+
* - Report revenue from external payment processors and billing systems
|
|
607
|
+
* - Track commission-based earnings from marketplace or referral activities
|
|
608
|
+
* - Maintain comprehensive revenue analytics across multiple payment channels
|
|
609
|
+
* - Ensure accurate partner revenue sharing and commission calculations
|
|
610
|
+
* - Generate complete financial reports that include all app-generated revenue streams
|
|
611
|
+
* - Support compliance requirements for external revenue documentation
|
|
612
|
+
*
|
|
613
|
+
* Each attribution record includes the captured amount, external transaction timestamp, and idempotency keys to prevent duplicate reporting. The record type field categorizes different revenue streams, enabling detailed analytics and reporting segmentation.
|
|
614
|
+
*
|
|
615
|
+
* Revenue attribution records are particularly important for apps participating in Shopify's partner program, as they ensure accurate revenue sharing calculations and comprehensive performance metrics. The captured timestamp reflects when the external payment was processed, not when the attribution record was created in Shopify.
|
|
616
|
+
*
|
|
617
|
+
* For detailed revenue attribution values, see the [AppRevenueAttributionType enum](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppRevenueAttributionType).
|
|
618
|
+
*/
|
|
551
619
|
type AppRevenueAttributionRecord = Node & {
|
|
552
620
|
__typename?: 'AppRevenueAttributionRecord';
|
|
553
621
|
/** The financial amount captured in this attribution. */
|
|
@@ -598,7 +666,15 @@ declare enum AppRevenueAttributionType {
|
|
|
598
666
|
/** Other app revenue collection type. */
|
|
599
667
|
Other = "OTHER"
|
|
600
668
|
}
|
|
601
|
-
/**
|
|
669
|
+
/**
|
|
670
|
+
* A recurring billing agreement that associates an [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) with a merchant's shop. Each subscription contains one or more [`AppSubscriptionLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionLineItem) objects that define the pricing structure. The pricing structure can include recurring charges, usage-based pricing, or both.
|
|
671
|
+
*
|
|
672
|
+
* The subscription tracks billing details including the current period end date, trial days, and [`AppSubscriptionStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppSubscriptionStatus).
|
|
673
|
+
*
|
|
674
|
+
* Merchants must approve subscriptions through a [confirmation URL](https://shopify.dev/docs/api/admin-graphql/latest/mutations/appSubscriptionCreate#returns-confirmationUrl) before billing begins. Test subscriptions allow developers to verify billing flows without actual charges.
|
|
675
|
+
*
|
|
676
|
+
* Learn more about [subscription billing](https://shopify.dev/docs/apps/launch/billing/subscription-billing) and [testing charges](https://shopify.dev/docs/apps/launch/billing/managed-pricing#test-charges).
|
|
677
|
+
*/
|
|
602
678
|
type AppSubscription = Node & {
|
|
603
679
|
__typename?: 'AppSubscription';
|
|
604
680
|
/** The date and time when the app subscription was created. */
|
|
@@ -667,7 +743,20 @@ type AppSubscriptionEdge = {
|
|
|
667
743
|
/** The item at the end of AppSubscriptionEdge. */
|
|
668
744
|
node: AppSubscription;
|
|
669
745
|
};
|
|
670
|
-
/**
|
|
746
|
+
/**
|
|
747
|
+
* Represents a component of an app subscription that contains pricing details for either recurring fees or usage-based charges. Each subscription has exactly 1 or 2 line items - one for recurring fees and/or one for usage fees.
|
|
748
|
+
*
|
|
749
|
+
* If a subscription has both recurring and usage pricing, there will be 2 line items. If it only has one type of pricing, the subscription will have a single line item for that pricing model.
|
|
750
|
+
*
|
|
751
|
+
* Use the `AppSubscriptionLineItem` object to:
|
|
752
|
+
* - View the pricing terms a merchant has agreed to
|
|
753
|
+
* - Distinguish between recurring and usage fee components
|
|
754
|
+
* - Access detailed billing information for each pricing component
|
|
755
|
+
*
|
|
756
|
+
* This read-only object provides visibility into the subscription's pricing structure without allowing modifications.
|
|
757
|
+
*
|
|
758
|
+
* Read about subscription pricing models in the [billing architecture guide](https://shopify.dev/docs/apps/launch/billing/subscription-billing).
|
|
759
|
+
*/
|
|
671
760
|
type AppSubscriptionLineItem = {
|
|
672
761
|
__typename?: 'AppSubscriptionLineItem';
|
|
673
762
|
/** A globally-unique ID. */
|
|
@@ -698,8 +787,17 @@ declare enum AppSubscriptionStatus {
|
|
|
698
787
|
Pending = "PENDING"
|
|
699
788
|
}
|
|
700
789
|
/**
|
|
701
|
-
* Defines
|
|
702
|
-
*
|
|
790
|
+
* Defines usage-based pricing terms for app subscriptions where merchants pay based on their actual consumption of app features or services. This pricing model provides flexibility for merchants who want to pay only for what they use rather than fixed monthly fees.
|
|
791
|
+
*
|
|
792
|
+
* For example, an email marketing app might charge variable pricing per email sent, with a monthly cap of variable pricing, allowing small merchants to pay minimal amounts while protecting larger merchants from excessive charges.
|
|
793
|
+
*
|
|
794
|
+
* Use the `AppUsagePricing` object to:
|
|
795
|
+
* - View consumption-based billing for variable app usage
|
|
796
|
+
* - See spending caps that protect merchants from unexpected charges
|
|
797
|
+
*
|
|
798
|
+
* The balance and capped amount fields provide apps with data about current usage costs and remaining budget within the billing period, which apps can present to merchants to promote transparency in variable pricing.
|
|
799
|
+
*
|
|
800
|
+
* For implementation guidance, see the [usage billing documentation](https://shopify.dev/docs/apps/launch/billing/subscription-billing/create-usage-based-subscriptions).
|
|
703
801
|
*/
|
|
704
802
|
type AppUsagePricing = {
|
|
705
803
|
__typename?: 'AppUsagePricing';
|
|
@@ -754,7 +852,11 @@ type AppUsageRecordEdge = {
|
|
|
754
852
|
/** The item at the end of AppUsageRecordEdge. */
|
|
755
853
|
node: AppUsageRecord;
|
|
756
854
|
};
|
|
757
|
-
/**
|
|
855
|
+
/**
|
|
856
|
+
* An article that contains content, author information, and metadata. Articles belong to a [`Blog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Blog) and can include HTML-formatted body text, summary text, and an associated image. Merchants publish articles to share content, drive traffic, and engage customers.
|
|
857
|
+
*
|
|
858
|
+
* Articles can be organized with tags and published immediately or scheduled for future publication using the [`publishedAt`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article#field-Article.fields.publishedAt) timestamp. The API manages comments on articles when the blog's comment policy enables them.
|
|
859
|
+
*/
|
|
758
860
|
type Article = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & Navigable & Node & {
|
|
759
861
|
__typename?: 'Article';
|
|
760
862
|
/** The name of the author of the article. */
|
|
@@ -827,7 +929,18 @@ type Article = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishe
|
|
|
827
929
|
/** The date and time (ISO 8601 format) when the article was last updated. */
|
|
828
930
|
updatedAt?: Maybe<Scalars['DateTime']['output']>;
|
|
829
931
|
};
|
|
830
|
-
/**
|
|
932
|
+
/**
|
|
933
|
+
* Represents the author of an article. This object provides the author's full name for attribution purposes.
|
|
934
|
+
*
|
|
935
|
+
* The `ArticleAuthor` is a simple object that contains only the author's name field. When articles are created or updated, the author information is stored and can be displayed alongside the article content.
|
|
936
|
+
*
|
|
937
|
+
* Use the `ArticleAuthor` object to:
|
|
938
|
+
* - Retrieve the author's name for display in article bylines
|
|
939
|
+
* - Show author attribution in article listings
|
|
940
|
+
* - Display who wrote specific content
|
|
941
|
+
*
|
|
942
|
+
* Note: This object only contains the author's full name. It does not include additional author details like bio, email, or social media links.
|
|
943
|
+
*/
|
|
831
944
|
type ArticleAuthor = {
|
|
832
945
|
__typename?: 'ArticleAuthor';
|
|
833
946
|
/** The author's full name. */
|
|
@@ -881,8 +994,9 @@ type BasePaymentDetails = {
|
|
|
881
994
|
paymentMethodName?: Maybe<Scalars['String']['output']>;
|
|
882
995
|
};
|
|
883
996
|
/**
|
|
884
|
-
*
|
|
885
|
-
*
|
|
997
|
+
* A blog for publishing articles in the online store. Stores can have multiple blogs to organize content by topic or purpose.
|
|
998
|
+
*
|
|
999
|
+
* Each blog contains articles with their associated comments, tags, and metadata. The comment policy controls whether readers can post comments and whether moderation is required. Blogs use customizable URL handles and can apply alternate templates for specialized layouts.
|
|
886
1000
|
*/
|
|
887
1001
|
type Blog = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & Node & {
|
|
888
1002
|
__typename?: 'Blog';
|
|
@@ -935,7 +1049,19 @@ type Blog = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTr
|
|
|
935
1049
|
/** The date and time when the blog was update. */
|
|
936
1050
|
updatedAt?: Maybe<Scalars['DateTime']['output']>;
|
|
937
1051
|
};
|
|
938
|
-
/**
|
|
1052
|
+
/**
|
|
1053
|
+
* RSS feed provider details for blog syndication. This object contains the location and path information for external feed services that were previously integrated with the blog.
|
|
1054
|
+
*
|
|
1055
|
+
* The `BlogFeed` object maintains the feed URL and path to ensure existing feed subscriptions continue working.
|
|
1056
|
+
*
|
|
1057
|
+
* Use the `BlogFeed` object to:
|
|
1058
|
+
* - Access RSS feed provider configuration
|
|
1059
|
+
* - Retrieve feed location and path information
|
|
1060
|
+
* - Maintain existing feed syndication settings
|
|
1061
|
+
*
|
|
1062
|
+
* > Note:
|
|
1063
|
+
* > This is a legacy feature. New integrations with external feed services are not supported.
|
|
1064
|
+
*/
|
|
939
1065
|
type BlogFeed = {
|
|
940
1066
|
__typename?: 'BlogFeed';
|
|
941
1067
|
/** Blog feed provider url. */
|
|
@@ -953,7 +1079,13 @@ type BundlesFeature = {
|
|
|
953
1079
|
/** Whether a shop has any fixed bundle products or has a cartTransform function installed. */
|
|
954
1080
|
sellsBundles: Scalars['Boolean']['output'];
|
|
955
1081
|
};
|
|
956
|
-
/**
|
|
1082
|
+
/**
|
|
1083
|
+
* A legal entity through which a merchant operates. Each business entity contains its own [`BusinessEntityAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntityAddress), company information, and can be associated with its own [`ShopifyPaymentsAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAccount). [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) objects can be assigned to a business entity to determine payment processing and [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) attribution.
|
|
1084
|
+
*
|
|
1085
|
+
* Every shop must have one primary business entity. Additional entities enable international operations by establishing legal presence in multiple countries.
|
|
1086
|
+
*
|
|
1087
|
+
* Learn more about [managing multiple legal entities](https://shopify.dev/docs/apps/build/markets/multiple-entities).
|
|
1088
|
+
*/
|
|
957
1089
|
type BusinessEntity = Node & {
|
|
958
1090
|
__typename?: 'BusinessEntity';
|
|
959
1091
|
/** The address of the merchant's Business Entity. */
|
|
@@ -966,7 +1098,11 @@ type BusinessEntity = Node & {
|
|
|
966
1098
|
id: Scalars['ID']['output'];
|
|
967
1099
|
/** Whether it's the merchant's primary Business Entity. */
|
|
968
1100
|
primary: Scalars['Boolean']['output'];
|
|
969
|
-
/**
|
|
1101
|
+
/**
|
|
1102
|
+
* Returns the Shopify Payments account information for the shop. Includes current balances across all currencies, payout schedules, and bank account configurations.
|
|
1103
|
+
*
|
|
1104
|
+
* The account includes [`ShopifyPaymentsBalanceTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBalanceTransaction) records showing charges, refunds, and adjustments that affect your balance. Also includes [`ShopifyPaymentsDispute`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDispute) records and [`ShopifyPaymentsPayout`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout) history between the account and connected [`ShopifyPaymentsBankAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount) configurations.
|
|
1105
|
+
*/
|
|
970
1106
|
shopifyPaymentsAccount?: Maybe<ShopifyPaymentsAccount>;
|
|
971
1107
|
};
|
|
972
1108
|
/** Represents the address of a merchant's Business Entity. */
|
|
@@ -1101,7 +1237,7 @@ type CalculatedDraftOrderLineItem = {
|
|
|
1101
1237
|
/** The weight unit and value. */
|
|
1102
1238
|
weight?: Maybe<Weight>;
|
|
1103
1239
|
};
|
|
1104
|
-
/**
|
|
1240
|
+
/** Credit card payment information captured during a transaction. Includes cardholder details, card metadata, verification response codes, and the [`DigitalWallet`](https://shopify.dev/docs/api/admin-graphql/latest/enums/DigitalWallet#valid-values) when used. */
|
|
1105
1241
|
type CardPaymentDetails = BasePaymentDetails & {
|
|
1106
1242
|
__typename?: 'CardPaymentDetails';
|
|
1107
1243
|
/** The response code from the address verification system (AVS). The code is always a single letter. */
|
|
@@ -1125,7 +1261,13 @@ type CardPaymentDetails = BasePaymentDetails & {
|
|
|
1125
1261
|
/** Digital wallet used for the payment. */
|
|
1126
1262
|
wallet?: Maybe<DigitalWallet>;
|
|
1127
1263
|
};
|
|
1128
|
-
/**
|
|
1264
|
+
/**
|
|
1265
|
+
* Controls which cart transformation operations apps can perform in your store. This lets you define exactly what types of cart modifications are allowed based on your checkout setup and business needs.
|
|
1266
|
+
*
|
|
1267
|
+
* The eligible operations determine what cart transform functions can accomplish, providing a clear boundary for app capabilities within the store's ecosystem.
|
|
1268
|
+
*
|
|
1269
|
+
* Learn more about [cart transform operations](https://shopify.dev/docs/api/functions/latest/cart-transform#multiple-operations).
|
|
1270
|
+
*/
|
|
1129
1271
|
type CartTransformEligibleOperations = {
|
|
1130
1272
|
__typename?: 'CartTransformEligibleOperations';
|
|
1131
1273
|
/** The shop is eligible for expand operations. */
|
|
@@ -1135,7 +1277,15 @@ type CartTransformEligibleOperations = {
|
|
|
1135
1277
|
/** The shop is eligible for update operations. */
|
|
1136
1278
|
updateOperation: Scalars['Boolean']['output'];
|
|
1137
1279
|
};
|
|
1138
|
-
/**
|
|
1280
|
+
/**
|
|
1281
|
+
* Provides access to the cart transform feature configuration for the merchant's store. This wrapper object indicates whether cart transformation capabilities are enabled and what operations are available.
|
|
1282
|
+
*
|
|
1283
|
+
* For example, when checking if your app can deploy customized bundle features, you would query this object to confirm cart transforms are supported and review the eligible operations.
|
|
1284
|
+
*
|
|
1285
|
+
* The feature configuration helps apps determine compatibility before attempting to create transform functions.
|
|
1286
|
+
*
|
|
1287
|
+
* Learn more about [cart transformation](https://shopify.dev/docs/api/admin-graphql/latest/objects/CartTransform).
|
|
1288
|
+
*/
|
|
1139
1289
|
type CartTransformFeature = {
|
|
1140
1290
|
__typename?: 'CartTransformFeature';
|
|
1141
1291
|
/** The cart transform operations eligible for the shop. */
|
|
@@ -1207,21 +1357,19 @@ declare enum CatalogStatus {
|
|
|
1207
1357
|
Draft = "DRAFT"
|
|
1208
1358
|
}
|
|
1209
1359
|
/**
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1360
|
+
* An authenticated link to an external platform that supports syndication and optionally order ingestion, such as Facebook, Pinterest, an online store, or Point of Sale (POS).
|
|
1361
|
+
*
|
|
1362
|
+
* Each channel provides access to its underlying [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App), published products and collections, and [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings, as well as what features of the platform it supports such as [scheduled publishing](https://shopify.dev/docs/apps/build/sales-channels/scheduled-product-publishing). Use channels to manage where catalog items appear, track publication status across platforms, and control [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) visibility for different customer touchpoints.
|
|
1212
1363
|
*/
|
|
1213
1364
|
type Channel = Node & {
|
|
1214
1365
|
__typename?: 'Channel';
|
|
1215
1366
|
/** The underlying app used by the channel. */
|
|
1216
1367
|
app: App;
|
|
1217
|
-
/** The collection publications
|
|
1368
|
+
/** The list of collection publications. Each record represents information about the publication of a collection. */
|
|
1218
1369
|
collectionPublicationsV3: ResourcePublicationConnection;
|
|
1219
1370
|
/** The list of collections published to the channel. */
|
|
1220
1371
|
collections: CollectionConnection;
|
|
1221
|
-
/**
|
|
1222
|
-
* The unique identifier for the channel.
|
|
1223
|
-
* @deprecated Use `id` instead.
|
|
1224
|
-
*/
|
|
1372
|
+
/** The unique identifier for the channel. */
|
|
1225
1373
|
handle: Scalars['String']['output'];
|
|
1226
1374
|
/** Whether the collection is available to the channel. */
|
|
1227
1375
|
hasCollection: Scalars['Boolean']['output'];
|
|
@@ -1246,24 +1394,11 @@ type Channel = Node & {
|
|
|
1246
1394
|
* @deprecated Use `productPublicationsV3` instead.
|
|
1247
1395
|
*/
|
|
1248
1396
|
productPublications: ProductPublicationConnection;
|
|
1249
|
-
/** The
|
|
1397
|
+
/** The list of product publication records for products published to this channel. */
|
|
1250
1398
|
productPublicationsV3: ResourcePublicationConnection;
|
|
1251
1399
|
/** The list of products published to the channel. */
|
|
1252
1400
|
products: ProductConnection;
|
|
1253
|
-
/**
|
|
1254
|
-
* Retrieves the total count of products that are currently published to a specific sales channel. This provides a quick way to understand channel inventory without fetching the full product list.
|
|
1255
|
-
*
|
|
1256
|
-
* For example, when building channel management dashboards, you can display how many products are available in each channel like "150 products in Online Store" or "75 products in Facebook Shop."
|
|
1257
|
-
*
|
|
1258
|
-
* Use `ChannelProductsCount` to:
|
|
1259
|
-
* - Display inventory summaries in channel management interfaces
|
|
1260
|
-
* - Monitor product distribution across sales channels
|
|
1261
|
-
* - Validate channel setup and product availability
|
|
1262
|
-
*
|
|
1263
|
-
* The count reflects only published products and updates as merchants add or remove products from channels.
|
|
1264
|
-
*
|
|
1265
|
-
* Learn more about [sales channels](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel). Limited to a maximum of 10000 by default.
|
|
1266
|
-
*/
|
|
1401
|
+
/** Retrieves the total count of [`products`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) published to a specific sales channel. Limited to a maximum of 10000 by default. */
|
|
1267
1402
|
productsCount?: Maybe<Count>;
|
|
1268
1403
|
/** Whether the channel supports future publishing. */
|
|
1269
1404
|
supportsFuturePublishing: Scalars['Boolean']['output'];
|
|
@@ -1279,8 +1414,9 @@ type ChannelConnection = {
|
|
|
1279
1414
|
pageInfo: PageInfo;
|
|
1280
1415
|
};
|
|
1281
1416
|
/**
|
|
1282
|
-
* A channel definition
|
|
1283
|
-
*
|
|
1417
|
+
* A specific selling surface within a [sales channel](https://shopify.dev/docs/apps/build/sales-channels) platform. A channel definition identifies where products can be sold. Definitions can represent entire platforms (like Facebook or TikTok) or specific sales channels within those platforms, such as Instagram Shops, Instagram Shopping, or TikTok Live.
|
|
1418
|
+
*
|
|
1419
|
+
* Each definition includes the parent [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) name and subchannel name to indicate the selling surface hierarchy. The marketplace flag identifies whether this surface represents a marketplace channel such as shops on Facebook, Instagram, or Buy on Google.
|
|
1284
1420
|
*/
|
|
1285
1421
|
type ChannelDefinition = Node & {
|
|
1286
1422
|
__typename?: 'ChannelDefinition';
|
|
@@ -1308,7 +1444,11 @@ type ChannelEdge = {
|
|
|
1308
1444
|
/** The item at the end of ChannelEdge. */
|
|
1309
1445
|
node: Channel;
|
|
1310
1446
|
};
|
|
1311
|
-
/**
|
|
1447
|
+
/**
|
|
1448
|
+
* Identifies the [sales channel](https://shopify.dev/docs/apps/build/sales-channels) and [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) from which an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) originated. Provides attribution details such as the specific platform (Facebook Marketplace, Instagram Shopping) or marketplace where the order was placed.
|
|
1449
|
+
*
|
|
1450
|
+
* Links to the app that manages the channel and optional [`ChannelDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelDefinition) details that specify the exact sub-channel or selling surface.
|
|
1451
|
+
*/
|
|
1312
1452
|
type ChannelInformation = Node & {
|
|
1313
1453
|
__typename?: 'ChannelInformation';
|
|
1314
1454
|
/** The app associated with the channel. */
|
|
@@ -1769,7 +1909,16 @@ type Comment = HasEvents & Node & {
|
|
|
1769
1909
|
/** The user agent of the commenter. */
|
|
1770
1910
|
userAgent?: Maybe<Scalars['String']['output']>;
|
|
1771
1911
|
};
|
|
1772
|
-
/**
|
|
1912
|
+
/**
|
|
1913
|
+
* The author of a comment on a blog article, containing the commenter's name and email address. This information helps merchants moderate comments and potentially engage with their community.
|
|
1914
|
+
*
|
|
1915
|
+
* For example, when reviewing pending comments, merchants can see the commenter's name and email to help with moderation decisions or to enable follow-up communication if needed.
|
|
1916
|
+
*
|
|
1917
|
+
* Use the `CommentAuthor` object to:
|
|
1918
|
+
* - Display comment attribution
|
|
1919
|
+
* - Support comment moderation workflows
|
|
1920
|
+
* - Enable merchant-to-reader communication
|
|
1921
|
+
*/
|
|
1773
1922
|
type CommentAuthor = {
|
|
1774
1923
|
__typename?: 'CommentAuthor';
|
|
1775
1924
|
/** The author's email. */
|
|
@@ -1824,7 +1973,7 @@ declare enum CommentStatus {
|
|
|
1824
1973
|
/** The comment is unapproved. */
|
|
1825
1974
|
Unapproved = "UNAPPROVED"
|
|
1826
1975
|
}
|
|
1827
|
-
/**
|
|
1976
|
+
/** A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) objects can have custom pricing through [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) and [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) configurations. */
|
|
1828
1977
|
type Company = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasMetafields & Navigable & Node & {
|
|
1829
1978
|
__typename?: 'Company';
|
|
1830
1979
|
/**
|
|
@@ -1942,7 +2091,11 @@ type CompanyAddress = Node & {
|
|
|
1942
2091
|
*/
|
|
1943
2092
|
zoneCode?: Maybe<Scalars['String']['output']>;
|
|
1944
2093
|
};
|
|
1945
|
-
/**
|
|
2094
|
+
/**
|
|
2095
|
+
* A person who acts on behalf of a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) to make B2B purchases. Company contacts are associated with [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) accounts and can place orders on behalf of their company.
|
|
2096
|
+
*
|
|
2097
|
+
* Each contact can be assigned to one or more [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) objects with specific roles that determine their permissions and access to catalogs, pricing, and payment terms configured for those locations.
|
|
2098
|
+
*/
|
|
1946
2099
|
type CompanyContact = Node & {
|
|
1947
2100
|
__typename?: 'CompanyContact';
|
|
1948
2101
|
/** The company to which the contact belongs. */
|
|
@@ -2055,7 +2208,11 @@ type CompanyContactRoleEdge = {
|
|
|
2055
2208
|
/** The item at the end of CompanyContactRoleEdge. */
|
|
2056
2209
|
node: CompanyContactRole;
|
|
2057
2210
|
};
|
|
2058
|
-
/**
|
|
2211
|
+
/**
|
|
2212
|
+
* A location or branch of a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.
|
|
2213
|
+
*
|
|
2214
|
+
* Each location can have its own [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) objects that determine which products are published and their pricing. The [`BuyerExperienceConfiguration`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BuyerExperienceConfiguration) determines checkout behavior including [`PaymentTerms`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms), and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, [`TaxExemption`](https://shopify.dev/docs/api/admin-graphql/latest/enums/TaxExemption) values, and checkout settings for their [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) objects.
|
|
2215
|
+
*/
|
|
2059
2216
|
type CompanyLocation = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasMetafields & Navigable & Node & {
|
|
2060
2217
|
__typename?: 'CompanyLocation';
|
|
2061
2218
|
/** The address used as billing address for the location. */
|
|
@@ -2211,7 +2368,7 @@ type CompanyLocationsCondition = {
|
|
|
2211
2368
|
/** The company locations that comprise the market. */
|
|
2212
2369
|
companyLocations: CompanyLocationConnection;
|
|
2213
2370
|
};
|
|
2214
|
-
/**
|
|
2371
|
+
/** A numeric count with precision information indicating whether the count is exact or an estimate. */
|
|
2215
2372
|
type Count = {
|
|
2216
2373
|
__typename?: 'Count';
|
|
2217
2374
|
/** The count of elements. */
|
|
@@ -3141,14 +3298,19 @@ type CurrencySettingEdge = {
|
|
|
3141
3298
|
node: CurrencySetting;
|
|
3142
3299
|
};
|
|
3143
3300
|
/**
|
|
3144
|
-
*
|
|
3145
|
-
* history, and whether they've agreed to receive marketing material by email.
|
|
3301
|
+
* Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.
|
|
3146
3302
|
*
|
|
3147
|
-
*
|
|
3303
|
+
* Tracks the customer's total spending through the [`amountSpent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer#field-amountSpent) field and provides access to associated data such as payment methods and subscription contracts.
|
|
3304
|
+
*
|
|
3305
|
+
* > Caution:
|
|
3306
|
+
* > Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data.
|
|
3148
3307
|
*/
|
|
3149
3308
|
type Customer = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasMetafields & HasStoreCreditAccounts & LegacyInteroperability & Node & {
|
|
3150
3309
|
__typename?: 'Customer';
|
|
3151
|
-
/**
|
|
3310
|
+
/**
|
|
3311
|
+
* A list of addresses associated with the customer. Limited to 250 addresses. Use `addresses_v2` for paginated access to all addresses.
|
|
3312
|
+
* @deprecated Limited to 250 addresses. Use `addresses_v2` for paginated access to all addresses.
|
|
3313
|
+
*/
|
|
3152
3314
|
addresses: Array<MailingAddress>;
|
|
3153
3315
|
/** The addresses associated with the customer. */
|
|
3154
3316
|
addressesV2: MailingAddressConnection;
|
|
@@ -3303,7 +3465,7 @@ type Customer = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasM
|
|
|
3303
3465
|
/** Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API. */
|
|
3304
3466
|
verifiedEmail: Scalars['Boolean']['output'];
|
|
3305
3467
|
};
|
|
3306
|
-
/** Information about the shop's customer accounts. */
|
|
3468
|
+
/** Information about the shop's customer account-related settings. Includes the [customer account version](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerAccountsV2#field-CustomerAccountsV2.fields.customerAccountsVersion) which indicates whether the merchant is using new customer accounts or legacy customer accounts, along with other account configuration such as login requirements. */
|
|
3307
3469
|
type CustomerAccountsV2 = {
|
|
3308
3470
|
__typename?: 'CustomerAccountsV2';
|
|
3309
3471
|
/** Indicates which version of customer accounts the merchant is using in online store and checkout. */
|
|
@@ -3403,7 +3565,11 @@ type CustomerEdge = {
|
|
|
3403
3565
|
/** The item at the end of CustomerEdge. */
|
|
3404
3566
|
node: Customer;
|
|
3405
3567
|
};
|
|
3406
|
-
/**
|
|
3568
|
+
/**
|
|
3569
|
+
* A customer's email address with marketing consent. This includes the email address, marketing subscription status, and opt-in level according to [M3AAWG best practices guidelines](https://www.m3aawg.org/news/updated-m3aawg-best-practices-for-senders-urge-opt-in-only-mailings-address-sender-transparency).
|
|
3570
|
+
*
|
|
3571
|
+
* It also provides the timestamp of when customers last updated marketing consent and URLs for unsubscribing from marketing emails or opting in or out of email open tracking. The [`sourceLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerEmailAddress#field-CustomerEmailAddress.fields.sourceLocation) field indicates where the customer consented to receive marketing material.
|
|
3572
|
+
*/
|
|
3407
3573
|
type CustomerEmailAddress = {
|
|
3408
3574
|
__typename?: 'CustomerEmailAddress';
|
|
3409
3575
|
/** The customer's default email address. */
|
|
@@ -3493,7 +3659,7 @@ declare enum CustomerEmailMarketingState {
|
|
|
3493
3659
|
/** The customer isn't currently subscribed to email marketing but was previously subscribed. */
|
|
3494
3660
|
Unsubscribed = "UNSUBSCRIBED"
|
|
3495
3661
|
}
|
|
3496
|
-
/**
|
|
3662
|
+
/** Tracks a customer's path to purchase through their online store visits. The journey captures key moments like shop sessions that led to the order, helping merchants understand customer behavior and marketing attribution within a 30-day window. Includes the first and last sessions before an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order), the time between initial visit and conversion, and the customer's order position in their purchase history. */
|
|
3497
3663
|
type CustomerJourney = {
|
|
3498
3664
|
__typename?: 'CustomerJourney';
|
|
3499
3665
|
/** The position of the current order within the customer's order history. */
|
|
@@ -3507,7 +3673,11 @@ type CustomerJourney = {
|
|
|
3507
3673
|
/** Events preceding a customer order, such as shop sessions. */
|
|
3508
3674
|
moments: Array<CustomerMoment>;
|
|
3509
3675
|
};
|
|
3510
|
-
/**
|
|
3676
|
+
/**
|
|
3677
|
+
* A [`CustomerJourney`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourney) through the online store leading up to an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). Tracks session data, attribution sources, and the timeline from first visit to purchase conversion.
|
|
3678
|
+
*
|
|
3679
|
+
* The summary includes the customer's position in their order history, days between first visit and order creation, and details about their first and last sessions. Use the [`moments`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourneySummary#field-moments) connection to access the complete timeline of customer interactions before the purchase.
|
|
3680
|
+
*/
|
|
3511
3681
|
type CustomerJourneySummary = {
|
|
3512
3682
|
__typename?: 'CustomerJourneySummary';
|
|
3513
3683
|
/** The position of the current order within the customer's order history. Test orders aren't included. */
|
|
@@ -3664,7 +3834,11 @@ type CustomerPaymentInstrumentBillingAddress = {
|
|
|
3664
3834
|
/** The zip or postal code of the address. */
|
|
3665
3835
|
zip?: Maybe<Scalars['String']['output']>;
|
|
3666
3836
|
};
|
|
3667
|
-
/**
|
|
3837
|
+
/**
|
|
3838
|
+
* A customer's saved payment method. Stores the payment instrument details and billing information for recurring charges.
|
|
3839
|
+
*
|
|
3840
|
+
* The payment method supports types included in the [`CustomerPaymentInstrument`](https://shopify.dev/docs/api/admin-graphql/latest/unions/CustomerPaymentInstrument) union.
|
|
3841
|
+
*/
|
|
3668
3842
|
type CustomerPaymentMethod = Node & {
|
|
3669
3843
|
__typename?: 'CustomerPaymentMethod';
|
|
3670
3844
|
/** The customer to whom the payment method belongs. */
|
|
@@ -3912,7 +4086,11 @@ type CustomerStatistics = {
|
|
|
3912
4086
|
/** The RFM (Recency, Frequency, Monetary) group of the customer. */
|
|
3913
4087
|
rfmGroup?: Maybe<CustomerRfmGroup>;
|
|
3914
4088
|
};
|
|
3915
|
-
/**
|
|
4089
|
+
/**
|
|
4090
|
+
* A customer's session on the online store. Tracks how the [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) arrived at the store, including the landing page, referral source, and any associated marketing campaigns.
|
|
4091
|
+
*
|
|
4092
|
+
* The visit captures attribution data such as [`UTMParameters`](https://shopify.dev/docs/api/admin-graphql/latest/objects/UTMParameters), referral codes, and the [`MarketingEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingEvent) that drove the session. This information helps merchants understand which marketing efforts successfully bring customers to their store.
|
|
4093
|
+
*/
|
|
3916
4094
|
type CustomerVisit = CustomerMoment & Node & {
|
|
3917
4095
|
__typename?: 'CustomerVisit';
|
|
3918
4096
|
/** A globally-unique ID. */
|
|
@@ -4055,7 +4233,16 @@ type DeliveryBrandedPromise = {
|
|
|
4055
4233
|
* "variant_id": 258644705304
|
|
4056
4234
|
* }],
|
|
4057
4235
|
* "currency": "USD",
|
|
4058
|
-
* "locale": "en"
|
|
4236
|
+
* "locale": "en",
|
|
4237
|
+
* "order_totals": {
|
|
4238
|
+
* "subtotal_price": "1999",
|
|
4239
|
+
* "total_price": "2199",
|
|
4240
|
+
* "discount_amount": "150"
|
|
4241
|
+
* },
|
|
4242
|
+
* "customer": {
|
|
4243
|
+
* "id": 207119551,
|
|
4244
|
+
* "tags": ["VIP", "wholesale"]
|
|
4245
|
+
* }
|
|
4059
4246
|
* }
|
|
4060
4247
|
* }
|
|
4061
4248
|
* ```
|
|
@@ -4087,7 +4274,15 @@ type DeliveryBrandedPromise = {
|
|
|
4087
4274
|
* "total_price": "3587",
|
|
4088
4275
|
* "currency": "USD",
|
|
4089
4276
|
* "min_delivery_date": "2013-04-12 14:48:45 -0400",
|
|
4090
|
-
* "max_delivery_date": "2013-04-12 14:48:45 -0400"
|
|
4277
|
+
* "max_delivery_date": "2013-04-12 14:48:45 -0400",
|
|
4278
|
+
* "metafields": [
|
|
4279
|
+
* {
|
|
4280
|
+
* "key": "tracking_url",
|
|
4281
|
+
* "value": "abc123",
|
|
4282
|
+
* "namespace": "carrier_service_metadata",
|
|
4283
|
+
* "type": "single_line_text_field"
|
|
4284
|
+
* }
|
|
4285
|
+
* ]
|
|
4091
4286
|
* }
|
|
4092
4287
|
* ]
|
|
4093
4288
|
* }
|
|
@@ -4111,12 +4306,13 @@ type DeliveryBrandedPromise = {
|
|
|
4111
4306
|
* | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
4112
4307
|
* | `service_name` | Yes | The name of the rate, which customers see at checkout. For example: `Expedited Mail`. |
|
|
4113
4308
|
* | `description` | Yes | A description of the rate, which customers see at checkout. For example: `Includes tracking and insurance`. |
|
|
4114
|
-
* | `service_code` | Yes | A unique code associated with the rate. For example: `expedited_mail`.
|
|
4309
|
+
* | `service_code` | Yes | A unique code associated with the rate that must be consistent across requests. For example: `expedited_mail`. |
|
|
4115
4310
|
* | `currency` | Yes | The currency of the shipping rate. |
|
|
4116
4311
|
* | `total_price` | Yes | The total price expressed in subunits. If the currency doesn't use subunits, then the value must be multiplied by 100. For example: `"total_price": 500` for 5.00 CAD, `"total_price": 100000` for 1000 JPY. |
|
|
4117
4312
|
* | `phone_required` | No | Whether the customer must provide a phone number at checkout. |
|
|
4118
4313
|
* | `min_delivery_date` | No | The earliest delivery date for the displayed rate. |
|
|
4119
4314
|
* | `max_delivery_date` | No | The latest delivery date for the displayed rate to still be valid. |
|
|
4315
|
+
* | `metafields` | No | An array of metafield objects to attach custom metadata to the shipping rate. |
|
|
4120
4316
|
*
|
|
4121
4317
|
* ### Special conditions
|
|
4122
4318
|
*
|
|
@@ -4124,6 +4320,7 @@ type DeliveryBrandedPromise = {
|
|
|
4124
4320
|
* * To force backup rates instead, return a 40x or 50x HTTP code with any content. A good choice is the regular 404 Not Found code.
|
|
4125
4321
|
* * Redirects (30x codes) will only be followed for the same domain as the original callback URL. Attempting to redirect to a different domain will trigger backup rates.
|
|
4126
4322
|
* * There is no retry mechanism. The response must be successful on the first try, within the time budget listed below. Timeouts or errors will trigger backup rates.
|
|
4323
|
+
* * The `service_code` must be stable and consistent across requests for the same shipping option. It should not contain dynamic values like session IDs, timestamps, or request-specific identifiers. Use metafields for passing dynamic or session-specific data.
|
|
4127
4324
|
*
|
|
4128
4325
|
* ## Response Timeouts
|
|
4129
4326
|
*
|
|
@@ -4343,7 +4540,11 @@ type DeliveryLocationGroupZoneEdge = {
|
|
|
4343
4540
|
/** The item at the end of DeliveryLocationGroupZoneEdge. */
|
|
4344
4541
|
node: DeliveryLocationGroupZone;
|
|
4345
4542
|
};
|
|
4346
|
-
/**
|
|
4543
|
+
/**
|
|
4544
|
+
* Information about the delivery method selected for a [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder). Includes the method type, expected delivery timeframe, and any additional information needed for delivery.
|
|
4545
|
+
*
|
|
4546
|
+
* The delivery method stores details from checkout such as the carrier, branded promises like Shop Promise, and the delivery option name shown to the buyer. Additional information like delivery instructions or contact phone numbers helps fulfill the [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) correctly.
|
|
4547
|
+
*/
|
|
4347
4548
|
type DeliveryMethod = Node & {
|
|
4348
4549
|
__typename?: 'DeliveryMethod';
|
|
4349
4550
|
/** The Additional information to consider when performing the delivery. */
|
|
@@ -4468,7 +4669,13 @@ type DeliveryProductVariantsCount = {
|
|
|
4468
4669
|
/** The product variant count. */
|
|
4469
4670
|
count: Scalars['Int']['output'];
|
|
4470
4671
|
};
|
|
4471
|
-
/**
|
|
4672
|
+
/**
|
|
4673
|
+
* A shipping profile that defines shipping rates for specific [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects and [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects. Delivery profiles determine which products can ship from which [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects to which zones, and at what rates.
|
|
4674
|
+
*
|
|
4675
|
+
* Profiles can associate with [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) objects to provide custom shipping rules for subscriptions, such as free shipping or restricted delivery zones. The default profile applies to all products that aren't assigned to other profiles.
|
|
4676
|
+
*
|
|
4677
|
+
* Learn more about [building delivery profiles](https://shopify.dev/apps/build/purchase-options/deferred/delivery-and-deferment/build-delivery-profiles).
|
|
4678
|
+
*/
|
|
4472
4679
|
type DeliveryProfile = Node & {
|
|
4473
4680
|
__typename?: 'DeliveryProfile';
|
|
4474
4681
|
/** The number of active shipping rates for the profile. */
|
|
@@ -4477,7 +4684,10 @@ type DeliveryProfile = Node & {
|
|
|
4477
4684
|
default: Scalars['Boolean']['output'];
|
|
4478
4685
|
/** A globally-unique ID. */
|
|
4479
4686
|
id: Scalars['ID']['output'];
|
|
4480
|
-
/**
|
|
4687
|
+
/**
|
|
4688
|
+
* Whether this shop has enabled legacy compatibility mode for delivery profiles.
|
|
4689
|
+
* @deprecated Legacy mode profiles are no longer supported.
|
|
4690
|
+
*/
|
|
4481
4691
|
legacyMode: Scalars['Boolean']['output'];
|
|
4482
4692
|
/** The number of locations without rates defined. */
|
|
4483
4693
|
locationsWithoutRatesCount: Scalars['Int']['output'];
|
|
@@ -4600,7 +4810,11 @@ declare enum DigitalWallet {
|
|
|
4600
4810
|
}
|
|
4601
4811
|
/** A discount offers promotional value and can be applied by entering a code or automatically when conditions are met. Discounts can provide fixed amounts, percentage reductions, free shipping, or Buy X Get Y (BXGY) benefits on specific products or the entire order. For more complex scenarios, developers can use Function-backed discounts to create custom discount configurations. */
|
|
4602
4812
|
type Discount = DiscountAutomaticApp | DiscountAutomaticBasic | DiscountAutomaticBxgy | DiscountAutomaticFreeShipping | DiscountCodeApp | DiscountCodeBasic | DiscountCodeBxgy | DiscountCodeFreeShipping;
|
|
4603
|
-
/**
|
|
4813
|
+
/**
|
|
4814
|
+
* The actual amount discounted on a line item or shipping line. While [`DiscountApplication`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/DiscountApplication) captures the discount's intentions and rules, The `DiscountAllocation` object shows the final calculated discount amount applied to each line.
|
|
4815
|
+
*
|
|
4816
|
+
* The allocation includes the discounted amount in both shop and presentment currencies, with a reference to the originating discount application.
|
|
4817
|
+
*/
|
|
4604
4818
|
type DiscountAllocation = {
|
|
4605
4819
|
__typename?: 'DiscountAllocation';
|
|
4606
4820
|
/**
|
|
@@ -4693,7 +4907,11 @@ declare enum DiscountApplicationTargetType {
|
|
|
4693
4907
|
/** The discount applies onto shipping lines. */
|
|
4694
4908
|
ShippingLine = "SHIPPING_LINE"
|
|
4695
4909
|
}
|
|
4696
|
-
/**
|
|
4910
|
+
/**
|
|
4911
|
+
* The types of automatic discounts applied in the cart and at checkout when an order meets specific criteria.
|
|
4912
|
+
*
|
|
4913
|
+
* Includes [`DiscountAutomaticApp`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticApp) for custom logic using the [Discount Function API](https://shopify.dev/docs/api/functions/latest/discount), [`DiscountAutomaticBasic`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBasic) for percentage or fixed amount reductions, [`DiscountAutomaticBxgy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBxgy) for Buy X Get Y promotions, and [`DiscountAutomaticFreeShipping`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticFreeShipping) for delivery incentives.
|
|
4914
|
+
*/
|
|
4697
4915
|
type DiscountAutomatic = DiscountAutomaticApp | DiscountAutomaticBasic | DiscountAutomaticBxgy | DiscountAutomaticFreeShipping;
|
|
4698
4916
|
/**
|
|
4699
4917
|
* The `DiscountAutomaticApp` object stores information about automatic discounts
|
|
@@ -5725,7 +5943,13 @@ type DiscountCountryAll = {
|
|
|
5725
5943
|
/** Whether the discount can be applied to all countries as shipping destination. This value is always `true`. */
|
|
5726
5944
|
allCountries: Scalars['Boolean']['output'];
|
|
5727
5945
|
};
|
|
5728
|
-
/**
|
|
5946
|
+
/**
|
|
5947
|
+
* Creates the broadest possible discount reach by targeting all customers, regardless of their purchase history or segment membership. This gives merchants maximum flexibility to run store-wide promotions without worrying about customer eligibility restrictions.
|
|
5948
|
+
*
|
|
5949
|
+
* For example, a flash sale or grand opening promotion would target all customers to maximize participation and store visibility.
|
|
5950
|
+
*
|
|
5951
|
+
* Learn more about [customer targeting](https://help.shopify.com/manual/discounts/).
|
|
5952
|
+
*/
|
|
5729
5953
|
type DiscountCustomerAll = {
|
|
5730
5954
|
__typename?: 'DiscountCustomerAll';
|
|
5731
5955
|
/** Whether the discount can be applied by all customers. This value is always `true`. */
|
|
@@ -5778,7 +6002,21 @@ type DiscountCustomerSegments = {
|
|
|
5778
6002
|
};
|
|
5779
6003
|
/** The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers. */
|
|
5780
6004
|
type DiscountCustomerSelection = DiscountCustomerAll | DiscountCustomerSegments | DiscountCustomers;
|
|
5781
|
-
/**
|
|
6005
|
+
/**
|
|
6006
|
+
* Defines customer targeting for discounts through specific individual customers. This object allows merchants to create exclusive discounts that are only available to explicitly selected customers.
|
|
6007
|
+
*
|
|
6008
|
+
* For example, a VIP customer appreciation discount might target specific high-value customers by individually selecting them, or a beta program discount could be offered to selected early adopters.
|
|
6009
|
+
*
|
|
6010
|
+
* Use `DiscountCustomers` to:
|
|
6011
|
+
* - Target specific individual customers for exclusive promotions
|
|
6012
|
+
* - Create personalized discount experiences for selected customers
|
|
6013
|
+
* - Offer special discounts to VIP or loyal customers
|
|
6014
|
+
* - Provide exclusive access to promotions for specific individuals
|
|
6015
|
+
*
|
|
6016
|
+
* This targeting method requires you to add each customer who should be eligible for the discount. For broader targeting based on customer attributes or segments, use [`DiscountCustomerSegments`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerSegments) instead.
|
|
6017
|
+
*
|
|
6018
|
+
* Learn more about creating customer-specific discounts using [`discountCodeBasicCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBasicCreate) and [`discountCodeBasicUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBasicUpdate).
|
|
6019
|
+
*/
|
|
5782
6020
|
type DiscountCustomers = {
|
|
5783
6021
|
__typename?: 'DiscountCustomers';
|
|
5784
6022
|
/** The list of individual customers eligible for the discount. */
|
|
@@ -5788,7 +6026,13 @@ type DiscountCustomers = {
|
|
|
5788
6026
|
type DiscountEffect = DiscountAmount | DiscountPercentage;
|
|
5789
6027
|
/** The type used to target the items required for discount eligibility, or the items to which the application of a discount might apply. For example, for a customer to be eligible for a discount, they're required to add an item from a specified collection to their order. Alternatively, a customer might be required to add a specific product or product variant. When using this type to target which items the discount will apply to, the discount might apply to all items on the order, or to specific products and product variants, or items in a given collection. */
|
|
5790
6028
|
type DiscountItems = AllDiscountItems | DiscountCollections | DiscountProducts;
|
|
5791
|
-
/**
|
|
6029
|
+
/**
|
|
6030
|
+
* Specifies the minimum item quantity required for discount eligibility, helping merchants create volume-based promotions that encourage larger purchases. This threshold applies to qualifying items in the customer's cart.
|
|
6031
|
+
*
|
|
6032
|
+
* For example, a "Buy 3, Get 10% Off" promotion would set the minimum quantity to 3 items.
|
|
6033
|
+
*
|
|
6034
|
+
* Learn more about [discount requirements](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountApplication).
|
|
6035
|
+
*/
|
|
5792
6036
|
type DiscountMinimumQuantity = {
|
|
5793
6037
|
__typename?: 'DiscountMinimumQuantity';
|
|
5794
6038
|
/** The minimum quantity of items that's required for the discount to be applied. */
|
|
@@ -5855,7 +6099,13 @@ type DiscountOnQuantity = {
|
|
|
5855
6099
|
/** The number of items being discounted. The customer must have at least this many items of specified products or product variants in their order to be eligible for the discount. */
|
|
5856
6100
|
quantity: DiscountQuantity;
|
|
5857
6101
|
};
|
|
5858
|
-
/**
|
|
6102
|
+
/**
|
|
6103
|
+
* Creates percentage-based discounts that reduce item prices by a specified percentage amount. This gives merchants a flexible way to offer proportional savings that automatically scale with order value.
|
|
6104
|
+
*
|
|
6105
|
+
* For example, a "20% off all winter clothing" promotion would use this object to apply consistent percentage savings across different price points.
|
|
6106
|
+
*
|
|
6107
|
+
* Learn more about [discount types](https://help.shopify.com/manual/discounts/).
|
|
6108
|
+
*/
|
|
5859
6109
|
type DiscountPercentage = {
|
|
5860
6110
|
__typename?: 'DiscountPercentage';
|
|
5861
6111
|
/** The percentage value of the discount. */
|
|
@@ -6094,7 +6344,7 @@ type DraftOrder = CommentEventSubject & HasEvents & HasLocalizationExtensions &
|
|
|
6094
6344
|
lineItems: DraftOrderLineItemConnection;
|
|
6095
6345
|
/**
|
|
6096
6346
|
* A subtotal of the line items and corresponding discounts,
|
|
6097
|
-
* excluding
|
|
6347
|
+
* excluding shipping charges, shipping discounts, taxes, or order discounts.
|
|
6098
6348
|
*/
|
|
6099
6349
|
lineItemsSubtotalPrice: MoneyBag;
|
|
6100
6350
|
/**
|
|
@@ -6177,7 +6427,7 @@ type DraftOrder = CommentEventSubject & HasEvents & HasLocalizationExtensions &
|
|
|
6177
6427
|
taxesIncluded: Scalars['Boolean']['output'];
|
|
6178
6428
|
/** Total discounts. */
|
|
6179
6429
|
totalDiscountsSet: MoneyBag;
|
|
6180
|
-
/** Total price of line items. */
|
|
6430
|
+
/** Total price of line items, excluding discounts. */
|
|
6181
6431
|
totalLineItemsPriceSet: MoneyBag;
|
|
6182
6432
|
/**
|
|
6183
6433
|
* The total price, in shop currency, includes taxes, shipping charges, and discounts.
|
|
@@ -6275,7 +6525,11 @@ type DraftOrderEdge = {
|
|
|
6275
6525
|
/** The item at the end of DraftOrderEdge. */
|
|
6276
6526
|
node: DraftOrder;
|
|
6277
6527
|
};
|
|
6278
|
-
/**
|
|
6528
|
+
/**
|
|
6529
|
+
* A line item in a draft order. Line items are either [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects or custom items created manually with specific pricing and attributes.
|
|
6530
|
+
*
|
|
6531
|
+
* Each line item includes [quantity](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem#field-DraftOrderLineItem.fields.quantity), [pricing](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem#field-DraftOrderLineItem.fields.originalUnitPrice), [discounts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem#field-DraftOrderLineItem.fields.discountedTotal), [tax information](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem#field-DraftOrderLineItem.fields.taxLines), and [custom attributes](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem#field-DraftOrderLineItem.fields.customAttributes). For [bundle products](https://shopify.dev/docs/apps/build/products/bundles), the line item includes components that define the individual products within the bundle.
|
|
6532
|
+
*/
|
|
6279
6533
|
type DraftOrderLineItem = Node & {
|
|
6280
6534
|
__typename?: 'DraftOrderLineItem';
|
|
6281
6535
|
/** The custom applied discount. */
|
|
@@ -7834,7 +8088,12 @@ type FulfillmentService = {
|
|
|
7834
8088
|
inventoryManagement: Scalars['Boolean']['output'];
|
|
7835
8089
|
/** Location associated with the fulfillment service. */
|
|
7836
8090
|
location?: Maybe<Location>;
|
|
7837
|
-
/**
|
|
8091
|
+
/**
|
|
8092
|
+
* Whether the fulfillment service can stock inventory alongside other locations.
|
|
8093
|
+
* @deprecated Fulfillment services are all migrating to permit SKU sharing.
|
|
8094
|
+
* Setting permits SKU sharing to false [is no longer supported](https://shopify.dev/changelog/setting-permitsskusharing-argument-to-false-when-creating-a-fulfillment-service-returns-an-error).
|
|
8095
|
+
*
|
|
8096
|
+
*/
|
|
7838
8097
|
permitsSkuSharing: Scalars['Boolean']['output'];
|
|
7839
8098
|
/** Whether the fulfillment service requires products to be physically shipped. */
|
|
7840
8099
|
requiresShippingMethod: Scalars['Boolean']['output'];
|
|
@@ -8099,7 +8358,13 @@ type GenericFile = File & Node & {
|
|
|
8099
8358
|
/** The generic file's URL. */
|
|
8100
8359
|
url?: Maybe<Scalars['URL']['output']>;
|
|
8101
8360
|
};
|
|
8102
|
-
/**
|
|
8361
|
+
/**
|
|
8362
|
+
* A gift card that customers use as a payment method. Stores the initial value, current balance, and expiration date.
|
|
8363
|
+
*
|
|
8364
|
+
* You can issue gift cards to a specific [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) or send them to a [`GiftCardRecipient`](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardRecipient) with a personalized message. The card tracks its transaction history through [`GiftCardCreditTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardCreditTransaction) and [`GiftCardDebitTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardDebitTransaction) records. You can create and deactivate gift cards using the [`GiftCardCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardCreate) and [`GiftCardDeactivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardDeactivate) mutations, respectively.
|
|
8365
|
+
*
|
|
8366
|
+
* > Note: After a gift card is deactivated, it can't be used for further purchases or re-enabled.
|
|
8367
|
+
*/
|
|
8103
8368
|
type GiftCard = Node & {
|
|
8104
8369
|
__typename?: 'GiftCard';
|
|
8105
8370
|
/** The gift card's remaining balance. */
|
|
@@ -8339,9 +8604,9 @@ declare enum InclusiveTaxPricingStrategy {
|
|
|
8339
8604
|
IncludesTaxesInPriceBasedOnCountry = "INCLUDES_TAXES_IN_PRICE_BASED_ON_COUNTRY"
|
|
8340
8605
|
}
|
|
8341
8606
|
/**
|
|
8342
|
-
*
|
|
8343
|
-
*
|
|
8344
|
-
* Learn
|
|
8607
|
+
* A [product variant's](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) inventory information across all locations. The inventory item connects the product variant to its [inventory levels](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) at different locations, tracking stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information for the product.
|
|
8608
|
+
*
|
|
8609
|
+
* Learn more about [inventory object relationships](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).
|
|
8345
8610
|
*/
|
|
8346
8611
|
type InventoryItem = LegacyInteroperability & Node & {
|
|
8347
8612
|
__typename?: 'InventoryItem';
|
|
@@ -8404,7 +8669,7 @@ type InventoryItemEdge = {
|
|
|
8404
8669
|
/** The item at the end of InventoryItemEdge. */
|
|
8405
8670
|
node: InventoryItem;
|
|
8406
8671
|
};
|
|
8407
|
-
/**
|
|
8672
|
+
/** Weight information for an [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) when packaged. Provides the weight specification used for inventory management and shipping calculations. Learn more about [managing inventory](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps). */
|
|
8408
8673
|
type InventoryItemMeasurement = Node & {
|
|
8409
8674
|
__typename?: 'InventoryItemMeasurement';
|
|
8410
8675
|
/** A globally-unique ID. */
|
|
@@ -8413,8 +8678,9 @@ type InventoryItemMeasurement = Node & {
|
|
|
8413
8678
|
weight?: Maybe<Weight>;
|
|
8414
8679
|
};
|
|
8415
8680
|
/**
|
|
8416
|
-
* The quantities of an inventory item
|
|
8417
|
-
*
|
|
8681
|
+
* The quantities of an inventory item at a specific location. Each inventory level connects one [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) to one [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location), tracking multiple quantity states like available, on-hand, incoming, and committed.
|
|
8682
|
+
*
|
|
8683
|
+
* The [`quantities`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel#field-InventoryLevel.fields.quantities) field provides access to different inventory states. Learn [more about inventory states and relationships](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).
|
|
8418
8684
|
*/
|
|
8419
8685
|
type InventoryLevel = Node & {
|
|
8420
8686
|
__typename?: 'InventoryLevel';
|
|
@@ -8430,7 +8696,10 @@ type InventoryLevel = Node & {
|
|
|
8430
8696
|
item: InventoryItem;
|
|
8431
8697
|
/** The location associated with the inventory level. */
|
|
8432
8698
|
location: Location;
|
|
8433
|
-
/**
|
|
8699
|
+
/**
|
|
8700
|
+
* The quantity of an inventory item at a specific location, for a quantity
|
|
8701
|
+
* [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states).
|
|
8702
|
+
*/
|
|
8434
8703
|
quantities: Array<InventoryQuantity>;
|
|
8435
8704
|
/** Scheduled changes for the requested quantity names. */
|
|
8436
8705
|
scheduledChanges: InventoryScheduledChangeConnection;
|
|
@@ -8455,19 +8724,30 @@ type InventoryLevelEdge = {
|
|
|
8455
8724
|
/** The item at the end of InventoryLevelEdge. */
|
|
8456
8725
|
node: InventoryLevel;
|
|
8457
8726
|
};
|
|
8458
|
-
/**
|
|
8727
|
+
/**
|
|
8728
|
+
* The `InventoryQuantity` object lets you manage and track inventory quantities for specific [states](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states).
|
|
8729
|
+
* Inventory quantities represent different states of items such as available for purchase, committed to orders, reserved for drafts, incoming from suppliers, or set aside for quality control or safety stock.
|
|
8730
|
+
*
|
|
8731
|
+
* You can use [inventory levels](https://shopify.dev/docs/api/admin-graphql/latest/objects/inventorylevel) to manage where inventory items are stocked. You can also [make inventory adjustments](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) to apply changes to inventory quantities.
|
|
8732
|
+
*
|
|
8733
|
+
* Inventory quantities can be managed by a merchant or by [fulfillment services](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentservice) that handle inventory tracking.
|
|
8734
|
+
* Learn more about working with [Shopify's inventory management system](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps).
|
|
8735
|
+
*/
|
|
8459
8736
|
type InventoryQuantity = Node & {
|
|
8460
8737
|
__typename?: 'InventoryQuantity';
|
|
8461
8738
|
/** A globally-unique ID. */
|
|
8462
8739
|
id: Scalars['ID']['output'];
|
|
8463
8740
|
/**
|
|
8464
|
-
* The [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)
|
|
8741
|
+
* The inventory state [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states)
|
|
8465
8742
|
* that identifies the inventory quantity.
|
|
8466
8743
|
*/
|
|
8467
8744
|
name: Scalars['String']['output'];
|
|
8468
|
-
/**
|
|
8745
|
+
/**
|
|
8746
|
+
* The quantity of an inventory item at a specific location, for a quantity
|
|
8747
|
+
* [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states).
|
|
8748
|
+
*/
|
|
8469
8749
|
quantity: Scalars['Int']['output'];
|
|
8470
|
-
/** When the quantity was last updated. */
|
|
8750
|
+
/** When the inventory quantity was last updated. */
|
|
8471
8751
|
updatedAt?: Maybe<Scalars['DateTime']['output']>;
|
|
8472
8752
|
};
|
|
8473
8753
|
/** Returns the scheduled changes to inventory states related to the ledger document. */
|
|
@@ -8726,7 +9006,13 @@ type LineItemEdge = {
|
|
|
8726
9006
|
/** The item at the end of LineItemEdge. */
|
|
8727
9007
|
node: LineItem;
|
|
8728
9008
|
};
|
|
8729
|
-
/**
|
|
9009
|
+
/**
|
|
9010
|
+
* The information for [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) that are part of a bundle. When a bundle is purchased, each component line item references its [`LineItemGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItemGroup) through the [`lineItemGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem#field-lineItemGroup) field to maintain the relationship with the bundle.
|
|
9011
|
+
*
|
|
9012
|
+
* The parent bundle's product, variant, and custom attributes enable apps to group and display bundle components in order management systems, transactional emails, and other contexts where understanding the bundle structure is needed.
|
|
9013
|
+
*
|
|
9014
|
+
* Learn more about [product bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles).
|
|
9015
|
+
*/
|
|
8730
9016
|
type LineItemGroup = Node & {
|
|
8731
9017
|
__typename?: 'LineItemGroup';
|
|
8732
9018
|
/** A list of attributes that represent custom features or special requests. */
|
|
@@ -9176,9 +9462,9 @@ type LocationsCondition = {
|
|
|
9176
9462
|
locations: LocationConnection;
|
|
9177
9463
|
};
|
|
9178
9464
|
/**
|
|
9179
|
-
*
|
|
9465
|
+
* A physical mailing address. For example, a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)'s default address and an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order)'s billing address are both mailing addresses. Stores standard address components, customer name information, and company details.
|
|
9180
9466
|
*
|
|
9181
|
-
*
|
|
9467
|
+
* The address includes geographic coordinates ([`latitude`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress#field-MailingAddress.fields.latitude) and [`longitude`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress#field-MailingAddress.fields.longitude)). You can format addresses for display using the [`formatted`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress#field-MailingAddress.fields.formatted) field with options to include or exclude name and company information.
|
|
9182
9468
|
*/
|
|
9183
9469
|
type MailingAddress = Node & {
|
|
9184
9470
|
__typename?: 'MailingAddress';
|
|
@@ -9362,7 +9648,13 @@ type Market = HasMetafieldDefinitions & HasMetafields & Node & {
|
|
|
9362
9648
|
*/
|
|
9363
9649
|
webPresences: MarketWebPresenceConnection;
|
|
9364
9650
|
};
|
|
9365
|
-
/**
|
|
9651
|
+
/**
|
|
9652
|
+
* A catalog for managing product availability and pricing for specific [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) contexts. Each catalog links to one or more markets and defines what [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects customers see through its [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) settings. The catalog can include a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for market-specific pricing adjustments.
|
|
9653
|
+
*
|
|
9654
|
+
* Use catalogs to create distinct shopping experiences for different geographic regions or customer segments.
|
|
9655
|
+
*
|
|
9656
|
+
* Learn more about [building a catalog](https://shopify.dev/docs/apps/build/markets/build-catalog) and [managing markets](https://shopify.dev/docs/apps/build/markets).
|
|
9657
|
+
*/
|
|
9366
9658
|
type MarketCatalog = Catalog & Node & {
|
|
9367
9659
|
__typename?: 'MarketCatalog';
|
|
9368
9660
|
/** A globally-unique ID. */
|
|
@@ -10017,7 +10309,7 @@ type MerchantApprovalSignals = {
|
|
|
10017
10309
|
};
|
|
10018
10310
|
/**
|
|
10019
10311
|
* Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection).
|
|
10020
|
-
* For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin
|
|
10312
|
+
* For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin-graphql/latest/interfaces/HasMetafields).
|
|
10021
10313
|
* Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers.
|
|
10022
10314
|
* Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.
|
|
10023
10315
|
*/
|
|
@@ -10054,7 +10346,7 @@ type Metafield = HasCompareDigest & LegacyInteroperability & Node & {
|
|
|
10054
10346
|
/** A list of reference objects if the metafield's type is a resource reference list. */
|
|
10055
10347
|
references?: Maybe<MetafieldReferenceConnection>;
|
|
10056
10348
|
/**
|
|
10057
|
-
* The type of data that
|
|
10349
|
+
* The type of data that's stored in the metafield.
|
|
10058
10350
|
* Refer to the list of [supported types](https://shopify.dev/apps/metafields/types).
|
|
10059
10351
|
*/
|
|
10060
10352
|
type: Scalars['String']['output'];
|
|
@@ -10161,8 +10453,9 @@ declare enum MetafieldCustomerAccountAccess {
|
|
|
10161
10453
|
ReadWrite = "READ_WRITE"
|
|
10162
10454
|
}
|
|
10163
10455
|
/**
|
|
10164
|
-
* Metafield
|
|
10165
|
-
*
|
|
10456
|
+
* Defines the structure, validation rules, and permissions for [`Metafield`](https://shopify.dev/docs/api/admin-graphql/current/objects/Metafield) objects attached to a specific owner type. Each definition establishes a schema that metafields must follow, including the data type and validation constraints.
|
|
10457
|
+
*
|
|
10458
|
+
* The definition controls access permissions across different APIs, determines whether the metafield can be used for filtering or as a collection condition, and can be constrained to specific resource subtypes.
|
|
10166
10459
|
*/
|
|
10167
10460
|
type MetafieldDefinition = Node & {
|
|
10168
10461
|
__typename?: 'MetafieldDefinition';
|
|
@@ -10488,7 +10781,11 @@ declare enum MetafieldValueType {
|
|
|
10488
10781
|
/** A text field. */
|
|
10489
10782
|
String = "STRING"
|
|
10490
10783
|
}
|
|
10491
|
-
/**
|
|
10784
|
+
/**
|
|
10785
|
+
* An instance of custom structured data defined by a [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition). [Metaobjects](https://shopify.dev/docs/apps/build/custom-data#what-are-metaobjects) store reusable data that extends beyond Shopify's standard resources, such as product highlights, size charts, or custom content sections.
|
|
10786
|
+
*
|
|
10787
|
+
* Each metaobject includes fields that match the field types and validation rules specified in its definition, which also determines the metaobject's capabilities, such as storefront visibility, publishing and translation support. [`Metafields`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) can reference metaobjects to connect custom data with [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects, [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) objects, and other Shopify resources.
|
|
10788
|
+
*/
|
|
10492
10789
|
type Metaobject = Node & {
|
|
10493
10790
|
__typename?: 'Metaobject';
|
|
10494
10791
|
/** Metaobject capabilities for this Metaobject. */
|
|
@@ -10646,7 +10943,11 @@ type MetaobjectConnection = {
|
|
|
10646
10943
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
10647
10944
|
pageInfo: PageInfo;
|
|
10648
10945
|
};
|
|
10649
|
-
/**
|
|
10946
|
+
/**
|
|
10947
|
+
* Defines the structure and configuration for a custom data type in Shopify. Each definition specifies the fields, validation rules, and capabilities that apply to all [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) entries created from it.
|
|
10948
|
+
*
|
|
10949
|
+
* The definition includes field definitions that determine what data to store, access controls for [the Shopify admin](https://shopify.dev/docs/apps/build/custom-data/permissions#admin-permissions) and [Storefront](https://shopify.dev/docs/apps/build/custom-data/permissions#storefront-permissions) APIs, and capabilities such as publishability and translatability. You can track which [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) or [`StaffMember`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) created the definition and optionally base it on a [`StandardMetaobjectDefinitionTemplate`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StandardMetaobjectDefinitionTemplate).
|
|
10950
|
+
*/
|
|
10650
10951
|
type MetaobjectDefinition = Node & {
|
|
10651
10952
|
__typename?: 'MetaobjectDefinition';
|
|
10652
10953
|
/** Access configuration for the metaobject definition. */
|
|
@@ -10810,10 +11111,7 @@ type Model3dSource = {
|
|
|
10810
11111
|
/** The 3d model source's URL. */
|
|
10811
11112
|
url: Scalars['String']['output'];
|
|
10812
11113
|
};
|
|
10813
|
-
/**
|
|
10814
|
-
* A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions,
|
|
10815
|
-
* when an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency).
|
|
10816
|
-
*/
|
|
11114
|
+
/** A collection of monetary values in their respective currencies. Used throughout the API for multi-currency pricing and transactions, when an amount in the shop's currency is converted to the customer's currency of choice. The `presentmentMoney` field contains the amount in the customer's selected currency. The `shopMoney` field contains the equivalent in the shop's base currency. */
|
|
10817
11115
|
type MoneyBag = {
|
|
10818
11116
|
__typename?: 'MoneyBag';
|
|
10819
11117
|
/** Amount in presentment currency. */
|
|
@@ -10821,7 +11119,7 @@ type MoneyBag = {
|
|
|
10821
11119
|
/** Amount in shop currency. */
|
|
10822
11120
|
shopMoney: MoneyV2;
|
|
10823
11121
|
};
|
|
10824
|
-
/** A precise monetary value and its associated currency. For example, 12.99 USD. */
|
|
11122
|
+
/** A precise monetary value and its associated currency. Combines a decimal amount with a three-letter currency code to express prices, costs, and other financial values throughout the API. For example, 12.99 USD. */
|
|
10825
11123
|
type MoneyV2 = {
|
|
10826
11124
|
__typename?: 'MoneyV2';
|
|
10827
11125
|
/**
|
|
@@ -11562,7 +11860,11 @@ type OrderAdjustmentEdge = {
|
|
|
11562
11860
|
/** The item at the end of OrderAdjustmentEdge. */
|
|
11563
11861
|
node: OrderAdjustment;
|
|
11564
11862
|
};
|
|
11565
|
-
/**
|
|
11863
|
+
/**
|
|
11864
|
+
* Identifies the [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) that created an order. Common sources include "online store" for web purchases, "Point of Sale" for in-person sales, or custom app names for orders created through third-party integrations.
|
|
11865
|
+
*
|
|
11866
|
+
* Use this information to track order attribution, analyze sales channels, and route orders to appropriate fulfillment workflows based on their source.
|
|
11867
|
+
*/
|
|
11566
11868
|
type OrderApp = {
|
|
11567
11869
|
__typename?: 'OrderApp';
|
|
11568
11870
|
/** The application icon. */
|
|
@@ -12010,7 +12312,11 @@ declare enum OrderTransactionStatus {
|
|
|
12010
12312
|
/** The transaction status is unknown. */
|
|
12011
12313
|
Unknown = "UNKNOWN"
|
|
12012
12314
|
}
|
|
12013
|
-
/**
|
|
12315
|
+
/**
|
|
12316
|
+
* A standalone content page in the online store. Pages display HTML-formatted content for informational pages like "About Us", contact information, or shipping policies.
|
|
12317
|
+
*
|
|
12318
|
+
* Each page has a unique handle for URL routing and supports custom template suffixes for specialized layouts. Pages can be published or hidden, and include creation and update timestamps.
|
|
12319
|
+
*/
|
|
12014
12320
|
type Page = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & Navigable & Node & {
|
|
12015
12321
|
__typename?: 'Page';
|
|
12016
12322
|
/** The text content of the page, complete with HTML markup. */
|
|
@@ -12197,7 +12503,13 @@ type PaymentSettings = {
|
|
|
12197
12503
|
/** List of the digital wallets which the shop supports. */
|
|
12198
12504
|
supportedDigitalWallets: Array<DigitalWallet>;
|
|
12199
12505
|
};
|
|
12200
|
-
/**
|
|
12506
|
+
/**
|
|
12507
|
+
* Payment conditions for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) or [`DraftOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder), including when payment is due and how it's scheduled. Payment terms are created from templates that specify net terms (payment due after a certain number of days) or fixed schedules with specific due dates. You can optionally provide custom payment schedules using [`PaymentScheduleInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/PaymentScheduleInput).
|
|
12508
|
+
*
|
|
12509
|
+
* Each payment term contains one or more [`PaymentSchedule`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentSchedule), which you can access through the [`paymentSchedules`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms#field-PaymentTerms.fields.paymentSchedules) field. Payment schedules contain detailed information for each payment installment.
|
|
12510
|
+
*
|
|
12511
|
+
* Learn more about [payment terms](https://shopify.dev/docs/apps/build/checkout/payments/payment-terms).
|
|
12512
|
+
*/
|
|
12201
12513
|
type PaymentTerms = Node & {
|
|
12202
12514
|
__typename?: 'PaymentTerms';
|
|
12203
12515
|
/** The draft order associated with the payment terms. */
|
|
@@ -12761,7 +13073,7 @@ type Product = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishe
|
|
|
12761
13073
|
updatedAt: Scalars['DateTime']['output'];
|
|
12762
13074
|
/**
|
|
12763
13075
|
* A list of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) associated with the product.
|
|
12764
|
-
* If querying a single product at the root, you can fetch up to
|
|
13076
|
+
* If querying a single product at the root, you can fetch up to 2048 variants.
|
|
12765
13077
|
*/
|
|
12766
13078
|
variants: ProductVariantConnection;
|
|
12767
13079
|
/**
|
|
@@ -12859,7 +13171,7 @@ type ProductBundleComponentQuantityOptionValue = {
|
|
|
12859
13171
|
/** The quantity of the option value. */
|
|
12860
13172
|
quantity: Scalars['Int']['output'];
|
|
12861
13173
|
};
|
|
12862
|
-
/** The details of a specific product category within
|
|
13174
|
+
/** The details of a specific product category within Shopify's [standardized product taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). Provides access to the associated [`ProductTaxonomyNode`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductTaxonomyNode). */
|
|
12863
13175
|
type ProductCategory = {
|
|
12864
13176
|
__typename?: 'ProductCategory';
|
|
12865
13177
|
/** The product taxonomy node associated with the product category. */
|
|
@@ -12883,12 +13195,7 @@ type ProductConnection = {
|
|
|
12883
13195
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
12884
13196
|
pageInfo: PageInfo;
|
|
12885
13197
|
};
|
|
12886
|
-
/**
|
|
12887
|
-
* The price of a product in a specific country.
|
|
12888
|
-
* Prices vary between countries.
|
|
12889
|
-
* Refer to [Product](https://shopify.dev/docs/api/admin-graphql/latest/queries/product?example=Get+the+price+range+for+a+product+for+buyers+from+Canada)
|
|
12890
|
-
* for more information on how to use this object.
|
|
12891
|
-
*/
|
|
13198
|
+
/** The price of a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) in a specific country. Shows the minimum and maximum variant prices through the price range and the count of fixed quantity rules that apply to the product's variants in the given pricing context. */
|
|
12892
13199
|
type ProductContextualPricing = {
|
|
12893
13200
|
__typename?: 'ProductContextualPricing';
|
|
12894
13201
|
/** The number of fixed quantity rules for the product's variants on the price list. */
|
|
@@ -12913,9 +13220,9 @@ type ProductEdge = {
|
|
|
12913
13220
|
node: Product;
|
|
12914
13221
|
};
|
|
12915
13222
|
/**
|
|
12916
|
-
*
|
|
12917
|
-
*
|
|
12918
|
-
* The
|
|
13223
|
+
* A product attribute that customers can choose from, such as "Size", "Color", or "Material". [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects use options to define the different variations available for purchase. Each option has a name and a set of possible values that combine to create [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects.
|
|
13224
|
+
*
|
|
13225
|
+
* The option includes its display position, associated values, and optional [`LinkedMetafield`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LinkedMetafield) for structured data. Options support translations for international selling and track which [`ProductOptionValue`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue) objects that variants actively use versus unused values that exist without associated variants.
|
|
12919
13226
|
*/
|
|
12920
13227
|
type ProductOption = HasPublishedTranslations & Node & {
|
|
12921
13228
|
__typename?: 'ProductOption';
|
|
@@ -12934,7 +13241,11 @@ type ProductOption = HasPublishedTranslations & Node & {
|
|
|
12934
13241
|
/** The corresponding value to the product option name. */
|
|
12935
13242
|
values: Array<Scalars['String']['output']>;
|
|
12936
13243
|
};
|
|
12937
|
-
/**
|
|
13244
|
+
/**
|
|
13245
|
+
* A specific value for a [`ProductOption`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption), such as "Red" or "Blue" for a "Color" option. Each value can be assigned to [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects to create different versions of a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product).
|
|
13246
|
+
*
|
|
13247
|
+
* The value tracks whether any variants currently use it through the [`hasVariants`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue#field-hasVariants) field. Values can include visual representations through swatches that display colors or images. When linked to a [`Metafield`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield), the [`linkedMetafieldValue`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue#field-linkedMetafieldValue) provides additional structured data for the option value.
|
|
13248
|
+
*/
|
|
12938
13249
|
type ProductOptionValue = HasPublishedTranslations & Node & {
|
|
12939
13250
|
__typename?: 'ProductOptionValue';
|
|
12940
13251
|
/** Whether the product option value has any linked variants. */
|
|
@@ -13078,7 +13389,10 @@ type ProductVariant = HasEvents & HasMetafieldDefinitions & HasMetafields & HasP
|
|
|
13078
13389
|
events: EventConnection;
|
|
13079
13390
|
/** A globally-unique ID. */
|
|
13080
13391
|
id: Scalars['ID']['output'];
|
|
13081
|
-
/**
|
|
13392
|
+
/**
|
|
13393
|
+
* The featured image for the variant.
|
|
13394
|
+
* @deprecated Use `media` instead.
|
|
13395
|
+
*/
|
|
13082
13396
|
image?: Maybe<Image>;
|
|
13083
13397
|
/** The inventory item, which is used to query for inventory information. */
|
|
13084
13398
|
inventoryItem: InventoryItem;
|
|
@@ -13334,7 +13648,13 @@ declare enum ProductVariantsBulkUpdateUserErrorCode {
|
|
|
13334
13648
|
/** The variant already exists. */
|
|
13335
13649
|
VariantAlreadyExists = "VARIANT_ALREADY_EXISTS"
|
|
13336
13650
|
}
|
|
13337
|
-
/**
|
|
13651
|
+
/**
|
|
13652
|
+
* A group of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) that are published to an app.
|
|
13653
|
+
*
|
|
13654
|
+
* Each publication manages which products and collections display on its associated [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel). Merchants can automatically publish products when they're created if [`autoPublish`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication#field-Publication.fields.autoPublish) is enabled, or manually control publication through publication records.
|
|
13655
|
+
*
|
|
13656
|
+
* Publications support scheduled publishing through future publish dates for online store channels, allowing merchants to coordinate product launches and promotional campaigns. The [`catalog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication#field-Publication.fields.catalog) field links to pricing and availability rules specific to that publication's context.
|
|
13657
|
+
*/
|
|
13338
13658
|
type Publication = Node & {
|
|
13339
13659
|
__typename?: 'Publication';
|
|
13340
13660
|
/**
|
|
@@ -13346,7 +13666,7 @@ type Publication = Node & {
|
|
|
13346
13666
|
autoPublish: Scalars['Boolean']['output'];
|
|
13347
13667
|
/** The catalog associated with the publication. */
|
|
13348
13668
|
catalog?: Maybe<Catalog>;
|
|
13349
|
-
/** The collection
|
|
13669
|
+
/** The list of collection publication records, each representing the publication status and details for a collection published to this publication (typically channel). */
|
|
13350
13670
|
collectionPublicationsV3: ResourcePublicationConnection;
|
|
13351
13671
|
/** The list of collections published to the publication. */
|
|
13352
13672
|
collections: CollectionConnection;
|
|
@@ -14551,7 +14871,11 @@ type SearchResultEdge = {
|
|
|
14551
14871
|
/** The item at the end of SearchResultEdge. */
|
|
14552
14872
|
node: SearchResult;
|
|
14553
14873
|
};
|
|
14554
|
-
/**
|
|
14874
|
+
/**
|
|
14875
|
+
* A group of [customers](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) that meet specific criteria defined through [ShopifyQL query](https://shopify.dev/docs/api/shopifyql/segment-query-language-reference) conditions. Common use cases for segments include customer analytics, targeted marketing campaigns, and automated discount eligibility.
|
|
14876
|
+
*
|
|
14877
|
+
* The segment's [`query`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment#field-query) field contains ShopifyQL conditions that determine membership, such as purchase history, location, or engagement patterns. Tracks when the segment was created with [`creationDate`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment#field-creationDate) and when it was last modified with [`lastEditDate`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment#field-lastEditDate).
|
|
14878
|
+
*/
|
|
14555
14879
|
type Segment = Node & {
|
|
14556
14880
|
__typename?: 'Segment';
|
|
14557
14881
|
/** The date and time when the segment was added to the store. */
|
|
@@ -14579,12 +14903,14 @@ type SelectedOption = {
|
|
|
14579
14903
|
value: Scalars['String']['output'];
|
|
14580
14904
|
};
|
|
14581
14905
|
/**
|
|
14582
|
-
*
|
|
14583
|
-
* and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing
|
|
14584
|
-
* up these records if you need to restore them later.
|
|
14906
|
+
* How a product can be sold and purchased through recurring billing or deferred purchase options. Defines the specific terms for subscriptions, pre-orders, or try-before-you-buy offers, including when to bill customers, when to fulfill orders, and what pricing adjustments to apply.
|
|
14585
14907
|
*
|
|
14586
|
-
*
|
|
14587
|
-
*
|
|
14908
|
+
* Each selling plan has billing, delivery, and pricing policies that control the purchase experience. The plan's [`options`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan#field-SellingPlan.fields.options) and [`category`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan#field-SellingPlan.fields.category) help merchants organize and report on different selling strategies. Plans are grouped within a [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) that associates them with [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects.
|
|
14909
|
+
*
|
|
14910
|
+
* > Caution:
|
|
14911
|
+
* > Selling plans and associated records are automatically deleted 48 hours after a merchant uninstalls the [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) that created them. Back up these records if you need to restore them later.
|
|
14912
|
+
*
|
|
14913
|
+
* Learn more about [selling plans](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan).
|
|
14588
14914
|
*/
|
|
14589
14915
|
type SellingPlan = HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & Node & {
|
|
14590
14916
|
__typename?: 'SellingPlan';
|
|
@@ -14835,9 +15161,12 @@ declare enum SellingPlanFulfillmentTrigger {
|
|
|
14835
15161
|
Unknown = "UNKNOWN"
|
|
14836
15162
|
}
|
|
14837
15163
|
/**
|
|
14838
|
-
*
|
|
14839
|
-
*
|
|
14840
|
-
*
|
|
15164
|
+
* A selling method that defines how products can be sold through purchase options like subscriptions, pre-orders, or try-before-you-buy. Groups one or more [`SellingPlan`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan) objects that share the same selling method and options.
|
|
15165
|
+
*
|
|
15166
|
+
* The group provides buyer-facing labels and merchant-facing descriptions for the selling method. Associates [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects with selling plan groups to offer them through these purchase options.
|
|
15167
|
+
*
|
|
15168
|
+
* > Caution:
|
|
15169
|
+
* > Selling plan groups and their associated records are automatically deleted 48 hours after a merchant uninstalls the [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) that created them. Back up these records if you need to restore them later.
|
|
14841
15170
|
*/
|
|
14842
15171
|
type SellingPlanGroup = HasPublishedTranslations & Node & {
|
|
14843
15172
|
__typename?: 'SellingPlanGroup';
|
|
@@ -15185,7 +15514,10 @@ type Shop = HasMetafields & HasPublishedTranslations & Node & {
|
|
|
15185
15514
|
assignedFulfillmentOrders: FulfillmentOrderConnection;
|
|
15186
15515
|
/** The list of sales channels not currently installed on the shop. */
|
|
15187
15516
|
availableChannelApps: AppConnection;
|
|
15188
|
-
/**
|
|
15517
|
+
/**
|
|
15518
|
+
* The shop's billing address information.
|
|
15519
|
+
* @deprecated Use `shopAddress` instead.
|
|
15520
|
+
*/
|
|
15189
15521
|
billingAddress: ShopAddress;
|
|
15190
15522
|
/** List of all channel definitions associated with a shop. */
|
|
15191
15523
|
channelDefinitionsForInstalledChannels: Array<AvailableChannelDefinitionsByChannel>;
|
|
@@ -15238,7 +15570,7 @@ type Shop = HasMetafields & HasPublishedTranslations & Node & {
|
|
|
15238
15570
|
draftOrderTags: StringConnection;
|
|
15239
15571
|
/**
|
|
15240
15572
|
* List of saved draft orders on the shop.
|
|
15241
|
-
* @deprecated Use `QueryRoot.draftOrders` instead.
|
|
15573
|
+
* @deprecated Removed as of 2026-01. Use `QueryRoot.draftOrders` instead.
|
|
15242
15574
|
*/
|
|
15243
15575
|
draftOrders: DraftOrderConnection;
|
|
15244
15576
|
/**
|
|
@@ -15711,10 +16043,9 @@ type ShopifyFunction = {
|
|
|
15711
16043
|
useCreationUi: Scalars['Boolean']['output'];
|
|
15712
16044
|
};
|
|
15713
16045
|
/**
|
|
15714
|
-
*
|
|
15715
|
-
*
|
|
15716
|
-
* account
|
|
15717
|
-
* You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.
|
|
16046
|
+
* Financial account information for merchants using Shopify Payments. Tracks current balances across all supported currencies, payout schedules, and [`ShopifyPaymentsBalanceTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBalanceTransaction) records.
|
|
16047
|
+
*
|
|
16048
|
+
* The account includes configuration details such as [`ShopifyPaymentsBankAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount) objects for receiving [`ShopifyPaymentsPayout`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout) transfers, statement descriptors that appear on customer credit card statements, and the [`ShopifyPaymentsPayoutSchedule`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayoutSchedule) that determines when funds transfer to your bank. Access balance transactions to review individual charges, refunds, and adjustments that affect your account balance. Query payouts to track money movement between your Shopify Payments balance and bank accounts.
|
|
15718
16049
|
*/
|
|
15719
16050
|
type ShopifyPaymentsAccount = Node & {
|
|
15720
16051
|
__typename?: 'ShopifyPaymentsAccount';
|
|
@@ -15786,7 +16117,7 @@ type ShopifyPaymentsAssociatedOrder = {
|
|
|
15786
16117
|
/** The name of the associated order. */
|
|
15787
16118
|
name: Scalars['String']['output'];
|
|
15788
16119
|
};
|
|
15789
|
-
/** A transaction that contributes to a Shopify Payments account balance. */
|
|
16120
|
+
/** A transaction that contributes to a Shopify Payments account balance. Records money movement from charges, refunds, payouts, adjustments, or other payment activities. Includes the gross amount, processing fees, and resulting net amount that affects the account balance. Links to the source of the transaction and associated [`ShopifyPaymentsPayout`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout) details, with optional references to [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) objects or adjustment reasons when applicable. */
|
|
15790
16121
|
type ShopifyPaymentsBalanceTransaction = Node & {
|
|
15791
16122
|
__typename?: 'ShopifyPaymentsBalanceTransaction';
|
|
15792
16123
|
/**
|
|
@@ -16023,8 +16354,9 @@ type ShopifyPaymentsExtendedAuthorization = {
|
|
|
16023
16354
|
standardAuthorizationExpiresAt: Scalars['DateTime']['output'];
|
|
16024
16355
|
};
|
|
16025
16356
|
/**
|
|
16026
|
-
*
|
|
16027
|
-
*
|
|
16357
|
+
* A transfer of funds between a merchant's Shopify Payments balance and their [`ShopifyPaymentsBankAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount). Provides the [net amount](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.net), [issue date](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.issuedAt), and current [`ShopifyPaymentsPayoutStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsPayoutStatus).
|
|
16358
|
+
*
|
|
16359
|
+
* The payout includes a [`ShopifyPaymentsPayoutSummary`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayoutSummary) that breaks down fees and gross amounts by transaction type, such as charges, refunds, and adjustments. The [`ShopifyPaymentsPayoutTransactionType`](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsPayoutTransactionType) indicates whether funds move into the bank account (deposit) or back to Shopify Payments (withdrawal).
|
|
16028
16360
|
*/
|
|
16029
16361
|
type ShopifyPaymentsPayout = LegacyInteroperability & Node & {
|
|
16030
16362
|
__typename?: 'ShopifyPaymentsPayout';
|
|
@@ -16198,12 +16530,28 @@ type ShopifyPaymentsTransactionSet = {
|
|
|
16198
16530
|
};
|
|
16199
16531
|
/** The possible types of transactions. */
|
|
16200
16532
|
declare enum ShopifyPaymentsTransactionType {
|
|
16533
|
+
/** The ach_bank_failure_debit_fee transaction type. */
|
|
16534
|
+
AchBankFailureDebitFee = "ACH_BANK_FAILURE_DEBIT_FEE",
|
|
16535
|
+
/** The ach_bank_failure_debit_reversal_fee transaction type. */
|
|
16536
|
+
AchBankFailureDebitReversalFee = "ACH_BANK_FAILURE_DEBIT_REVERSAL_FEE",
|
|
16201
16537
|
/** The adjustment transaction type. */
|
|
16202
16538
|
Adjustment = "ADJUSTMENT",
|
|
16539
|
+
/** The ads_publisher_credit transaction type. */
|
|
16540
|
+
AdsPublisherCredit = "ADS_PUBLISHER_CREDIT",
|
|
16541
|
+
/** The ads_publisher_credit_reversal transaction type. */
|
|
16542
|
+
AdsPublisherCreditReversal = "ADS_PUBLISHER_CREDIT_REVERSAL",
|
|
16203
16543
|
/** The advance transaction type. */
|
|
16204
16544
|
Advance = "ADVANCE",
|
|
16205
16545
|
/** The advance funding transaction type. */
|
|
16206
16546
|
AdvanceFunding = "ADVANCE_FUNDING",
|
|
16547
|
+
/** The agentic_fee_tax_credit transaction type. */
|
|
16548
|
+
AgenticFeeTaxCredit = "AGENTIC_FEE_TAX_CREDIT",
|
|
16549
|
+
/** The agentic_fee_tax_credit_reversal transaction type. */
|
|
16550
|
+
AgenticFeeTaxCreditReversal = "AGENTIC_FEE_TAX_CREDIT_REVERSAL",
|
|
16551
|
+
/** The agentic_fee_tax_debit transaction type. */
|
|
16552
|
+
AgenticFeeTaxDebit = "AGENTIC_FEE_TAX_DEBIT",
|
|
16553
|
+
/** The agentic_fee_tax_debit_reversal transaction type. */
|
|
16554
|
+
AgenticFeeTaxDebitReversal = "AGENTIC_FEE_TAX_DEBIT_REVERSAL",
|
|
16207
16555
|
/** The anomaly_credit transaction type. */
|
|
16208
16556
|
AnomalyCredit = "ANOMALY_CREDIT",
|
|
16209
16557
|
/** The anomaly_credit_reversal transaction type. */
|
|
@@ -16320,6 +16668,10 @@ declare enum ShopifyPaymentsTransactionType {
|
|
|
16320
16668
|
PromotionCredit = "PROMOTION_CREDIT",
|
|
16321
16669
|
/** The promotion_credit_reversal transaction type. */
|
|
16322
16670
|
PromotionCreditReversal = "PROMOTION_CREDIT_REVERSAL",
|
|
16671
|
+
/** The referral_fee transaction type. */
|
|
16672
|
+
ReferralFee = "REFERRAL_FEE",
|
|
16673
|
+
/** The referral_fee_tax transaction type. */
|
|
16674
|
+
ReferralFeeTax = "REFERRAL_FEE_TAX",
|
|
16323
16675
|
/** The refund transaction type. */
|
|
16324
16676
|
Refund = "REFUND",
|
|
16325
16677
|
/** The refund_adjustment transaction type. */
|
|
@@ -16453,7 +16805,11 @@ declare enum ShopifyProtectStatus {
|
|
|
16453
16805
|
/** The order received a fraudulent chargeback and it was protected. */
|
|
16454
16806
|
Protected = "PROTECTED"
|
|
16455
16807
|
}
|
|
16456
|
-
/**
|
|
16808
|
+
/**
|
|
16809
|
+
* A user account that can access the Shopify admin to manage store operations. Includes personal information and account status.
|
|
16810
|
+
*
|
|
16811
|
+
* You can assign staff members to [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) objects for [B2B operations](https://shopify.dev/docs/apps/build/b2b), limiting their actions to those locations.
|
|
16812
|
+
*/
|
|
16457
16813
|
type StaffMember = Node & {
|
|
16458
16814
|
__typename?: 'StaffMember';
|
|
16459
16815
|
/** The type of account the staff member has. */
|
|
@@ -16754,13 +17110,11 @@ declare enum StoreCreditSystemEvent {
|
|
|
16754
17110
|
TaxFinalization = "TAX_FINALIZATION"
|
|
16755
17111
|
}
|
|
16756
17112
|
/**
|
|
16757
|
-
* A token that
|
|
16758
|
-
* the unauthenticated [Storefront API](https://shopify.dev/docs/api/storefront).
|
|
17113
|
+
* A token that delegates unauthenticated access scopes to clients that need to access the [Storefront API](https://shopify.dev/docs/api/storefront). Storefront access tokens enable headless storefronts and custom applications to interact with a store on behalf of customers without requiring authentication.
|
|
16759
17114
|
*
|
|
16760
|
-
* An app can have a maximum of 100 active storefront access
|
|
16761
|
-
* tokens for each shop.
|
|
17115
|
+
* The token provides specific permissions, such as reading [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) data, managing carts, or creating [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) accounts. An app can have a maximum of 100 active storefront access tokens for each [`Shop`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop).
|
|
16762
17116
|
*
|
|
16763
|
-
* [
|
|
17117
|
+
* Learn more about [building with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started).
|
|
16764
17118
|
*/
|
|
16765
17119
|
type StorefrontAccessToken = Node & {
|
|
16766
17120
|
__typename?: 'StorefrontAccessToken';
|
|
@@ -16824,9 +17178,9 @@ type SubscriptionAppliedCodeDiscount = {
|
|
|
16824
17178
|
rejectionReason?: Maybe<SubscriptionDiscountRejectionReason>;
|
|
16825
17179
|
};
|
|
16826
17180
|
/**
|
|
16827
|
-
* A record of an execution of the subscription billing process. Billing attempts use
|
|
16828
|
-
*
|
|
16829
|
-
*
|
|
17181
|
+
* A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation.
|
|
17182
|
+
*
|
|
17183
|
+
* When a billing attempt completes successfully, it creates an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). The attempt includes associated payment transactions and any errors that occur during billing. If 3D Secure authentication is required, the `nextActionUrl` field provides the redirect URL for customer verification.
|
|
16830
17184
|
*/
|
|
16831
17185
|
type SubscriptionBillingAttempt = Node & {
|
|
16832
17186
|
__typename?: 'SubscriptionBillingAttempt';
|
|
@@ -16970,7 +17324,13 @@ type SubscriptionBillingPolicy = {
|
|
|
16970
17324
|
/** Minimum amount of cycles required in the subscription. */
|
|
16971
17325
|
minCycles?: Maybe<Scalars['Int']['output']>;
|
|
16972
17326
|
};
|
|
16973
|
-
/**
|
|
17327
|
+
/**
|
|
17328
|
+
* A subscription contract that defines recurring purchases for a customer. Each contract specifies what products to deliver, when to bill and ship them, and at what price.
|
|
17329
|
+
*
|
|
17330
|
+
* The contract includes [`SubscriptionBillingPolicy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingPolicy) and [`SubscriptionDeliveryPolicy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDeliveryPolicy) that control the frequency of charges and fulfillments. [`SubscriptionLine`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionLine) items define the products, quantities, and pricing for each recurring [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). The contract tracks [`SubscriptionBillingAttempt`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt) records, payment status, and generated orders throughout its lifecycle. [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) instances manage contracts through various status transitions including active, paused, failed, cancelled, or expired states.
|
|
17331
|
+
*
|
|
17332
|
+
* Learn more about [building subscription contracts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/build-a-subscription-contract) and [updating subscription contracts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/update-a-subscription-contract).
|
|
17333
|
+
*/
|
|
16974
17334
|
type SubscriptionContract = Node & SubscriptionContractBase & {
|
|
16975
17335
|
__typename?: 'SubscriptionContract';
|
|
16976
17336
|
/** The subscription app that the subscription contract is registered to. */
|
|
@@ -17278,7 +17638,13 @@ declare enum SubscriptionDiscountRejectionReason {
|
|
|
17278
17638
|
}
|
|
17279
17639
|
/** The value of the discount and how it will be applied. */
|
|
17280
17640
|
type SubscriptionDiscountValue = SubscriptionDiscountFixedAmountValue | SubscriptionDiscountPercentageValue;
|
|
17281
|
-
/**
|
|
17641
|
+
/**
|
|
17642
|
+
* A product line item within a [`SubscriptionContract`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract). Each line represents a specific product variant that the customer subscribes to, including its quantity, pricing, and whether shipping is required.
|
|
17643
|
+
*
|
|
17644
|
+
* The line maintains references to the [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant), [`SellingPlan`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan), and custom [`Attribute`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) objects. It tracks the current price and any scheduled price changes through its [`pricingPolicy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionPricingPolicy). You can modify lines through [`SubscriptionDraft`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDraft) objects without affecting the original contract until you commit changes.
|
|
17645
|
+
*
|
|
17646
|
+
* Learn more about [subscription contracts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts) and [selling plans](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans).
|
|
17647
|
+
*/
|
|
17282
17648
|
type SubscriptionLine = {
|
|
17283
17649
|
__typename?: 'SubscriptionLine';
|
|
17284
17650
|
/** The origin contract of the line if it was concatenated from another contract. */
|
|
@@ -17478,7 +17844,13 @@ declare enum SuggestedOrderTransactionKind {
|
|
|
17478
17844
|
/** A suggested refund transaction for an order. */
|
|
17479
17845
|
SuggestedRefund = "SUGGESTED_REFUND"
|
|
17480
17846
|
}
|
|
17481
|
-
/**
|
|
17847
|
+
/**
|
|
17848
|
+
* A refund amount that Shopify suggests based on the items, duties, and shipping costs that customers return. Provides a breakdown of all monetary values including subtotals, taxes, discounts, and the maximum refundable amount.
|
|
17849
|
+
*
|
|
17850
|
+
* The suggested refund includes [`RefundLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/RefundLineItem) objects to refund with their quantities and restock instructions, [`RefundDuty`](https://shopify.dev/docs/api/admin-graphql/latest/objects/RefundDuty) objects for duty reimbursements, and [`ShippingRefund`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingRefund) for shipping cost refunds. Provides [`SuggestedOrderTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SuggestedOrderTransaction) objects and the [`SuggestedRefundMethod`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/SuggestedRefundMethod) interface to process the refund through the appropriate gateways.
|
|
17851
|
+
*
|
|
17852
|
+
* Learn more about [previewing and refunding duties](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/view-and-refund-duties#step-3-preview-a-refund-that-includes-duties).
|
|
17853
|
+
*/
|
|
17482
17854
|
type SuggestedRefund = {
|
|
17483
17855
|
__typename?: 'SuggestedRefund';
|
|
17484
17856
|
/**
|
|
@@ -17722,7 +18094,11 @@ type TaxonomyAttribute = Node & {
|
|
|
17722
18094
|
/** A globally-unique ID. */
|
|
17723
18095
|
id: Scalars['ID']['output'];
|
|
17724
18096
|
};
|
|
17725
|
-
/**
|
|
18097
|
+
/**
|
|
18098
|
+
* A product category within Shopify's [standardized product taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). Provides hierarchical organization through parent-child relationships, with each category tracking its ancestors, children, and level in the taxonomy tree.
|
|
18099
|
+
*
|
|
18100
|
+
* Categories include attributes specific to their product type and navigation properties like whether they're root, leaf, or archived categories. The taxonomy enables consistent product classification across Shopify and integrated marketplaces.
|
|
18101
|
+
*/
|
|
17726
18102
|
type TaxonomyCategory = Node & {
|
|
17727
18103
|
__typename?: 'TaxonomyCategory';
|
|
17728
18104
|
/** The IDs of the category's ancestor categories. */
|
|
@@ -17834,7 +18210,13 @@ type TransactionFee = Node & {
|
|
|
17834
18210
|
/** Name of the type of fee. */
|
|
17835
18211
|
type: Scalars['String']['output'];
|
|
17836
18212
|
};
|
|
17837
|
-
/**
|
|
18213
|
+
/**
|
|
18214
|
+
* A localized version of a field on a resource. Translations enable merchants to provide content in multiple languages for [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects, [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) objects, and other store resources.
|
|
18215
|
+
*
|
|
18216
|
+
* Each translation specifies the locale, the field being translated (identified by its key), and the translated value. Translations can be market-specific, allowing different content for the same language across different markets, or available globally when no [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) is specified. The `outdated` flag indicates whether the original content has changed since this translation was last updated.
|
|
18217
|
+
*
|
|
18218
|
+
* Learn more about [managing translated content](https://shopify.dev/docs/apps/build/markets/manage-translated-content).
|
|
18219
|
+
*/
|
|
17838
18220
|
type Translation = {
|
|
17839
18221
|
__typename?: 'Translation';
|
|
17840
18222
|
/** On the resource that this translation belongs to, the reference to the value being translated. */
|
|
@@ -17929,7 +18311,7 @@ declare enum UnitSystem {
|
|
|
17929
18311
|
/** Metric system of weights and measures. */
|
|
17930
18312
|
MetricSystem = "METRIC_SYSTEM"
|
|
17931
18313
|
}
|
|
17932
|
-
/**
|
|
18314
|
+
/** An error in the input of a mutation. Mutations return `UserError` objects to indicate validation failures, such as invalid field values or business logic violations, that prevent the operation from completing. */
|
|
17933
18315
|
type UserError = DisplayableError & {
|
|
17934
18316
|
__typename?: 'UserError';
|
|
17935
18317
|
/** The path to the input field that caused the error. */
|
|
@@ -18046,7 +18428,11 @@ type VideoSource = {
|
|
|
18046
18428
|
/** The video source's width. */
|
|
18047
18429
|
width: Scalars['Int']['output'];
|
|
18048
18430
|
};
|
|
18049
|
-
/**
|
|
18431
|
+
/**
|
|
18432
|
+
* A weight measurement with its numeric value and unit. Used throughout the API, for example in shipping calculations, delivery conditions, order line items, and inventory measurements.
|
|
18433
|
+
*
|
|
18434
|
+
* The weight combines a decimal value with a standard unit of measurement to ensure consistent weight handling across different regional systems.
|
|
18435
|
+
*/
|
|
18050
18436
|
type Weight = {
|
|
18051
18437
|
__typename?: 'Weight';
|
|
18052
18438
|
/** The unit of measurement for `value`. */
|
|
@@ -18078,6 +18464,14 @@ type ConnectMetaObjectToProductVariantMutation = {
|
|
|
18078
18464
|
userErrors: Array<Pick<ProductVariantsBulkUpdateUserError, 'field' | 'message'>>;
|
|
18079
18465
|
}>;
|
|
18080
18466
|
};
|
|
18467
|
+
type OrderPaymentDetailsByIdQueryVariables = Exact<{
|
|
18468
|
+
id: Scalars['ID']['input'];
|
|
18469
|
+
}>;
|
|
18470
|
+
type OrderPaymentDetailsByIdQuery = {
|
|
18471
|
+
order?: Maybe<{
|
|
18472
|
+
transactions: Array<Pick<OrderTransaction, 'createdAt' | 'gateway' | 'formattedGateway' | 'kind' | 'paymentId'>>;
|
|
18473
|
+
}>;
|
|
18474
|
+
};
|
|
18081
18475
|
type OrdersByNameQueryVariables = Exact<{
|
|
18082
18476
|
first: Scalars['Int']['input'];
|
|
18083
18477
|
queryFilter: Scalars['String']['input'];
|
|
@@ -18214,6 +18608,10 @@ type ProductHandlesQuery = {
|
|
|
18214
18608
|
};
|
|
18215
18609
|
};
|
|
18216
18610
|
interface GeneratedQueryTypes {
|
|
18611
|
+
"#graphql\n query orderPaymentDetailsById($id: ID!) {\n order(id: $id) {\n transactions {\n createdAt\n gateway\n formattedGateway\n kind\n paymentId\n }\n }\n }\n": {
|
|
18612
|
+
return: OrderPaymentDetailsByIdQuery;
|
|
18613
|
+
variables: OrderPaymentDetailsByIdQueryVariables;
|
|
18614
|
+
};
|
|
18217
18615
|
"#graphql\n query ordersByName($first: Int!, $queryFilter: String!) {\n orders(first: $first, query: $queryFilter) {\n edges {\n node {\n id\n name\n createdAt\n updatedAt\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n customer {\n id\n lastName\n defaultEmailAddress {\n emailAddress\n }\n displayName\n firstName\n }\n displayFinancialStatus\n displayFulfillmentStatus\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
|
|
18218
18616
|
return: OrdersByNameQuery;
|
|
18219
18617
|
variables: OrdersByNameQueryVariables;
|
|
@@ -18245,14 +18643,94 @@ declare module '@shopify/admin-api-client' {
|
|
|
18245
18643
|
}
|
|
18246
18644
|
}
|
|
18247
18645
|
|
|
18248
|
-
declare const GetLeanOrderByNameReturn: z.ZodNullable<z.ZodObject<
|
|
18646
|
+
declare const GetLeanOrderByNameReturn: z.ZodNullable<z.ZodObject<{
|
|
18647
|
+
id: z.ZodString;
|
|
18648
|
+
name: z.ZodString;
|
|
18649
|
+
createdAt: z.ZodString;
|
|
18650
|
+
updatedAt: z.ZodString;
|
|
18651
|
+
totalPrice: z.ZodObject<{
|
|
18652
|
+
amount: z.ZodString;
|
|
18653
|
+
currencyCode: z.ZodString;
|
|
18654
|
+
}, "strip", z.ZodTypeAny, {
|
|
18655
|
+
amount: string;
|
|
18656
|
+
currencyCode: string;
|
|
18657
|
+
}, {
|
|
18658
|
+
amount: string;
|
|
18659
|
+
currencyCode: string;
|
|
18660
|
+
}>;
|
|
18661
|
+
customer: z.ZodNullable<z.ZodObject<{
|
|
18662
|
+
id: z.ZodString;
|
|
18663
|
+
displayName: z.ZodString;
|
|
18664
|
+
emailAddress: z.ZodNullable<z.ZodString>;
|
|
18665
|
+
}, "strip", z.ZodTypeAny, {
|
|
18666
|
+
id: string;
|
|
18667
|
+
displayName: string;
|
|
18668
|
+
emailAddress: string | null;
|
|
18669
|
+
}, {
|
|
18670
|
+
id: string;
|
|
18671
|
+
displayName: string;
|
|
18672
|
+
emailAddress: string | null;
|
|
18673
|
+
}>>;
|
|
18674
|
+
financialStatus: z.ZodNullable<z.ZodString>;
|
|
18675
|
+
fulfillmentStatus: z.ZodNullable<z.ZodString>;
|
|
18676
|
+
}, "strip", z.ZodTypeAny, {
|
|
18677
|
+
id: string;
|
|
18678
|
+
createdAt: string;
|
|
18679
|
+
updatedAt: string;
|
|
18680
|
+
name: string;
|
|
18681
|
+
customer: {
|
|
18682
|
+
id: string;
|
|
18683
|
+
displayName: string;
|
|
18684
|
+
emailAddress: string | null;
|
|
18685
|
+
} | null;
|
|
18686
|
+
totalPrice: {
|
|
18687
|
+
amount: string;
|
|
18688
|
+
currencyCode: string;
|
|
18689
|
+
};
|
|
18690
|
+
fulfillmentStatus: string | null;
|
|
18691
|
+
financialStatus: string | null;
|
|
18692
|
+
}, {
|
|
18693
|
+
id: string;
|
|
18694
|
+
createdAt: string;
|
|
18695
|
+
updatedAt: string;
|
|
18696
|
+
name: string;
|
|
18697
|
+
customer: {
|
|
18698
|
+
id: string;
|
|
18699
|
+
displayName: string;
|
|
18700
|
+
emailAddress: string | null;
|
|
18701
|
+
} | null;
|
|
18702
|
+
totalPrice: {
|
|
18703
|
+
amount: string;
|
|
18704
|
+
currencyCode: string;
|
|
18705
|
+
};
|
|
18706
|
+
fulfillmentStatus: string | null;
|
|
18707
|
+
financialStatus: string | null;
|
|
18708
|
+
}>>;
|
|
18249
18709
|
type GetLeanOrderByNameReturnType = z.infer<typeof GetLeanOrderByNameReturn>;
|
|
18250
18710
|
type GetFullOrderByNameReturnType = NonNullable<NonNullable<OrdersByNameFullQuery['orders']>['edges'][number]['node']> | null;
|
|
18251
18711
|
declare function getOrderByName(orderName: string, detailLevel: 'lean'): Promise<GetLeanOrderByNameReturnType>;
|
|
18252
18712
|
declare function getOrderByName(orderName: string, detailLevel: 'full'): Promise<GetFullOrderByNameReturnType>;
|
|
18253
18713
|
declare function getOrderByName(orderName: string): Promise<GetLeanOrderByNameReturnType>;
|
|
18254
18714
|
|
|
18255
|
-
declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<
|
|
18715
|
+
declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<{
|
|
18716
|
+
productId: z.ZodString;
|
|
18717
|
+
productTitle: z.ZodString;
|
|
18718
|
+
variantId: z.ZodString;
|
|
18719
|
+
variantTitle: z.ZodString;
|
|
18720
|
+
sku: z.ZodString;
|
|
18721
|
+
}, "strip", z.ZodTypeAny, {
|
|
18722
|
+
productId: string;
|
|
18723
|
+
variantId: string;
|
|
18724
|
+
sku: string;
|
|
18725
|
+
variantTitle: string;
|
|
18726
|
+
productTitle: string;
|
|
18727
|
+
}, {
|
|
18728
|
+
productId: string;
|
|
18729
|
+
variantId: string;
|
|
18730
|
+
sku: string;
|
|
18731
|
+
variantTitle: string;
|
|
18732
|
+
productTitle: string;
|
|
18733
|
+
}>, "many">;
|
|
18256
18734
|
type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsReturn>;
|
|
18257
18735
|
/**
|
|
18258
18736
|
* Retrieves a lean list of product variants from Shopify, optionally filtered by SKUs.
|
|
@@ -18265,4 +18743,132 @@ type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsRet
|
|
|
18265
18743
|
*/
|
|
18266
18744
|
declare function getLeanProductVariants(skus?: string[]): Promise<GetLeanProductVariantsReturnType>;
|
|
18267
18745
|
|
|
18268
|
-
|
|
18746
|
+
declare const GetOrderPaymentDetailsByNameReturn: z.ZodObject<{
|
|
18747
|
+
order: z.ZodObject<{
|
|
18748
|
+
transactions: z.ZodArray<z.ZodObject<{
|
|
18749
|
+
amountSet: z.ZodObject<{
|
|
18750
|
+
shopMoney: z.ZodObject<{
|
|
18751
|
+
amount: z.ZodString;
|
|
18752
|
+
currencyCode: z.ZodString;
|
|
18753
|
+
}, "strip", z.ZodTypeAny, {
|
|
18754
|
+
amount: string;
|
|
18755
|
+
currencyCode: string;
|
|
18756
|
+
}, {
|
|
18757
|
+
amount: string;
|
|
18758
|
+
currencyCode: string;
|
|
18759
|
+
}>;
|
|
18760
|
+
}, "strip", z.ZodTypeAny, {
|
|
18761
|
+
shopMoney: {
|
|
18762
|
+
amount: string;
|
|
18763
|
+
currencyCode: string;
|
|
18764
|
+
};
|
|
18765
|
+
}, {
|
|
18766
|
+
shopMoney: {
|
|
18767
|
+
amount: string;
|
|
18768
|
+
currencyCode: string;
|
|
18769
|
+
};
|
|
18770
|
+
}>;
|
|
18771
|
+
createdAt: z.ZodString;
|
|
18772
|
+
gateway: z.ZodString;
|
|
18773
|
+
formattedGateway: z.ZodString;
|
|
18774
|
+
kind: z.ZodString;
|
|
18775
|
+
paymentId: z.ZodString;
|
|
18776
|
+
}, "strip", z.ZodTypeAny, {
|
|
18777
|
+
createdAt: string;
|
|
18778
|
+
gateway: string;
|
|
18779
|
+
formattedGateway: string;
|
|
18780
|
+
kind: string;
|
|
18781
|
+
paymentId: string;
|
|
18782
|
+
amountSet: {
|
|
18783
|
+
shopMoney: {
|
|
18784
|
+
amount: string;
|
|
18785
|
+
currencyCode: string;
|
|
18786
|
+
};
|
|
18787
|
+
};
|
|
18788
|
+
}, {
|
|
18789
|
+
createdAt: string;
|
|
18790
|
+
gateway: string;
|
|
18791
|
+
formattedGateway: string;
|
|
18792
|
+
kind: string;
|
|
18793
|
+
paymentId: string;
|
|
18794
|
+
amountSet: {
|
|
18795
|
+
shopMoney: {
|
|
18796
|
+
amount: string;
|
|
18797
|
+
currencyCode: string;
|
|
18798
|
+
};
|
|
18799
|
+
};
|
|
18800
|
+
}>, "many">;
|
|
18801
|
+
}, "strip", z.ZodTypeAny, {
|
|
18802
|
+
transactions: {
|
|
18803
|
+
createdAt: string;
|
|
18804
|
+
gateway: string;
|
|
18805
|
+
formattedGateway: string;
|
|
18806
|
+
kind: string;
|
|
18807
|
+
paymentId: string;
|
|
18808
|
+
amountSet: {
|
|
18809
|
+
shopMoney: {
|
|
18810
|
+
amount: string;
|
|
18811
|
+
currencyCode: string;
|
|
18812
|
+
};
|
|
18813
|
+
};
|
|
18814
|
+
}[];
|
|
18815
|
+
}, {
|
|
18816
|
+
transactions: {
|
|
18817
|
+
createdAt: string;
|
|
18818
|
+
gateway: string;
|
|
18819
|
+
formattedGateway: string;
|
|
18820
|
+
kind: string;
|
|
18821
|
+
paymentId: string;
|
|
18822
|
+
amountSet: {
|
|
18823
|
+
shopMoney: {
|
|
18824
|
+
amount: string;
|
|
18825
|
+
currencyCode: string;
|
|
18826
|
+
};
|
|
18827
|
+
};
|
|
18828
|
+
}[];
|
|
18829
|
+
}>;
|
|
18830
|
+
}, "strip", z.ZodTypeAny, {
|
|
18831
|
+
order: {
|
|
18832
|
+
transactions: {
|
|
18833
|
+
createdAt: string;
|
|
18834
|
+
gateway: string;
|
|
18835
|
+
formattedGateway: string;
|
|
18836
|
+
kind: string;
|
|
18837
|
+
paymentId: string;
|
|
18838
|
+
amountSet: {
|
|
18839
|
+
shopMoney: {
|
|
18840
|
+
amount: string;
|
|
18841
|
+
currencyCode: string;
|
|
18842
|
+
};
|
|
18843
|
+
};
|
|
18844
|
+
}[];
|
|
18845
|
+
};
|
|
18846
|
+
}, {
|
|
18847
|
+
order: {
|
|
18848
|
+
transactions: {
|
|
18849
|
+
createdAt: string;
|
|
18850
|
+
gateway: string;
|
|
18851
|
+
formattedGateway: string;
|
|
18852
|
+
kind: string;
|
|
18853
|
+
paymentId: string;
|
|
18854
|
+
amountSet: {
|
|
18855
|
+
shopMoney: {
|
|
18856
|
+
amount: string;
|
|
18857
|
+
currencyCode: string;
|
|
18858
|
+
};
|
|
18859
|
+
};
|
|
18860
|
+
}[];
|
|
18861
|
+
};
|
|
18862
|
+
}>;
|
|
18863
|
+
type GetOrderPaymentDetailsByNameReturnType = z.infer<typeof GetOrderPaymentDetailsByNameReturn>;
|
|
18864
|
+
/**
|
|
18865
|
+
* Retrieves a single order from Shopify by its order name (e.g., "B12345").
|
|
18866
|
+
* Returns null if no order is found with the specified name.
|
|
18867
|
+
*
|
|
18868
|
+
* @param {bigint} id - The numerical Shopify order id for (e.g., "12345678").
|
|
18869
|
+
* @returns {Promise<GetOrderPaymentDetailsByNameReturnType>} A promise that resolves to the order data or null if not found.
|
|
18870
|
+
* @throws {Error} If the GraphQL query fails or if the response structure is invalid.
|
|
18871
|
+
*/
|
|
18872
|
+
declare function getOrderPaymentDetailsById(id: bigint): Promise<GetOrderPaymentDetailsByNameReturnType>;
|
|
18873
|
+
|
|
18874
|
+
export { getLeanProductVariants, getOrderByName, getOrderPaymentDetailsById };
|