@ehrenkind/shopify-lib 0.4.0 → 0.5.0
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 +1479 -172
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1842 -252
- package/dist/index.d.ts +20821 -15
- package/dist/index.mjs +1452 -165
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/dist/generated-api-types/2025-04/admin.generated.d.ts +0 -420
- 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 -60045
- 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 -11451
- 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 -15
- package/dist/index.js.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.d.ts +0 -2
- package/dist/mutations/customers/deleteCustomerById.d.ts.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.js +0 -35
- package/dist/mutations/customers/deleteCustomerById.js.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.mock.d.ts +0 -4
- package/dist/mutations/customers/deleteCustomerById.mock.d.ts.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.mock.js +0 -8
- package/dist/mutations/customers/deleteCustomerById.mock.js.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.test.d.ts +0 -2
- package/dist/mutations/customers/deleteCustomerById.test.d.ts.map +0 -1
- package/dist/mutations/customers/deleteCustomerById.test.js +0 -10
- package/dist/mutations/customers/deleteCustomerById.test.js.map +0 -1
- package/dist/mutations/orders/cancelOrderById.d.ts +0 -23
- package/dist/mutations/orders/cancelOrderById.d.ts.map +0 -1
- package/dist/mutations/orders/cancelOrderById.js +0 -63
- package/dist/mutations/orders/cancelOrderById.js.map +0 -1
- package/dist/mutations/orders/cancelOrderById.mock.d.ts +0 -15
- package/dist/mutations/orders/cancelOrderById.mock.d.ts.map +0 -1
- package/dist/mutations/orders/cancelOrderById.mock.js +0 -17
- package/dist/mutations/orders/cancelOrderById.mock.js.map +0 -1
- package/dist/mutations/orders/cancelOrderById.test.d.ts +0 -2
- package/dist/mutations/orders/cancelOrderById.test.d.ts.map +0 -1
- package/dist/mutations/orders/cancelOrderById.test.js +0 -42
- package/dist/mutations/orders/cancelOrderById.test.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/customers/getCustomersByEmail.d.ts +0 -13
- package/dist/queries/customers/getCustomersByEmail.d.ts.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.js +0 -26
- package/dist/queries/customers/getCustomersByEmail.js.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.mock.d.ts +0 -8
- package/dist/queries/customers/getCustomersByEmail.mock.d.ts.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.mock.js +0 -54
- package/dist/queries/customers/getCustomersByEmail.mock.js.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.queries.d.ts +0 -2
- package/dist/queries/customers/getCustomersByEmail.queries.d.ts.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.queries.js +0 -41
- package/dist/queries/customers/getCustomersByEmail.queries.js.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.test.d.ts +0 -2
- package/dist/queries/customers/getCustomersByEmail.test.d.ts.map +0 -1
- package/dist/queries/customers/getCustomersByEmail.test.js +0 -29
- package/dist/queries/customers/getCustomersByEmail.test.js.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.d.ts +0 -14
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.d.ts.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.js +0 -27
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.js.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.mock.d.ts +0 -12
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.mock.d.ts.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.mock.js +0 -41
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.mock.js.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.queries.d.ts +0 -2
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.queries.d.ts.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.queries.js +0 -28
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.queries.js.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.test.d.ts +0 -2
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.test.d.ts.map +0 -1
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.test.js +0 -19
- package/dist/queries/fulfillmentOrders/getFulfillmentOrdersByOrderId.test.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.d.ts +0 -12
- package/dist/queries/fulfillments/getFulfillmentById.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.js +0 -27
- package/dist/queries/fulfillments/getFulfillmentById.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.mock.d.ts +0 -21
- package/dist/queries/fulfillments/getFulfillmentById.mock.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.mock.js +0 -83
- package/dist/queries/fulfillments/getFulfillmentById.mock.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.queries.d.ts +0 -2
- package/dist/queries/fulfillments/getFulfillmentById.queries.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.queries.js +0 -60
- package/dist/queries/fulfillments/getFulfillmentById.queries.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.test.d.ts +0 -2
- package/dist/queries/fulfillments/getFulfillmentById.test.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentById.test.js +0 -37
- package/dist/queries/fulfillments/getFulfillmentById.test.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.d.ts +0 -14
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.js +0 -36
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.mock.d.ts +0 -5
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.mock.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.mock.js +0 -20
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.mock.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.queries.d.ts +0 -2
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.queries.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.queries.js +0 -13
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.queries.js.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.test.d.ts +0 -2
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.test.d.ts.map +0 -1
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.test.js +0 -61
- package/dist/queries/fulfillments/getFulfillmentTrackingIds.test.js.map +0 -1
- package/dist/queries/orders/getOrderById.d.ts +0 -136
- package/dist/queries/orders/getOrderById.d.ts.map +0 -1
- package/dist/queries/orders/getOrderById.js +0 -126
- package/dist/queries/orders/getOrderById.js.map +0 -1
- package/dist/queries/orders/getOrderById.mock.d.ts +0 -82
- package/dist/queries/orders/getOrderById.mock.d.ts.map +0 -1
- package/dist/queries/orders/getOrderById.mock.js +0 -205
- package/dist/queries/orders/getOrderById.mock.js.map +0 -1
- package/dist/queries/orders/getOrderById.queries.d.ts +0 -3
- package/dist/queries/orders/getOrderById.queries.d.ts.map +0 -1
- package/dist/queries/orders/getOrderById.queries.js +0 -175
- package/dist/queries/orders/getOrderById.queries.js.map +0 -1
- package/dist/queries/orders/getOrderById.test.d.ts +0 -2
- package/dist/queries/orders/getOrderById.test.d.ts.map +0 -1
- package/dist/queries/orders/getOrderById.test.js +0 -46
- package/dist/queries/orders/getOrderById.test.js.map +0 -1
- package/dist/queries/orders/getOrderByName.d.ts +0 -72
- 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 -30
- package/dist/queries/orders/getOrderByName.test.js.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.d.ts +0 -12
- package/dist/queries/orders/getOrderCancellationInfo.d.ts.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.js +0 -35
- package/dist/queries/orders/getOrderCancellationInfo.js.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.mock.d.ts +0 -6
- package/dist/queries/orders/getOrderCancellationInfo.mock.d.ts.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.mock.js +0 -29
- package/dist/queries/orders/getOrderCancellationInfo.mock.js.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.queries.d.ts +0 -2
- package/dist/queries/orders/getOrderCancellationInfo.queries.d.ts.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.queries.js +0 -15
- package/dist/queries/orders/getOrderCancellationInfo.queries.js.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.test.d.ts +0 -2
- package/dist/queries/orders/getOrderCancellationInfo.test.d.ts.map +0 -1
- package/dist/queries/orders/getOrderCancellationInfo.test.js +0 -34
- package/dist/queries/orders/getOrderCancellationInfo.test.js.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.d.ts +0 -12
- package/dist/queries/orders/getOrderPaymentDetails.d.ts.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.js +0 -26
- package/dist/queries/orders/getOrderPaymentDetails.js.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.mock.d.ts +0 -10
- package/dist/queries/orders/getOrderPaymentDetails.mock.d.ts.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.mock.js +0 -22
- package/dist/queries/orders/getOrderPaymentDetails.mock.js.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.queries.d.ts +0 -2
- package/dist/queries/orders/getOrderPaymentDetails.queries.d.ts.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.queries.js +0 -21
- package/dist/queries/orders/getOrderPaymentDetails.queries.js.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.test.d.ts +0 -2
- package/dist/queries/orders/getOrderPaymentDetails.test.d.ts.map +0 -1
- package/dist/queries/orders/getOrderPaymentDetails.test.js +0 -19
- package/dist/queries/orders/getOrderPaymentDetails.test.js.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.d.ts +0 -15
- package/dist/queries/orders/getOrdersByCustomerId.d.ts.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.js +0 -32
- package/dist/queries/orders/getOrdersByCustomerId.js.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.mock.d.ts +0 -15
- package/dist/queries/orders/getOrdersByCustomerId.mock.d.ts.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.mock.js +0 -76
- package/dist/queries/orders/getOrdersByCustomerId.mock.js.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.queries.d.ts +0 -2
- package/dist/queries/orders/getOrdersByCustomerId.queries.d.ts.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.queries.js +0 -41
- package/dist/queries/orders/getOrdersByCustomerId.queries.js.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.test.d.ts +0 -2
- package/dist/queries/orders/getOrdersByCustomerId.test.d.ts.map +0 -1
- package/dist/queries/orders/getOrdersByCustomerId.test.js +0 -33
- package/dist/queries/orders/getOrdersByCustomerId.test.js.map +0 -1
- package/dist/queries/productVariants/getLeanProductVariants.d.ts +0 -33
- 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 -8
- package/dist/utils/mswHandlers.d.ts.map +0 -1
- package/dist/utils/mswHandlers.js +0 -67
- package/dist/utils/mswHandlers.js.map +0 -1
- package/dist/utils/parseGid.d.ts +0 -9
- package/dist/utils/parseGid.d.ts.map +0 -1
- package/dist/utils/parseGid.js +0 -12
- package/dist/utils/parseGid.js.map +0 -1
- package/dist/utils/parseGid.test.d.ts +0 -2
- package/dist/utils/parseGid.test.d.ts.map +0 -1
- package/dist/utils/parseGid.test.js +0 -26
- package/dist/utils/parseGid.test.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 -45
- package/dist/utils/shopifyFetch.d.ts.map +0 -1
- package/dist/utils/shopifyFetch.js +0 -89
- 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
|
@@ -1,7 +1,146 @@
|
|
|
1
1
|
import z from 'zod';
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
/**
|
|
4
|
+
* Deletes a customer from Shopify by their ID.
|
|
5
|
+
* @param customerId - The customer ID (GID string, e.g., "gid://shopify/Customer/123")
|
|
6
|
+
* @returns The deleted customer ID, or null if not found
|
|
7
|
+
* @throws ShopifyUserError if Shopify returns user errors
|
|
8
|
+
*/
|
|
9
|
+
declare function deleteCustomerById(customerId: string): Promise<string | undefined>;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Deletes files from Shopify by their IDs.
|
|
13
|
+
* @param fileIds - Array of file IDs to delete (e.g., "gid://shopify/MediaImage/123")
|
|
14
|
+
* @returns Array of successfully deleted file IDs
|
|
15
|
+
* @throws ShopifyUserError if Shopify returns user errors
|
|
16
|
+
*/
|
|
17
|
+
declare function deleteFilesByIds(fileIds: string[]): Promise<string[]>;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Creates a file in Shopify from an external URL.
|
|
21
|
+
*
|
|
22
|
+
* @param url - The HTTPS URL of the file to upload (must be publicly accessible)
|
|
23
|
+
* @param altText - Alt text description for accessibility
|
|
24
|
+
* @param filename - The filename to use in Shopify
|
|
25
|
+
* @returns Promise resolving to the created file ID
|
|
26
|
+
* @throws {Error} When the URL doesn't start with https://
|
|
27
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* const fileId = await createFile(
|
|
31
|
+
* 'https://example.com/image.png',
|
|
32
|
+
* 'Product image',
|
|
33
|
+
* 'product-image.png'
|
|
34
|
+
* )
|
|
35
|
+
*/
|
|
36
|
+
declare function createFile(url: string, altText: string, filename: string): Promise<string>;
|
|
37
|
+
|
|
38
|
+
type MetaobjectFieldDefinition$1 = {
|
|
39
|
+
key: string;
|
|
40
|
+
name?: string;
|
|
41
|
+
type: string;
|
|
42
|
+
description?: string;
|
|
43
|
+
required?: boolean;
|
|
44
|
+
};
|
|
45
|
+
type CreateMetaobjectDefinitionInput = {
|
|
46
|
+
type: string;
|
|
47
|
+
name?: string;
|
|
48
|
+
description?: string;
|
|
49
|
+
displayNameKey?: string;
|
|
50
|
+
fieldDefinitions: MetaobjectFieldDefinition$1[];
|
|
51
|
+
};
|
|
52
|
+
type CreateMetaobjectDefinitionResult = {
|
|
53
|
+
id: string;
|
|
54
|
+
name: string;
|
|
55
|
+
type: string;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* Creates a metaobject definition in Shopify.
|
|
59
|
+
*
|
|
60
|
+
* @param input - The metaobject definition input
|
|
61
|
+
* @returns Promise resolving to the created metaobject definition
|
|
62
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
63
|
+
* @throws {Error} When GraphQL errors occur
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* await createMetaobjectDefinition({
|
|
67
|
+
* type: 'my_custom_type',
|
|
68
|
+
* name: 'My Custom Type',
|
|
69
|
+
* description: 'A custom metaobject definition',
|
|
70
|
+
* fieldDefinitions: [
|
|
71
|
+
* { key: 'title', name: 'Title', type: 'single_line_text_field' },
|
|
72
|
+
* { key: 'description', name: 'Description', type: 'multi_line_text_field' },
|
|
73
|
+
* ],
|
|
74
|
+
* })
|
|
75
|
+
*/
|
|
76
|
+
declare function createMetaobjectDefinition(input: CreateMetaobjectDefinitionInput): Promise<CreateMetaobjectDefinitionResult>;
|
|
77
|
+
|
|
78
|
+
type FulfillmentLineItem$1 = {
|
|
79
|
+
id: number | bigint | string;
|
|
80
|
+
quantity: number;
|
|
81
|
+
};
|
|
82
|
+
type CreateFulfillmentResult = {
|
|
83
|
+
id: string;
|
|
84
|
+
status: string;
|
|
85
|
+
trackingInfo: {
|
|
86
|
+
company: string | null;
|
|
87
|
+
number: string | null;
|
|
88
|
+
}[];
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* Creates a fulfillment for a fulfillment order with optional tracking info.
|
|
92
|
+
*
|
|
93
|
+
* @param fulfillmentOrderId - The fulfillment order ID (numeric, bigint, or GID string)
|
|
94
|
+
* @param fulfillmentOrderLineItems - Line items to fulfill with their quantities
|
|
95
|
+
* @param options - Optional tracking and notification settings
|
|
96
|
+
* @returns Promise resolving to the created fulfillment
|
|
97
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
98
|
+
* @throws {Error} When GraphQL errors occur
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* // Fulfill specific line items without tracking
|
|
102
|
+
* await createFulfillment(123456789, [{ id: 111, quantity: 2 }])
|
|
103
|
+
*
|
|
104
|
+
* // Fulfill all items without tracking
|
|
105
|
+
* await createFulfillment(123456789, [])
|
|
106
|
+
*
|
|
107
|
+
* // Fulfill with tracking info
|
|
108
|
+
* await createFulfillment(
|
|
109
|
+
* 123456789,
|
|
110
|
+
* [{ id: 111, quantity: 2 }],
|
|
111
|
+
* { trackingNumber: 'TRACK123', carrier: 'DHL', notifyCustomer: true }
|
|
112
|
+
* )
|
|
113
|
+
*/
|
|
114
|
+
declare function createFulfillment(fulfillmentOrderId: number | bigint | string, fulfillmentOrderLineItems: FulfillmentLineItem$1[], options?: {
|
|
115
|
+
trackingNumber?: string;
|
|
116
|
+
carrier?: string;
|
|
117
|
+
trackingUrl?: string;
|
|
118
|
+
notifyCustomer?: boolean;
|
|
119
|
+
}): Promise<CreateFulfillmentResult>;
|
|
120
|
+
|
|
121
|
+
type UpdateFulfillmentTrackingResult = {
|
|
122
|
+
trackingNumbers: string[];
|
|
123
|
+
trackingCompany: string | null;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Adds a tracking number to an existing fulfillment.
|
|
127
|
+
* Fetches existing tracking info and appends the new tracking number.
|
|
128
|
+
*
|
|
129
|
+
* @param fulfillmentId - The fulfillment ID (numeric, bigint, or GID string)
|
|
130
|
+
* @param trackingNumber - The new tracking number to add
|
|
131
|
+
* @param notifyCustomer - Whether to notify the customer (default: false)
|
|
132
|
+
* @returns Promise resolving to the updated tracking info
|
|
133
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
134
|
+
* @throws {Error} When fulfillment not found or GraphQL errors occur
|
|
135
|
+
*
|
|
136
|
+
* @example
|
|
137
|
+
* // Add tracking to fulfillment, don't notify customer yet
|
|
138
|
+
* await updateFulfillmentTracking(123456789, 'TRACK123')
|
|
139
|
+
*
|
|
140
|
+
* // Add tracking and notify customer (e.g., last item in order)
|
|
141
|
+
* await updateFulfillmentTracking(123456789, 'TRACK456', true)
|
|
142
|
+
*/
|
|
143
|
+
declare function updateFulfillmentTracking(fulfillmentId: number | bigint | string, trackingNumber: string, notifyCustomer?: boolean): Promise<UpdateFulfillmentTrackingResult>;
|
|
5
144
|
|
|
6
145
|
/**
|
|
7
146
|
* Cancel an order in Shopify.
|
|
@@ -26,30 +165,6 @@ declare function deleteCustomerById(customerId: string): Promise<z.infer<typeof
|
|
|
26
165
|
*/
|
|
27
166
|
declare function cancelOrderById(orderId: number | bigint | string): Promise<boolean>;
|
|
28
167
|
|
|
29
|
-
interface ShopifyUserErrorDetail {
|
|
30
|
-
code?: string | null;
|
|
31
|
-
field?: string[] | null;
|
|
32
|
-
message?: string | null;
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* Custom error class for Shopify mutation userErrors.
|
|
36
|
-
* Preserves the full error array so callers can inspect specific error codes.
|
|
37
|
-
*
|
|
38
|
-
* @example
|
|
39
|
-
* try {
|
|
40
|
-
* await cancelOrderById(orderId)
|
|
41
|
-
* } catch (error) {
|
|
42
|
-
* if (error instanceof ShopifyUserError) {
|
|
43
|
-
* const alreadyCancelled = error.errors.some(e => e.code === 'ORDER_ALREADY_CANCELLED')
|
|
44
|
-
* if (alreadyCancelled) { ... }
|
|
45
|
-
* }
|
|
46
|
-
* }
|
|
47
|
-
*/
|
|
48
|
-
declare class ShopifyUserError extends Error {
|
|
49
|
-
readonly errors: ShopifyUserErrorDetail[];
|
|
50
|
-
constructor(message: string, errors: ShopifyUserErrorDetail[]);
|
|
51
|
-
}
|
|
52
|
-
|
|
53
168
|
type Maybe<T> = T | null;
|
|
54
169
|
type InputMaybe<T> = Maybe<T>;
|
|
55
170
|
type Exact<T extends {
|
|
@@ -476,7 +591,7 @@ type AppInstallation = HasMetafields & Node & {
|
|
|
476
591
|
app: App;
|
|
477
592
|
/**
|
|
478
593
|
* Channel associated with the installed application.
|
|
479
|
-
* @deprecated Use `
|
|
594
|
+
* @deprecated Use the root-level `channels` query instead.
|
|
480
595
|
*/
|
|
481
596
|
channel?: Maybe<Channel>;
|
|
482
597
|
/** Credits that can be used towards future app purchases. */
|
|
@@ -498,7 +613,10 @@ type AppInstallation = HasMetafields & Node & {
|
|
|
498
613
|
metafields: MetafieldConnection;
|
|
499
614
|
/** One-time purchases to a shop. */
|
|
500
615
|
oneTimePurchases: AppPurchaseOneTimeConnection;
|
|
501
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* The publication associated with the installed application.
|
|
618
|
+
* @deprecated Use the root-level `publications` query instead.
|
|
619
|
+
*/
|
|
502
620
|
publication?: Maybe<Publication>;
|
|
503
621
|
/** The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. */
|
|
504
622
|
revenueAttributionRecords: AppRevenueAttributionRecordConnection;
|
|
@@ -1279,7 +1397,7 @@ type CalculatedDraftOrderLineItem = {
|
|
|
1279
1397
|
*/
|
|
1280
1398
|
uuid: Scalars['String']['output'];
|
|
1281
1399
|
/** The product variant for the line item. */
|
|
1282
|
-
variant?: Maybe<ProductVariant>;
|
|
1400
|
+
variant?: Maybe<ProductVariant$1>;
|
|
1283
1401
|
/** The name of the variant. */
|
|
1284
1402
|
variantTitle?: Maybe<Scalars['String']['output']>;
|
|
1285
1403
|
/** The name of the vendor who created the product variant. */
|
|
@@ -1624,6 +1742,7 @@ type Collection = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPubli
|
|
|
1624
1742
|
* Whether the resource is published to the app's
|
|
1625
1743
|
* [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
|
|
1626
1744
|
* For example, the resource might be published to the app's online store channel.
|
|
1745
|
+
* @deprecated Use `publishedOnPublication` instead.
|
|
1627
1746
|
*/
|
|
1628
1747
|
publishedOnCurrentPublication: Scalars['Boolean']['output'];
|
|
1629
1748
|
/**
|
|
@@ -1900,7 +2019,7 @@ type CombinedListing = {
|
|
|
1900
2019
|
type CombinedListingChild = {
|
|
1901
2020
|
__typename?: 'CombinedListingChild';
|
|
1902
2021
|
/** The parent variant. */
|
|
1903
|
-
parentVariant: ProductVariant;
|
|
2022
|
+
parentVariant: ProductVariant$1;
|
|
1904
2023
|
/** The child product. */
|
|
1905
2024
|
product: Product;
|
|
1906
2025
|
};
|
|
@@ -2153,7 +2272,7 @@ type CompanyContact = Node & {
|
|
|
2153
2272
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was created at Shopify. */
|
|
2154
2273
|
createdAt: Scalars['DateTime']['output'];
|
|
2155
2274
|
/** The customer associated to this contact. */
|
|
2156
|
-
customer: Customer;
|
|
2275
|
+
customer: Customer$1;
|
|
2157
2276
|
/** The list of draft orders for the company contact. */
|
|
2158
2277
|
draftOrders: DraftOrderConnection;
|
|
2159
2278
|
/** A globally-unique ID. */
|
|
@@ -2965,6 +3084,13 @@ type CountryHarmonizedSystemCodeEdge = {
|
|
|
2965
3084
|
/** The item at the end of CountryHarmonizedSystemCodeEdge. */
|
|
2966
3085
|
node: CountryHarmonizedSystemCode;
|
|
2967
3086
|
};
|
|
3087
|
+
/** The input fields required to specify a harmonized system code. */
|
|
3088
|
+
type CountryHarmonizedSystemCodeInput = {
|
|
3089
|
+
/** The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. */
|
|
3090
|
+
countryCode: CountryCode;
|
|
3091
|
+
/** Country specific harmonized system code. */
|
|
3092
|
+
harmonizedSystemCode: Scalars['String']['input'];
|
|
3093
|
+
};
|
|
2968
3094
|
/**
|
|
2969
3095
|
* The currency codes that represent the world currencies throughout the Admin API. Currency codes include
|
|
2970
3096
|
* [standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes,
|
|
@@ -3355,11 +3481,11 @@ type CurrencySettingEdge = {
|
|
|
3355
3481
|
* > Caution:
|
|
3356
3482
|
* > 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.
|
|
3357
3483
|
*/
|
|
3358
|
-
type Customer = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasMetafields & HasStoreCreditAccounts & LegacyInteroperability & Node & {
|
|
3484
|
+
type Customer$1 = CommentEventSubject & HasEvents & HasMetafieldDefinitions & HasMetafields & HasStoreCreditAccounts & LegacyInteroperability & Node & {
|
|
3359
3485
|
__typename?: 'Customer';
|
|
3360
3486
|
/**
|
|
3361
|
-
* A list of addresses associated with the customer. Limited to 250 addresses. Use `
|
|
3362
|
-
* @deprecated Limited to 250 addresses. Use `
|
|
3487
|
+
* A list of addresses associated with the customer. Limited to 250 addresses. Use `addressesV2` for paginated access to all addresses.
|
|
3488
|
+
* @deprecated Limited to 250 addresses. Use `addressesV2` for paginated access to all addresses.
|
|
3363
3489
|
*/
|
|
3364
3490
|
addresses: Array<MailingAddress>;
|
|
3365
3491
|
/** The addresses associated with the customer. */
|
|
@@ -3540,7 +3666,7 @@ type CustomerConnection = {
|
|
|
3540
3666
|
/** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
|
|
3541
3667
|
edges: Array<CustomerEdge>;
|
|
3542
3668
|
/** A list of nodes that are contained in CustomerEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
|
|
3543
|
-
nodes: Array<Customer>;
|
|
3669
|
+
nodes: Array<Customer$1>;
|
|
3544
3670
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
3545
3671
|
pageInfo: PageInfo;
|
|
3546
3672
|
};
|
|
@@ -3628,7 +3754,7 @@ type CustomerEdge = {
|
|
|
3628
3754
|
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
3629
3755
|
cursor: Scalars['String']['output'];
|
|
3630
3756
|
/** The item at the end of CustomerEdge. */
|
|
3631
|
-
node: Customer;
|
|
3757
|
+
node: Customer$1;
|
|
3632
3758
|
};
|
|
3633
3759
|
/**
|
|
3634
3760
|
* 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).
|
|
@@ -3907,7 +4033,7 @@ type CustomerPaymentInstrumentBillingAddress = {
|
|
|
3907
4033
|
type CustomerPaymentMethod = Node & {
|
|
3908
4034
|
__typename?: 'CustomerPaymentMethod';
|
|
3909
4035
|
/** The customer to whom the payment method belongs. */
|
|
3910
|
-
customer?: Maybe<Customer>;
|
|
4036
|
+
customer?: Maybe<Customer$1>;
|
|
3911
4037
|
/** The ID of this payment method. */
|
|
3912
4038
|
id: Scalars['ID']['output'];
|
|
3913
4039
|
/** The instrument for this payment method. */
|
|
@@ -4076,6 +4202,65 @@ declare enum CustomerRfmGroup {
|
|
|
4076
4202
|
/** Customers with no orders yet. */
|
|
4077
4203
|
Prospects = "PROSPECTS"
|
|
4078
4204
|
}
|
|
4205
|
+
/** The member of a segment. */
|
|
4206
|
+
type CustomerSegmentMember$1 = HasMetafields & {
|
|
4207
|
+
__typename?: 'CustomerSegmentMember';
|
|
4208
|
+
/** The total amount of money that the member has spent on orders. */
|
|
4209
|
+
amountSpent?: Maybe<MoneyV2>;
|
|
4210
|
+
/** The member's default address. */
|
|
4211
|
+
defaultAddress?: Maybe<MailingAddress>;
|
|
4212
|
+
/** The member's default email address. */
|
|
4213
|
+
defaultEmailAddress?: Maybe<CustomerEmailAddress>;
|
|
4214
|
+
/** The member's default phone number. */
|
|
4215
|
+
defaultPhoneNumber?: Maybe<CustomerPhoneNumber>;
|
|
4216
|
+
/** The full name of the member, which is based on the values of the `first_name` and `last_name` fields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used. */
|
|
4217
|
+
displayName: Scalars['String']['output'];
|
|
4218
|
+
/** The member's first name. */
|
|
4219
|
+
firstName?: Maybe<Scalars['String']['output']>;
|
|
4220
|
+
/** The member’s ID. */
|
|
4221
|
+
id: Scalars['ID']['output'];
|
|
4222
|
+
/** The member's last name. */
|
|
4223
|
+
lastName?: Maybe<Scalars['String']['output']>;
|
|
4224
|
+
/** The ID of the member's most recent order. */
|
|
4225
|
+
lastOrderId?: Maybe<Scalars['ID']['output']>;
|
|
4226
|
+
/** Whether the customer can be merged with another customer. */
|
|
4227
|
+
mergeable: CustomerMergeable;
|
|
4228
|
+
/**
|
|
4229
|
+
* A [custom field](https://shopify.dev/docs/apps/build/custom-data),
|
|
4230
|
+
* including its `namespace` and `key`, that's associated with a Shopify resource
|
|
4231
|
+
* for the purposes of adding and storing additional information.
|
|
4232
|
+
*/
|
|
4233
|
+
metafield?: Maybe<Metafield>;
|
|
4234
|
+
/**
|
|
4235
|
+
* A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data)
|
|
4236
|
+
* that a merchant associates with a Shopify resource.
|
|
4237
|
+
*/
|
|
4238
|
+
metafields: MetafieldConnection;
|
|
4239
|
+
/** A note about the member. */
|
|
4240
|
+
note?: Maybe<Scalars['String']['output']>;
|
|
4241
|
+
/** The total number of orders that the member has made. */
|
|
4242
|
+
numberOfOrders?: Maybe<Scalars['UnsignedInt64']['output']>;
|
|
4243
|
+
};
|
|
4244
|
+
/** The connection type for the `CustomerSegmentMembers` object. */
|
|
4245
|
+
type CustomerSegmentMemberConnection = {
|
|
4246
|
+
__typename?: 'CustomerSegmentMemberConnection';
|
|
4247
|
+
/** A list of edges. */
|
|
4248
|
+
edges: Array<CustomerSegmentMemberEdge>;
|
|
4249
|
+
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
4250
|
+
pageInfo: PageInfo;
|
|
4251
|
+
/** The statistics for a given segment. */
|
|
4252
|
+
statistics: SegmentStatistics;
|
|
4253
|
+
/** The total number of members in a given segment. */
|
|
4254
|
+
totalCount: Scalars['Int']['output'];
|
|
4255
|
+
};
|
|
4256
|
+
/** An auto-generated type which holds one CustomerSegmentMember and a cursor during pagination. */
|
|
4257
|
+
type CustomerSegmentMemberEdge = {
|
|
4258
|
+
__typename?: 'CustomerSegmentMemberEdge';
|
|
4259
|
+
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
4260
|
+
cursor: Scalars['String']['output'];
|
|
4261
|
+
/** The item at the end of CustomerSegmentMemberEdge. */
|
|
4262
|
+
node: CustomerSegmentMember$1;
|
|
4263
|
+
};
|
|
4079
4264
|
/** Represents a Shop Pay card instrument for customer payment method. */
|
|
4080
4265
|
type CustomerShopPayAgreement = {
|
|
4081
4266
|
__typename?: 'CustomerShopPayAgreement';
|
|
@@ -5559,8 +5744,8 @@ type DiscountCodeApp = {
|
|
|
5559
5744
|
/** The date and time when the discount was updated. */
|
|
5560
5745
|
updatedAt: Scalars['DateTime']['output'];
|
|
5561
5746
|
/**
|
|
5562
|
-
* The maximum number of times
|
|
5563
|
-
* For
|
|
5747
|
+
* The maximum number of times the discount can be redeemed.
|
|
5748
|
+
* For unlimited usage, specify `null`.
|
|
5564
5749
|
*/
|
|
5565
5750
|
usageLimit?: Maybe<Scalars['Int']['output']>;
|
|
5566
5751
|
};
|
|
@@ -5673,8 +5858,8 @@ type DiscountCodeBasic = {
|
|
|
5673
5858
|
/** The date and time when the discount was updated. */
|
|
5674
5859
|
updatedAt: Scalars['DateTime']['output'];
|
|
5675
5860
|
/**
|
|
5676
|
-
* The maximum number of times
|
|
5677
|
-
* For
|
|
5861
|
+
* The maximum number of times the discount can be redeemed.
|
|
5862
|
+
* For unlimited usage, specify `null`.
|
|
5678
5863
|
*/
|
|
5679
5864
|
usageLimit?: Maybe<Scalars['Int']['output']>;
|
|
5680
5865
|
};
|
|
@@ -5775,8 +5960,8 @@ type DiscountCodeBxgy = {
|
|
|
5775
5960
|
/** The date and time when the discount was updated. */
|
|
5776
5961
|
updatedAt: Scalars['DateTime']['output'];
|
|
5777
5962
|
/**
|
|
5778
|
-
* The maximum number of times
|
|
5779
|
-
* For
|
|
5963
|
+
* The maximum number of times the discount can be redeemed.
|
|
5964
|
+
* For unlimited usage, specify `null`.
|
|
5780
5965
|
*/
|
|
5781
5966
|
usageLimit?: Maybe<Scalars['Int']['output']>;
|
|
5782
5967
|
/** The maximum number of times that the discount can be applied to an order. */
|
|
@@ -5914,8 +6099,8 @@ type DiscountCodeFreeShipping = {
|
|
|
5914
6099
|
/** The date and time when the discount was updated. */
|
|
5915
6100
|
updatedAt: Scalars['DateTime']['output'];
|
|
5916
6101
|
/**
|
|
5917
|
-
* The maximum number of times
|
|
5918
|
-
* For
|
|
6102
|
+
* The maximum number of times the discount can be redeemed.
|
|
6103
|
+
* For unlimited usage, specify `null`.
|
|
5919
6104
|
*/
|
|
5920
6105
|
usageLimit?: Maybe<Scalars['Int']['output']>;
|
|
5921
6106
|
};
|
|
@@ -6085,7 +6270,7 @@ type DiscountCustomerSelection = DiscountCustomerAll | DiscountCustomerSegments
|
|
|
6085
6270
|
type DiscountCustomers = {
|
|
6086
6271
|
__typename?: 'DiscountCustomers';
|
|
6087
6272
|
/** The list of individual customers eligible for the discount. */
|
|
6088
|
-
customers: Array<Customer>;
|
|
6273
|
+
customers: Array<Customer$1>;
|
|
6089
6274
|
};
|
|
6090
6275
|
/** The type of discount that will be applied. Currently, only a percentage discount is supported. */
|
|
6091
6276
|
type DiscountEffect = DiscountAmount | DiscountPercentage;
|
|
@@ -6384,7 +6569,7 @@ type DraftOrder = CommentEventSubject & HasEvents & HasLocalizationExtensions &
|
|
|
6384
6569
|
/** The custom information added to the draft order on behalf of the customer. */
|
|
6385
6570
|
customAttributes: Array<Attribute>;
|
|
6386
6571
|
/** The customer who will be sent an invoice. */
|
|
6387
|
-
customer?: Maybe<Customer>;
|
|
6572
|
+
customer?: Maybe<Customer$1>;
|
|
6388
6573
|
/** A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. */
|
|
6389
6574
|
defaultCursor: Scalars['String']['output'];
|
|
6390
6575
|
/** All discount codes applied. */
|
|
@@ -6705,7 +6890,7 @@ type DraftOrderLineItem = Node & {
|
|
|
6705
6890
|
*/
|
|
6706
6891
|
uuid: Scalars['String']['output'];
|
|
6707
6892
|
/** The product variant for the line item. */
|
|
6708
|
-
variant?: Maybe<ProductVariant>;
|
|
6893
|
+
variant?: Maybe<ProductVariant$1>;
|
|
6709
6894
|
/** The name of the variant. */
|
|
6710
6895
|
variantTitle?: Maybe<Scalars['String']['output']>;
|
|
6711
6896
|
/** The name of the vendor who created the product variant. */
|
|
@@ -7006,7 +7191,7 @@ type ExchangeV2LineItem = {
|
|
|
7006
7191
|
/** The title of the product or variant. This field only applies to custom line items. */
|
|
7007
7192
|
title: Scalars['String']['output'];
|
|
7008
7193
|
/** The product variant of the line item. */
|
|
7009
|
-
variant?: Maybe<ProductVariant>;
|
|
7194
|
+
variant?: Maybe<ProductVariant$1>;
|
|
7010
7195
|
/** The name of the variant. */
|
|
7011
7196
|
variantTitle?: Maybe<Scalars['String']['output']>;
|
|
7012
7197
|
/** The name of the vendor who created the product variant. */
|
|
@@ -7030,6 +7215,43 @@ type ExchangeV2Returns = {
|
|
|
7030
7215
|
/** The total value of the items being returned. */
|
|
7031
7216
|
totalPriceSet: MoneyBag;
|
|
7032
7217
|
};
|
|
7218
|
+
/** Represents a video hosted outside of Shopify. */
|
|
7219
|
+
type ExternalVideo = File & Media & Node & {
|
|
7220
|
+
__typename?: 'ExternalVideo';
|
|
7221
|
+
/** A word or phrase to describe the contents or the function of a file. */
|
|
7222
|
+
alt?: Maybe<Scalars['String']['output']>;
|
|
7223
|
+
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created. */
|
|
7224
|
+
createdAt: Scalars['DateTime']['output'];
|
|
7225
|
+
/** The embed URL of the video for the respective host. */
|
|
7226
|
+
embedUrl: Scalars['URL']['output'];
|
|
7227
|
+
/**
|
|
7228
|
+
* The URL.
|
|
7229
|
+
* @deprecated Use `originUrl` instead.
|
|
7230
|
+
*/
|
|
7231
|
+
embeddedUrl: Scalars['URL']['output'];
|
|
7232
|
+
/** Any errors that have occurred on the file. */
|
|
7233
|
+
fileErrors: Array<FileError>;
|
|
7234
|
+
/** The status of the file. */
|
|
7235
|
+
fileStatus: FileStatus;
|
|
7236
|
+
/** The host of the external video. */
|
|
7237
|
+
host: MediaHost;
|
|
7238
|
+
/** A globally-unique ID. */
|
|
7239
|
+
id: Scalars['ID']['output'];
|
|
7240
|
+
/** The media content type. */
|
|
7241
|
+
mediaContentType: MediaContentType;
|
|
7242
|
+
/** Any errors which have occurred on the media. */
|
|
7243
|
+
mediaErrors: Array<MediaError>;
|
|
7244
|
+
/** The warnings attached to the media. */
|
|
7245
|
+
mediaWarnings: Array<MediaWarning>;
|
|
7246
|
+
/** The origin URL of the video on the respective host. */
|
|
7247
|
+
originUrl: Scalars['URL']['output'];
|
|
7248
|
+
/** The preview image for the media. */
|
|
7249
|
+
preview?: Maybe<MediaPreviewImage>;
|
|
7250
|
+
/** Current status of the media. */
|
|
7251
|
+
status: MediaStatus;
|
|
7252
|
+
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */
|
|
7253
|
+
updatedAt: Scalars['DateTime']['output'];
|
|
7254
|
+
};
|
|
7033
7255
|
/** Requirements that must be met before an app can be installed. */
|
|
7034
7256
|
type FailedRequirement = {
|
|
7035
7257
|
__typename?: 'FailedRequirement';
|
|
@@ -7063,6 +7285,55 @@ type File = {
|
|
|
7063
7285
|
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */
|
|
7064
7286
|
updatedAt: Scalars['DateTime']['output'];
|
|
7065
7287
|
};
|
|
7288
|
+
/** The possible content types for a file object. */
|
|
7289
|
+
declare enum FileContentType {
|
|
7290
|
+
/** An externally hosted video. */
|
|
7291
|
+
ExternalVideo = "EXTERNAL_VIDEO",
|
|
7292
|
+
/** A Shopify-hosted generic file. */
|
|
7293
|
+
File = "FILE",
|
|
7294
|
+
/** A Shopify-hosted image. */
|
|
7295
|
+
Image = "IMAGE",
|
|
7296
|
+
/** A Shopify-hosted 3D model. */
|
|
7297
|
+
Model_3D = "MODEL_3D",
|
|
7298
|
+
/** A Shopify-hosted video file. It's recommended to use this type for all video files. */
|
|
7299
|
+
Video = "VIDEO"
|
|
7300
|
+
}
|
|
7301
|
+
/** The input fields that are required to create a file object. */
|
|
7302
|
+
type FileCreateInput = {
|
|
7303
|
+
/** The alt text description of the file for screen readers and accessibility. */
|
|
7304
|
+
alt?: InputMaybe<Scalars['String']['input']>;
|
|
7305
|
+
/** The file content type. If omitted, then Shopify will attempt to determine the content type during file processing. */
|
|
7306
|
+
contentType?: InputMaybe<FileContentType>;
|
|
7307
|
+
/** How to handle if filename is already in use. */
|
|
7308
|
+
duplicateResolutionMode?: InputMaybe<FileCreateInputDuplicateResolutionMode>;
|
|
7309
|
+
/**
|
|
7310
|
+
* The name of the file. If provided, then the file is created with the specified filename.
|
|
7311
|
+
* If not provided, then the filename from the `originalSource` is used.
|
|
7312
|
+
*/
|
|
7313
|
+
filename?: InputMaybe<Scalars['String']['input']>;
|
|
7314
|
+
/**
|
|
7315
|
+
* An external URL (for images only) or a
|
|
7316
|
+
* [staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).
|
|
7317
|
+
*/
|
|
7318
|
+
originalSource: Scalars['String']['input'];
|
|
7319
|
+
};
|
|
7320
|
+
/** The input fields for handling if filename is already in use. */
|
|
7321
|
+
declare enum FileCreateInputDuplicateResolutionMode {
|
|
7322
|
+
/** Append a UUID if filename is already in use. */
|
|
7323
|
+
AppendUuid = "APPEND_UUID",
|
|
7324
|
+
/** Raise an error if filename is already in use. */
|
|
7325
|
+
RaiseError = "RAISE_ERROR",
|
|
7326
|
+
/** Replace the existing file if filename is already in use. */
|
|
7327
|
+
Replace = "REPLACE"
|
|
7328
|
+
}
|
|
7329
|
+
/** Return type for `fileDelete` mutation. */
|
|
7330
|
+
type FileDeletePayload = {
|
|
7331
|
+
__typename?: 'FileDeletePayload';
|
|
7332
|
+
/** The IDs of the deleted files. */
|
|
7333
|
+
deletedFileIds?: Maybe<Array<Scalars['ID']['output']>>;
|
|
7334
|
+
/** The list of errors that occurred from executing the mutation. */
|
|
7335
|
+
userErrors: Array<FilesUserError>;
|
|
7336
|
+
};
|
|
7066
7337
|
/**
|
|
7067
7338
|
* A file error. This typically occurs when there is an issue with the file itself causing it to fail validation.
|
|
7068
7339
|
* Check the file before attempting to upload again.
|
|
@@ -7156,6 +7427,75 @@ declare enum FileStatus {
|
|
|
7156
7427
|
/** File has been uploaded but hasn't been processed. */
|
|
7157
7428
|
Uploaded = "UPLOADED"
|
|
7158
7429
|
}
|
|
7430
|
+
/** Possible error codes that can be returned by `FilesUserError`. */
|
|
7431
|
+
declare enum FilesErrorCode {
|
|
7432
|
+
/** The alt value exceeds the maximum limit of 512 characters. */
|
|
7433
|
+
AltValueLimitExceeded = "ALT_VALUE_LIMIT_EXCEEDED",
|
|
7434
|
+
/** The search term must not be blank. */
|
|
7435
|
+
BlankSearch = "BLANK_SEARCH",
|
|
7436
|
+
/** The provided filename already exists. */
|
|
7437
|
+
FilenameAlreadyExists = "FILENAME_ALREADY_EXISTS",
|
|
7438
|
+
/** File does not exist. */
|
|
7439
|
+
FileDoesNotExist = "FILE_DOES_NOT_EXIST",
|
|
7440
|
+
/** File has a pending operation. */
|
|
7441
|
+
FileLocked = "FILE_LOCKED",
|
|
7442
|
+
/** The input value is invalid. */
|
|
7443
|
+
Invalid = "INVALID",
|
|
7444
|
+
/** Duplicate resolution mode is not supported for this file type. */
|
|
7445
|
+
InvalidDuplicateModeForType = "INVALID_DUPLICATE_MODE_FOR_TYPE",
|
|
7446
|
+
/** Invalid duplicate resolution mode provided. */
|
|
7447
|
+
InvalidDuplicateResolutionMode = "INVALID_DUPLICATE_RESOLUTION_MODE",
|
|
7448
|
+
/** File cannot be updated in a failed state. */
|
|
7449
|
+
InvalidFailedMediaState = "INVALID_FAILED_MEDIA_STATE",
|
|
7450
|
+
/** The provided filename is invalid. */
|
|
7451
|
+
InvalidFilename = "INVALID_FILENAME",
|
|
7452
|
+
/** Invalid filename extension. */
|
|
7453
|
+
InvalidFilenameExtension = "INVALID_FILENAME_EXTENSION",
|
|
7454
|
+
/** Invalid image source url value provided. */
|
|
7455
|
+
InvalidImageSourceUrl = "INVALID_IMAGE_SOURCE_URL",
|
|
7456
|
+
/** Search query isn't supported. */
|
|
7457
|
+
InvalidQuery = "INVALID_QUERY",
|
|
7458
|
+
/** Cannot create file with custom filename which does not match original source extension. */
|
|
7459
|
+
MismatchedFilenameAndOriginalSource = "MISMATCHED_FILENAME_AND_ORIGINAL_SOURCE",
|
|
7460
|
+
/** At least one argument is required. */
|
|
7461
|
+
MissingArguments = "MISSING_ARGUMENTS",
|
|
7462
|
+
/** Duplicate resolution mode REPLACE cannot be used without specifying filename. */
|
|
7463
|
+
MissingFilenameForDuplicateModeReplace = "MISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACE",
|
|
7464
|
+
/** Exceeded the limit of non-image media per shop. */
|
|
7465
|
+
NonImageMediaPerShopLimitExceeded = "NON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDED",
|
|
7466
|
+
/** The file is not in the READY state. */
|
|
7467
|
+
NonReadyState = "NON_READY_STATE",
|
|
7468
|
+
/** Exceeded the limit of media per product. */
|
|
7469
|
+
ProductMediaLimitExceeded = "PRODUCT_MEDIA_LIMIT_EXCEEDED",
|
|
7470
|
+
/** One or more associated products are suspended. */
|
|
7471
|
+
ProductSuspended = "PRODUCT_SUSPENDED",
|
|
7472
|
+
/** The target resource does not exist. */
|
|
7473
|
+
ReferenceTargetDoesNotExist = "REFERENCE_TARGET_DOES_NOT_EXIST",
|
|
7474
|
+
/** Specify one argument: search, IDs, or deleteAll. */
|
|
7475
|
+
TooManyArguments = "TOO_MANY_ARGUMENTS",
|
|
7476
|
+
/** Cannot add more than 10000 references to a file. */
|
|
7477
|
+
TooManyFileReference = "TOO_MANY_FILE_REFERENCE",
|
|
7478
|
+
/** The file type is not supported. */
|
|
7479
|
+
UnacceptableAsset = "UNACCEPTABLE_ASSET",
|
|
7480
|
+
/** The file is not supported on trial accounts. Select a plan to upload this file. */
|
|
7481
|
+
UnacceptableTrialAsset = "UNACCEPTABLE_TRIAL_ASSET",
|
|
7482
|
+
/** The file is not supported on trial accounts that have not validated their email. Either select a plan or verify the shop owner email to upload this file. */
|
|
7483
|
+
UnacceptableUnverifiedTrialAsset = "UNACCEPTABLE_UNVERIFIED_TRIAL_ASSET",
|
|
7484
|
+
/** The file type is not supported for referencing. */
|
|
7485
|
+
UnsupportedFileReference = "UNSUPPORTED_FILE_REFERENCE",
|
|
7486
|
+
/** Filename update is only supported on Image and GenericFile. */
|
|
7487
|
+
UnsupportedMediaTypeForFilenameUpdate = "UNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATE"
|
|
7488
|
+
}
|
|
7489
|
+
/** An error that happens during the execution of a Files API query or mutation. */
|
|
7490
|
+
type FilesUserError = DisplayableError & {
|
|
7491
|
+
__typename?: 'FilesUserError';
|
|
7492
|
+
/** The error code. */
|
|
7493
|
+
code?: Maybe<FilesErrorCode>;
|
|
7494
|
+
/** The path to the input field that caused the error. */
|
|
7495
|
+
field?: Maybe<Array<Scalars['String']['output']>>;
|
|
7496
|
+
/** The error message. */
|
|
7497
|
+
message: Scalars['String']['output'];
|
|
7498
|
+
};
|
|
7159
7499
|
/** A filter option is one possible value in a search filter. */
|
|
7160
7500
|
type FilterOption = {
|
|
7161
7501
|
__typename?: 'FilterOption';
|
|
@@ -7192,7 +7532,7 @@ type FinancialSummaryDiscountApplication = {
|
|
|
7192
7532
|
*
|
|
7193
7533
|
* Multiple fulfillments can exist for a single order when items either ship separately or from different locations.
|
|
7194
7534
|
*/
|
|
7195
|
-
type Fulfillment = LegacyInteroperability & Node & {
|
|
7535
|
+
type Fulfillment$1 = LegacyInteroperability & Node & {
|
|
7196
7536
|
__typename?: 'Fulfillment';
|
|
7197
7537
|
/** The date and time when the fulfillment was created. */
|
|
7198
7538
|
createdAt: Scalars['DateTime']['output'];
|
|
@@ -7244,7 +7584,7 @@ type FulfillmentConnection = {
|
|
|
7244
7584
|
/** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
|
|
7245
7585
|
edges: Array<FulfillmentEdge>;
|
|
7246
7586
|
/** A list of nodes that are contained in FulfillmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
|
|
7247
|
-
nodes: Array<Fulfillment>;
|
|
7587
|
+
nodes: Array<Fulfillment$1>;
|
|
7248
7588
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
7249
7589
|
pageInfo: PageInfo;
|
|
7250
7590
|
};
|
|
@@ -7291,7 +7631,7 @@ type FulfillmentEdge = {
|
|
|
7291
7631
|
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
7292
7632
|
cursor: Scalars['String']['output'];
|
|
7293
7633
|
/** The item at the end of FulfillmentEdge. */
|
|
7294
|
-
node: Fulfillment;
|
|
7634
|
+
node: Fulfillment$1;
|
|
7295
7635
|
};
|
|
7296
7636
|
/**
|
|
7297
7637
|
* A tracking event that records the status and location of a fulfillment at a specific point in time. Each event captures details such as the [status](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentEvent#field-FulfillmentEvent.fields.status) (for example, in transit, out for delivery, delivered) and any [messages](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentEvent#field-FulfillmentEvent.fields.message) associated with the event.
|
|
@@ -7408,6 +7748,28 @@ declare enum FulfillmentHoldReason {
|
|
|
7408
7748
|
/** The fulfillment hold is applied because of an unknown delivery date. */
|
|
7409
7749
|
UnknownDeliveryDate = "UNKNOWN_DELIVERY_DATE"
|
|
7410
7750
|
}
|
|
7751
|
+
/** The input fields used to create a fulfillment from fulfillment orders. */
|
|
7752
|
+
type FulfillmentInput = {
|
|
7753
|
+
/**
|
|
7754
|
+
* Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment
|
|
7755
|
+
* order line items that have to be fulfilled for each fulfillment order. For any given pair, if the
|
|
7756
|
+
* fulfillment order line items are left blank then all the fulfillment order line items of the
|
|
7757
|
+
* associated fulfillment order ID will be fulfilled.
|
|
7758
|
+
*/
|
|
7759
|
+
lineItemsByFulfillmentOrder: Array<FulfillmentOrderLineItemsInput>;
|
|
7760
|
+
/**
|
|
7761
|
+
* Whether the customer is notified.
|
|
7762
|
+
* If `true`, then a notification is sent when the fulfillment is created. The default value is `false`.
|
|
7763
|
+
*/
|
|
7764
|
+
notifyCustomer?: InputMaybe<Scalars['Boolean']['input']>;
|
|
7765
|
+
/** Address information about the location from which the order was fulfilled. */
|
|
7766
|
+
originAddress?: InputMaybe<FulfillmentOriginAddressInput>;
|
|
7767
|
+
/**
|
|
7768
|
+
* The fulfillment's tracking information, including a tracking URL, a tracking number,
|
|
7769
|
+
* and the company associated with the fulfillment.
|
|
7770
|
+
*/
|
|
7771
|
+
trackingInfo?: InputMaybe<FulfillmentTrackingInput>;
|
|
7772
|
+
};
|
|
7411
7773
|
/**
|
|
7412
7774
|
* A line item from an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) that's included in a [`Fulfillment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment). Links the fulfillment to specific items from the original order, tracking how many units were fulfilled.
|
|
7413
7775
|
*
|
|
@@ -7617,7 +7979,7 @@ type FulfillmentLineItemEdge = {
|
|
|
7617
7979
|
*
|
|
7618
7980
|
* [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).
|
|
7619
7981
|
*/
|
|
7620
|
-
type FulfillmentOrder = Node & {
|
|
7982
|
+
type FulfillmentOrder$1 = Node & {
|
|
7621
7983
|
__typename?: 'FulfillmentOrder';
|
|
7622
7984
|
/**
|
|
7623
7985
|
* The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.
|
|
@@ -7778,9 +8140,9 @@ type FulfillmentOrderAssignedLocation = {
|
|
|
7778
8140
|
type FulfillmentOrderConnection = {
|
|
7779
8141
|
__typename?: 'FulfillmentOrderConnection';
|
|
7780
8142
|
/** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
|
|
7781
|
-
edges: Array<FulfillmentOrderEdge>;
|
|
8143
|
+
edges: Array<FulfillmentOrderEdge$1>;
|
|
7782
8144
|
/** A list of nodes that are contained in FulfillmentOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
|
|
7783
|
-
nodes: Array<FulfillmentOrder>;
|
|
8145
|
+
nodes: Array<FulfillmentOrder$1>;
|
|
7784
8146
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
7785
8147
|
pageInfo: PageInfo;
|
|
7786
8148
|
};
|
|
@@ -7815,12 +8177,12 @@ type FulfillmentOrderDestination = Node & {
|
|
|
7815
8177
|
zip?: Maybe<Scalars['String']['output']>;
|
|
7816
8178
|
};
|
|
7817
8179
|
/** An auto-generated type which holds one FulfillmentOrder and a cursor during pagination. */
|
|
7818
|
-
type FulfillmentOrderEdge = {
|
|
8180
|
+
type FulfillmentOrderEdge$1 = {
|
|
7819
8181
|
__typename?: 'FulfillmentOrderEdge';
|
|
7820
8182
|
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
7821
8183
|
cursor: Scalars['String']['output'];
|
|
7822
8184
|
/** The item at the end of FulfillmentOrderEdge. */
|
|
7823
|
-
node: FulfillmentOrder;
|
|
8185
|
+
node: FulfillmentOrder$1;
|
|
7824
8186
|
};
|
|
7825
8187
|
/** The international duties relevant to a fulfillment order. */
|
|
7826
8188
|
type FulfillmentOrderInternationalDuties = {
|
|
@@ -7861,7 +8223,7 @@ type FulfillmentOrderLineItem = Node & {
|
|
|
7861
8223
|
/** The total number of units to be fulfilled. */
|
|
7862
8224
|
totalQuantity: Scalars['Int']['output'];
|
|
7863
8225
|
/** The product variant associated to the fulfillment order line item. */
|
|
7864
|
-
variant?: Maybe<ProductVariant>;
|
|
8226
|
+
variant?: Maybe<ProductVariant$1>;
|
|
7865
8227
|
/** The name of the variant. */
|
|
7866
8228
|
variantTitle?: Maybe<Scalars['String']['output']>;
|
|
7867
8229
|
/** The name of the vendor who made the variant. */
|
|
@@ -7901,6 +8263,13 @@ type FulfillmentOrderLineItemFinancialSummary = {
|
|
|
7901
8263
|
/** Number of line items that this financial summary applies to. */
|
|
7902
8264
|
quantity: Scalars['Int']['output'];
|
|
7903
8265
|
};
|
|
8266
|
+
/** The input fields used to include the quantity of the fulfillment order line item that should be fulfilled. */
|
|
8267
|
+
type FulfillmentOrderLineItemInput = {
|
|
8268
|
+
/** The ID of the fulfillment order line item. */
|
|
8269
|
+
id: Scalars['ID']['input'];
|
|
8270
|
+
/** The quantity of the fulfillment order line item. */
|
|
8271
|
+
quantity: Scalars['Int']['input'];
|
|
8272
|
+
};
|
|
7904
8273
|
/** A fulfillment order line item warning. For example, a warning about why a fulfillment request was rejected. */
|
|
7905
8274
|
type FulfillmentOrderLineItemWarning = {
|
|
7906
8275
|
__typename?: 'FulfillmentOrderLineItemWarning';
|
|
@@ -7909,6 +8278,17 @@ type FulfillmentOrderLineItemWarning = {
|
|
|
7909
8278
|
/** The title of warning. */
|
|
7910
8279
|
title?: Maybe<Scalars['String']['output']>;
|
|
7911
8280
|
};
|
|
8281
|
+
/** The input fields used to include the line items of a specified fulfillment order that should be fulfilled. */
|
|
8282
|
+
type FulfillmentOrderLineItemsInput = {
|
|
8283
|
+
/** The ID of the fulfillment order. */
|
|
8284
|
+
fulfillmentOrderId: Scalars['ID']['input'];
|
|
8285
|
+
/**
|
|
8286
|
+
* The fulfillment order line items to be fulfilled.
|
|
8287
|
+
* If left blank, all line items of the fulfillment order will be fulfilled.
|
|
8288
|
+
* Accepts a maximum of 512 line items.
|
|
8289
|
+
*/
|
|
8290
|
+
fulfillmentOrderLineItems?: InputMaybe<Array<FulfillmentOrderLineItemInput>>;
|
|
8291
|
+
};
|
|
7912
8292
|
/** A location that a fulfillment order can potentially move to. */
|
|
7913
8293
|
type FulfillmentOrderLocationForMove = {
|
|
7914
8294
|
__typename?: 'FulfillmentOrderLocationForMove';
|
|
@@ -7961,7 +8341,7 @@ type FulfillmentOrderLocationForMoveEdge = {
|
|
|
7961
8341
|
type FulfillmentOrderMerchantRequest = Node & {
|
|
7962
8342
|
__typename?: 'FulfillmentOrderMerchantRequest';
|
|
7963
8343
|
/** The fulfillment order associated with the merchant request. */
|
|
7964
|
-
fulfillmentOrder: FulfillmentOrder;
|
|
8344
|
+
fulfillmentOrder: FulfillmentOrder$1;
|
|
7965
8345
|
/** A globally-unique ID. */
|
|
7966
8346
|
id: Scalars['ID']['output'];
|
|
7967
8347
|
/** The kind of request made. */
|
|
@@ -8071,6 +8451,21 @@ type FulfillmentOriginAddress = {
|
|
|
8071
8451
|
/** The zip code of the fulfillment location. */
|
|
8072
8452
|
zip?: Maybe<Scalars['String']['output']>;
|
|
8073
8453
|
};
|
|
8454
|
+
/** The input fields used to include the address at which the fulfillment occurred. This input object is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the `assignedLocation` field on the [`FulfillmentOrder`](/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object instead. */
|
|
8455
|
+
type FulfillmentOriginAddressInput = {
|
|
8456
|
+
/** The street address of the fulfillment location. */
|
|
8457
|
+
address1?: InputMaybe<Scalars['String']['input']>;
|
|
8458
|
+
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
|
|
8459
|
+
address2?: InputMaybe<Scalars['String']['input']>;
|
|
8460
|
+
/** The city in which the fulfillment location is located. */
|
|
8461
|
+
city?: InputMaybe<Scalars['String']['input']>;
|
|
8462
|
+
/** The country of the fulfillment location. */
|
|
8463
|
+
countryCode: Scalars['String']['input'];
|
|
8464
|
+
/** The province of the fulfillment location. */
|
|
8465
|
+
provinceCode?: InputMaybe<Scalars['String']['input']>;
|
|
8466
|
+
/** The zip code of the fulfillment location. */
|
|
8467
|
+
zip?: InputMaybe<Scalars['String']['input']>;
|
|
8468
|
+
};
|
|
8074
8469
|
/**
|
|
8075
8470
|
* A **Fulfillment Service** is a third party warehouse that prepares and ships orders
|
|
8076
8471
|
* on behalf of the store owner. Fulfillment services charge a fee to package and ship items
|
|
@@ -8392,6 +8787,113 @@ type FulfillmentTrackingInfo = {
|
|
|
8392
8787
|
*/
|
|
8393
8788
|
url?: Maybe<Scalars['URL']['output']>;
|
|
8394
8789
|
};
|
|
8790
|
+
/**
|
|
8791
|
+
* The input fields that specify all possible fields for tracking information.
|
|
8792
|
+
*
|
|
8793
|
+
* > Note:
|
|
8794
|
+
* > If you provide the `url` field, you should not provide the `urls` field.
|
|
8795
|
+
* >
|
|
8796
|
+
* > If you provide the `number` field, you should not provide the `numbers` field.
|
|
8797
|
+
* >
|
|
8798
|
+
* > If you provide the `url` field, you should provide the `number` field.
|
|
8799
|
+
* >
|
|
8800
|
+
* > If you provide the `urls` field, you should provide the `numbers` field.
|
|
8801
|
+
*/
|
|
8802
|
+
type FulfillmentTrackingInput = {
|
|
8803
|
+
/**
|
|
8804
|
+
* The name of the tracking company.
|
|
8805
|
+
*
|
|
8806
|
+
* If you specify a tracking company name from
|
|
8807
|
+
* [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies),
|
|
8808
|
+
* Shopify will automatically build tracking URLs for all provided tracking numbers,
|
|
8809
|
+
* which will make the tracking numbers clickable in the interface.
|
|
8810
|
+
* The same tracking company will be applied to all tracking numbers specified.
|
|
8811
|
+
*
|
|
8812
|
+
* Additionally, for the tracking companies listed on the
|
|
8813
|
+
* [Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers)
|
|
8814
|
+
* Shopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process.
|
|
8815
|
+
*
|
|
8816
|
+
* > Note:
|
|
8817
|
+
* > Send the tracking company name exactly as written in
|
|
8818
|
+
* > [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)
|
|
8819
|
+
* > (capitalization matters).
|
|
8820
|
+
*/
|
|
8821
|
+
company?: InputMaybe<Scalars['String']['input']>;
|
|
8822
|
+
/**
|
|
8823
|
+
* The tracking number of the fulfillment.
|
|
8824
|
+
*
|
|
8825
|
+
* The tracking number will be clickable in the interface if one of the following applies
|
|
8826
|
+
* (the highest in the list has the highest priority):
|
|
8827
|
+
*
|
|
8828
|
+
* * Tracking url provided in the `url` field.
|
|
8829
|
+
* * [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)
|
|
8830
|
+
* specified in the `company` field.
|
|
8831
|
+
* Shopify will build the tracking URL automatically based on the tracking number specified.
|
|
8832
|
+
* * The tracking number has a Shopify-known format.
|
|
8833
|
+
* Shopify will guess the tracking provider and build the tracking url based on the tracking number format.
|
|
8834
|
+
* Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.
|
|
8835
|
+
* This can result in an invalid tracking URL.
|
|
8836
|
+
* It is highly recommended that you send the tracking company and the tracking URL.
|
|
8837
|
+
*/
|
|
8838
|
+
number?: InputMaybe<Scalars['String']['input']>;
|
|
8839
|
+
/**
|
|
8840
|
+
* The tracking numbers of the fulfillment, one or many.
|
|
8841
|
+
*
|
|
8842
|
+
* With multiple tracking numbers, you can provide tracking information
|
|
8843
|
+
* for all shipments associated with the fulfillment, if there are more than one.
|
|
8844
|
+
* For example, if you're shipping assembly parts of one furniture item in several boxes.
|
|
8845
|
+
*
|
|
8846
|
+
* Tracking numbers will be clickable in the interface if one of the following applies
|
|
8847
|
+
* (the highest in the list has the highest priority):
|
|
8848
|
+
*
|
|
8849
|
+
* * Tracking URLs provided in the `urls` field.
|
|
8850
|
+
* The tracking URLs will be matched to the tracking numbers based on their positions in the arrays.
|
|
8851
|
+
* * [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)
|
|
8852
|
+
* specified in the `company` field.
|
|
8853
|
+
* Shopify will build tracking URLs automatically for all tracking numbers specified.
|
|
8854
|
+
* The same tracking company will be applied to all tracking numbers.
|
|
8855
|
+
* * Tracking numbers have a Shopify-known format.
|
|
8856
|
+
* Shopify will guess tracking providers and build tracking URLs based on the tracking number formats.
|
|
8857
|
+
* Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.
|
|
8858
|
+
* This can result in an invalid tracking URL.
|
|
8859
|
+
* It is highly recommended that you send the tracking company and the tracking URLs.
|
|
8860
|
+
*/
|
|
8861
|
+
numbers?: InputMaybe<Array<Scalars['String']['input']>>;
|
|
8862
|
+
/**
|
|
8863
|
+
* The URL to track the fulfillment.
|
|
8864
|
+
*
|
|
8865
|
+
* The tracking URL is displayed in the merchant's admin on the order page.
|
|
8866
|
+
* The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.
|
|
8867
|
+
* When accounts are enabled, it's also displayed in the customer's order history.
|
|
8868
|
+
*
|
|
8869
|
+
* The URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and
|
|
8870
|
+
* [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.
|
|
8871
|
+
* For example, `"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER"` is a valid URL.
|
|
8872
|
+
* It includes a scheme (`https`) and a host (`myshipping.com`).
|
|
8873
|
+
*/
|
|
8874
|
+
url?: InputMaybe<Scalars['URL']['input']>;
|
|
8875
|
+
/**
|
|
8876
|
+
* The URLs to track the fulfillment, one or many.
|
|
8877
|
+
*
|
|
8878
|
+
* The tracking URLs are displayed in the merchant's admin on the order page.
|
|
8879
|
+
* The tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer.
|
|
8880
|
+
* When accounts are enabled, the tracking URLs are also displayed in the customer's order history.
|
|
8881
|
+
*
|
|
8882
|
+
* If you're not specifying a
|
|
8883
|
+
* [Shopify-known](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)
|
|
8884
|
+
* tracking company name in the `company` field,
|
|
8885
|
+
* then provide tracking URLs for all tracking numbers from the `numbers` field.
|
|
8886
|
+
*
|
|
8887
|
+
* Tracking URLs from the `urls` array field are being matched with the tracking numbers from the `numbers` array
|
|
8888
|
+
* field correspondingly their positions in the arrays.
|
|
8889
|
+
*
|
|
8890
|
+
* Each URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and
|
|
8891
|
+
* [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.
|
|
8892
|
+
* For example, `"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER"` is a valid URL.
|
|
8893
|
+
* It includes a scheme (`https`) and a host (`myshipping.com`).
|
|
8894
|
+
*/
|
|
8895
|
+
urls?: InputMaybe<Array<Scalars['URL']['input']>>;
|
|
8896
|
+
};
|
|
8395
8897
|
/** The App Bridge information for a Shopify Function. */
|
|
8396
8898
|
type FunctionsAppBridge = {
|
|
8397
8899
|
__typename?: 'FunctionsAppBridge';
|
|
@@ -8450,7 +8952,7 @@ type GiftCard = Node & {
|
|
|
8450
8952
|
/** The date and time at which the gift card was created. */
|
|
8451
8953
|
createdAt: Scalars['DateTime']['output'];
|
|
8452
8954
|
/** The customer who will receive the gift card. */
|
|
8453
|
-
customer?: Maybe<Customer>;
|
|
8955
|
+
customer?: Maybe<Customer$1>;
|
|
8454
8956
|
/** The date and time at which the gift card was deactivated. */
|
|
8455
8957
|
deactivatedAt?: Maybe<Scalars['DateTime']['output']>;
|
|
8456
8958
|
/** Whether the gift card is enabled. */
|
|
@@ -8486,7 +8988,7 @@ type GiftCardRecipient = {
|
|
|
8486
8988
|
/** The preferred name of the recipient who will receive the gift card. */
|
|
8487
8989
|
preferredName?: Maybe<Scalars['String']['output']>;
|
|
8488
8990
|
/** The recipient who will receive the gift card. */
|
|
8489
|
-
recipient: Customer;
|
|
8991
|
+
recipient: Customer$1;
|
|
8490
8992
|
/** The scheduled datetime on which the gift card will be sent to the recipient. The gift card will be sent within an hour of the specified datetime. */
|
|
8491
8993
|
sendNotificationAt?: Maybe<Scalars['DateTime']['output']>;
|
|
8492
8994
|
};
|
|
@@ -8727,7 +9229,7 @@ type InventoryItem = LegacyInteroperability & Node & {
|
|
|
8727
9229
|
/** The date and time when the inventory item was updated. */
|
|
8728
9230
|
updatedAt: Scalars['DateTime']['output'];
|
|
8729
9231
|
/** The variant that owns this inventory item. */
|
|
8730
|
-
variant: ProductVariant;
|
|
9232
|
+
variant: ProductVariant$1;
|
|
8731
9233
|
};
|
|
8732
9234
|
/** An auto-generated type for paginating through multiple InventoryItems. */
|
|
8733
9235
|
type InventoryItemConnection = {
|
|
@@ -8747,6 +9249,27 @@ type InventoryItemEdge = {
|
|
|
8747
9249
|
/** The item at the end of InventoryItemEdge. */
|
|
8748
9250
|
node: InventoryItem;
|
|
8749
9251
|
};
|
|
9252
|
+
/** The input fields for an inventory item. */
|
|
9253
|
+
type InventoryItemInput = {
|
|
9254
|
+
/** Unit cost associated with the inventory item, the currency is the shop's default currency. */
|
|
9255
|
+
cost?: InputMaybe<Scalars['Decimal']['input']>;
|
|
9256
|
+
/** The country where the item was manufactured or produced, specified using the standard two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
|
|
9257
|
+
countryCodeOfOrigin?: InputMaybe<CountryCode>;
|
|
9258
|
+
/** List of country-specific harmonized system codes. */
|
|
9259
|
+
countryHarmonizedSystemCodes?: InputMaybe<Array<CountryHarmonizedSystemCodeInput>>;
|
|
9260
|
+
/** The harmonized system code of the inventory item. This must be a number between 6 and 13 digits. */
|
|
9261
|
+
harmonizedSystemCode?: InputMaybe<Scalars['String']['input']>;
|
|
9262
|
+
/** The measurements of an inventory item. */
|
|
9263
|
+
measurement?: InputMaybe<InventoryItemMeasurementInput>;
|
|
9264
|
+
/** The province where the item was manufactured or produced, specified using the standard two-letter [ISO 3166-2 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code. */
|
|
9265
|
+
provinceCodeOfOrigin?: InputMaybe<Scalars['String']['input']>;
|
|
9266
|
+
/** Whether the inventory item needs to be physically shipped to the customer. Items that require shipping are physical products, while digital goods and services typically don't require shipping and can be fulfilled electronically. */
|
|
9267
|
+
requiresShipping?: InputMaybe<Scalars['Boolean']['input']>;
|
|
9268
|
+
/** The SKU (stock keeping unit) of the inventory item. */
|
|
9269
|
+
sku?: InputMaybe<Scalars['String']['input']>;
|
|
9270
|
+
/** Whether the inventory item is tracked. */
|
|
9271
|
+
tracked?: InputMaybe<Scalars['Boolean']['input']>;
|
|
9272
|
+
};
|
|
8750
9273
|
/** 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). */
|
|
8751
9274
|
type InventoryItemMeasurement = Node & {
|
|
8752
9275
|
__typename?: 'InventoryItemMeasurement';
|
|
@@ -8755,6 +9278,11 @@ type InventoryItemMeasurement = Node & {
|
|
|
8755
9278
|
/** The weight of the inventory item. */
|
|
8756
9279
|
weight?: Maybe<Weight>;
|
|
8757
9280
|
};
|
|
9281
|
+
/** The input fields for an inventory item measurement. */
|
|
9282
|
+
type InventoryItemMeasurementInput = {
|
|
9283
|
+
/** The weight of the inventory item. */
|
|
9284
|
+
weight?: InputMaybe<WeightInput>;
|
|
9285
|
+
};
|
|
8758
9286
|
/**
|
|
8759
9287
|
* 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.
|
|
8760
9288
|
*
|
|
@@ -8802,6 +9330,13 @@ type InventoryLevelEdge = {
|
|
|
8802
9330
|
/** The item at the end of InventoryLevelEdge. */
|
|
8803
9331
|
node: InventoryLevel;
|
|
8804
9332
|
};
|
|
9333
|
+
/** The input fields for an inventory level. */
|
|
9334
|
+
type InventoryLevelInput = {
|
|
9335
|
+
/** The available quantity of an inventory item at a location. */
|
|
9336
|
+
availableQuantity: Scalars['Int']['input'];
|
|
9337
|
+
/** The ID of a location associated with the inventory level. */
|
|
9338
|
+
locationId: Scalars['ID']['input'];
|
|
9339
|
+
};
|
|
8805
9340
|
/**
|
|
8806
9341
|
* The `InventoryQuantity` object lets you manage and track inventory quantities for specific [states](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states).
|
|
8807
9342
|
* 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.
|
|
@@ -9060,7 +9595,7 @@ type LineItem = Node & {
|
|
|
9060
9595
|
/** The number of units not yet fulfilled. */
|
|
9061
9596
|
unfulfilledQuantity: Scalars['Int']['output'];
|
|
9062
9597
|
/** The Variant object associated with this line item. */
|
|
9063
|
-
variant?: Maybe<ProductVariant>;
|
|
9598
|
+
variant?: Maybe<ProductVariant$1>;
|
|
9064
9599
|
/** The title of the variant at time of order creation. */
|
|
9065
9600
|
variantTitle?: Maybe<Scalars['String']['output']>;
|
|
9066
9601
|
/** The name of the vendor who made the variant. */
|
|
@@ -10229,6 +10764,13 @@ declare enum MediaErrorCode {
|
|
|
10229
10764
|
/** Video failed validation. */
|
|
10230
10765
|
VideoValidationError = "VIDEO_VALIDATION_ERROR"
|
|
10231
10766
|
}
|
|
10767
|
+
/** Host for a Media Resource. */
|
|
10768
|
+
declare enum MediaHost {
|
|
10769
|
+
/** Host for Vimeo embedded videos. */
|
|
10770
|
+
Vimeo = "VIMEO",
|
|
10771
|
+
/** Host for YouTube embedded videos. */
|
|
10772
|
+
Youtube = "YOUTUBE"
|
|
10773
|
+
}
|
|
10232
10774
|
/**
|
|
10233
10775
|
* The `MediaImage` object represents an image hosted on Shopify's
|
|
10234
10776
|
* [content delivery network (CDN)](https://shopify.dev/docs/storefronts/themes/best-practices/performance/platform#shopify-cdn).
|
|
@@ -10697,6 +11239,20 @@ type MetafieldDefinitionValidation = {
|
|
|
10697
11239
|
/** The validation value. */
|
|
10698
11240
|
value?: Maybe<Scalars['String']['output']>;
|
|
10699
11241
|
};
|
|
11242
|
+
/**
|
|
11243
|
+
* The name and value for a metafield definition validation.
|
|
11244
|
+
*
|
|
11245
|
+
* For example, for a metafield definition of `single_line_text_field` type, you can set a validation with the name `min` and a value of `10`.
|
|
11246
|
+
* This validation will ensure that the value of the metafield is at least 10 characters.
|
|
11247
|
+
*
|
|
11248
|
+
* Refer to the [list of supported validations](https://shopify.dev/apps/build/custom-data/metafields/list-of-validation-options).
|
|
11249
|
+
*/
|
|
11250
|
+
type MetafieldDefinitionValidationInput = {
|
|
11251
|
+
/** The name for the metafield definition validation. */
|
|
11252
|
+
name: Scalars['String']['input'];
|
|
11253
|
+
/** The value for the metafield definition validation. */
|
|
11254
|
+
value: Scalars['String']['input'];
|
|
11255
|
+
};
|
|
10700
11256
|
/** Possible metafield definition validation statuses. */
|
|
10701
11257
|
declare enum MetafieldDefinitionValidationStatus {
|
|
10702
11258
|
/** All of this definition's metafields are valid. */
|
|
@@ -10721,6 +11277,43 @@ declare enum MetafieldGrantAccessLevel {
|
|
|
10721
11277
|
/** Read and write metafield access. */
|
|
10722
11278
|
ReadWrite = "READ_WRITE"
|
|
10723
11279
|
}
|
|
11280
|
+
/**
|
|
11281
|
+
* The input fields to use to create or update a metafield through a mutation on the owning resource.
|
|
11282
|
+
* An alternative way to create or update a metafield is by using the
|
|
11283
|
+
* [metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation.
|
|
11284
|
+
*/
|
|
11285
|
+
type MetafieldInput = {
|
|
11286
|
+
/** The unique ID of the metafield. Using `owner_id`, `namespace`, and `key` is preferred for creating and updating. */
|
|
11287
|
+
id?: InputMaybe<Scalars['ID']['input']>;
|
|
11288
|
+
/**
|
|
11289
|
+
* The unique identifier for a metafield within its namespace.
|
|
11290
|
+
*
|
|
11291
|
+
* Required when creating a metafield, but optional when updating. Used to help identify the metafield when
|
|
11292
|
+
* updating, but can't be updated itself.
|
|
11293
|
+
*
|
|
11294
|
+
* Must be 2-64 characters long and can contain alphanumeric, hyphen, and underscore characters.
|
|
11295
|
+
*/
|
|
11296
|
+
key?: InputMaybe<Scalars['String']['input']>;
|
|
11297
|
+
/**
|
|
11298
|
+
* The container for a group of metafields that the metafield is or will be associated with. Used in tandem with
|
|
11299
|
+
* `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the same `key`.
|
|
11300
|
+
*
|
|
11301
|
+
* Required when creating a metafield, but optional when updating. Used to help identify the metafield when
|
|
11302
|
+
* updating, but can't be updated itself.
|
|
11303
|
+
*
|
|
11304
|
+
* Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.
|
|
11305
|
+
*/
|
|
11306
|
+
namespace?: InputMaybe<Scalars['String']['input']>;
|
|
11307
|
+
/**
|
|
11308
|
+
* The type of data that is stored in the metafield.
|
|
11309
|
+
* Refer to the list of [supported types](https://shopify.dev/apps/metafields/types).
|
|
11310
|
+
*
|
|
11311
|
+
* Required when creating or updating a metafield without a definition.
|
|
11312
|
+
*/
|
|
11313
|
+
type?: InputMaybe<Scalars['String']['input']>;
|
|
11314
|
+
/** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */
|
|
11315
|
+
value?: InputMaybe<Scalars['String']['input']>;
|
|
11316
|
+
};
|
|
10724
11317
|
/** Possible types of a metafield's owner resource. */
|
|
10725
11318
|
declare enum MetafieldOwnerType {
|
|
10726
11319
|
/** The Api Permission metafield owner type. */
|
|
@@ -10778,7 +11371,7 @@ declare enum MetafieldOwnerType {
|
|
|
10778
11371
|
Validation = "VALIDATION"
|
|
10779
11372
|
}
|
|
10780
11373
|
/** The resource referenced by the metafield value. */
|
|
10781
|
-
type MetafieldReference = Collection | Company | Customer | GenericFile | MediaImage | Metaobject | Model3d | Order | Page | Product | ProductVariant | TaxonomyValue | Video;
|
|
11374
|
+
type MetafieldReference = Collection | Company | Customer$1 | GenericFile | MediaImage | Metaobject$1 | Model3d | Order | Page | Product | ProductVariant$1 | TaxonomyValue | Video;
|
|
10782
11375
|
/** An auto-generated type for paginating through multiple MetafieldReferences. */
|
|
10783
11376
|
type MetafieldReferenceConnection = {
|
|
10784
11377
|
__typename?: 'MetafieldReferenceConnection';
|
|
@@ -10798,7 +11391,7 @@ type MetafieldReferenceEdge = {
|
|
|
10798
11391
|
node?: Maybe<MetafieldReference>;
|
|
10799
11392
|
};
|
|
10800
11393
|
/** Types of resources that may use metafields to reference other resources. */
|
|
10801
|
-
type MetafieldReferencer = AppInstallation | Article | Blog | Collection | Company | CompanyLocation | Customer | DeliveryCustomization | DiscountAutomaticNode | DiscountCodeNode | DiscountNode | DraftOrder | FulfillmentOrder | Location | Market | Metaobject | Order | Page | PaymentCustomization | Product | ProductVariant | Shop;
|
|
11394
|
+
type MetafieldReferencer = AppInstallation | Article | Blog | Collection | Company | CompanyLocation | Customer$1 | DeliveryCustomization | DiscountAutomaticNode | DiscountCodeNode | DiscountNode | DraftOrder | FulfillmentOrder$1 | Location | Market | Metaobject$1 | Order | Page | PaymentCustomization | Product | ProductVariant$1 | Shop;
|
|
10802
11395
|
/**
|
|
10803
11396
|
* Defines a relation between two resources via a reference metafield.
|
|
10804
11397
|
* The referencer owns the joining field with a given namespace and key,
|
|
@@ -10864,7 +11457,7 @@ declare enum MetafieldValueType {
|
|
|
10864
11457
|
*
|
|
10865
11458
|
* 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.
|
|
10866
11459
|
*/
|
|
10867
|
-
type Metaobject = Node & {
|
|
11460
|
+
type Metaobject$1 = Node & {
|
|
10868
11461
|
__typename?: 'Metaobject';
|
|
10869
11462
|
/** Metaobject capabilities for this Metaobject. */
|
|
10870
11463
|
capabilities: MetaobjectCapabilityData;
|
|
@@ -10908,6 +11501,13 @@ type MetaobjectAccess = {
|
|
|
10908
11501
|
/** The access permitted on the Storefront API. */
|
|
10909
11502
|
storefront: MetaobjectStorefrontAccess;
|
|
10910
11503
|
};
|
|
11504
|
+
/** The input fields that set access permissions for the definition's metaobjects. */
|
|
11505
|
+
type MetaobjectAccessInput = {
|
|
11506
|
+
/** The access permitted on the Admin API. */
|
|
11507
|
+
admin?: InputMaybe<MetaobjectAdminAccessInput>;
|
|
11508
|
+
/** The access permitted on the Storefront API. */
|
|
11509
|
+
storefront?: InputMaybe<MetaobjectStorefrontAccess>;
|
|
11510
|
+
};
|
|
10911
11511
|
/**
|
|
10912
11512
|
* Metaobject access permissions for the Admin API. When the metaobject is app-owned, the owning app always has
|
|
10913
11513
|
* full access.
|
|
@@ -10924,6 +11524,16 @@ declare enum MetaobjectAdminAccess {
|
|
|
10924
11524
|
/** The merchant and other apps have read and write access. */
|
|
10925
11525
|
PublicReadWrite = "PUBLIC_READ_WRITE"
|
|
10926
11526
|
}
|
|
11527
|
+
/**
|
|
11528
|
+
* Metaobject access permissions for the Admin API. When the metaobject is app-owned, the owning app always has
|
|
11529
|
+
* full access.
|
|
11530
|
+
*/
|
|
11531
|
+
declare enum MetaobjectAdminAccessInput {
|
|
11532
|
+
/** The merchant has read-only access. No other apps have access. */
|
|
11533
|
+
MerchantRead = "MERCHANT_READ",
|
|
11534
|
+
/** The merchant has read and write access. No other apps have access. */
|
|
11535
|
+
MerchantReadWrite = "MERCHANT_READ_WRITE"
|
|
11536
|
+
}
|
|
10927
11537
|
/** Provides the capabilities of a metaobject definition. */
|
|
10928
11538
|
type MetaobjectCapabilities = {
|
|
10929
11539
|
__typename?: 'MetaobjectCapabilities';
|
|
@@ -10964,6 +11574,17 @@ type MetaobjectCapabilitiesTranslatable = {
|
|
|
10964
11574
|
/** Indicates if the capability is enabled. */
|
|
10965
11575
|
enabled: Scalars['Boolean']['output'];
|
|
10966
11576
|
};
|
|
11577
|
+
/** The input fields for creating a metaobject capability. */
|
|
11578
|
+
type MetaobjectCapabilityCreateInput = {
|
|
11579
|
+
/** The input for enabling the Online Store capability. */
|
|
11580
|
+
onlineStore?: InputMaybe<MetaobjectCapabilityOnlineStoreInput>;
|
|
11581
|
+
/** The input for enabling the publishable capability. */
|
|
11582
|
+
publishable?: InputMaybe<MetaobjectCapabilityPublishableInput>;
|
|
11583
|
+
/** The input for enabling the renderable capability. */
|
|
11584
|
+
renderable?: InputMaybe<MetaobjectCapabilityRenderableInput>;
|
|
11585
|
+
/** The input for enabling the translatable capability. */
|
|
11586
|
+
translatable?: InputMaybe<MetaobjectCapabilityTranslatableInput>;
|
|
11587
|
+
};
|
|
10967
11588
|
/** Provides the capabilities of a metaobject. */
|
|
10968
11589
|
type MetaobjectCapabilityData = {
|
|
10969
11590
|
__typename?: 'MetaobjectCapabilityData';
|
|
@@ -10972,18 +11593,35 @@ type MetaobjectCapabilityData = {
|
|
|
10972
11593
|
/** The publishable capability for this metaobject. */
|
|
10973
11594
|
publishable?: Maybe<MetaobjectCapabilityDataPublishable>;
|
|
10974
11595
|
};
|
|
11596
|
+
/** The input fields for metaobject capabilities. */
|
|
11597
|
+
type MetaobjectCapabilityDataInput = {
|
|
11598
|
+
/** Online Store capability input. */
|
|
11599
|
+
onlineStore?: InputMaybe<MetaobjectCapabilityDataOnlineStoreInput>;
|
|
11600
|
+
/** Publishable capability input. */
|
|
11601
|
+
publishable?: InputMaybe<MetaobjectCapabilityDataPublishableInput>;
|
|
11602
|
+
};
|
|
10975
11603
|
/** The Online Store capability for the parent metaobject. */
|
|
10976
11604
|
type MetaobjectCapabilityDataOnlineStore = {
|
|
10977
11605
|
__typename?: 'MetaobjectCapabilityDataOnlineStore';
|
|
10978
11606
|
/** The theme template used when viewing the metaobject in a store. */
|
|
10979
11607
|
templateSuffix?: Maybe<Scalars['String']['output']>;
|
|
10980
11608
|
};
|
|
11609
|
+
/** The input fields for the Online Store capability to control renderability on the Online Store. */
|
|
11610
|
+
type MetaobjectCapabilityDataOnlineStoreInput = {
|
|
11611
|
+
/** The theme template used when viewing the metaobject in a store. */
|
|
11612
|
+
templateSuffix?: InputMaybe<Scalars['String']['input']>;
|
|
11613
|
+
};
|
|
10981
11614
|
/** The publishable capability for the parent metaobject. */
|
|
10982
11615
|
type MetaobjectCapabilityDataPublishable = {
|
|
10983
11616
|
__typename?: 'MetaobjectCapabilityDataPublishable';
|
|
10984
11617
|
/** The visibility status of this metaobject across all channels. */
|
|
10985
11618
|
status: MetaobjectStatus;
|
|
10986
11619
|
};
|
|
11620
|
+
/** The input fields for publishable capability to adjust visibility on channels. */
|
|
11621
|
+
type MetaobjectCapabilityDataPublishableInput = {
|
|
11622
|
+
/** The visibility status of this metaobject across all channels. */
|
|
11623
|
+
status: MetaobjectStatus;
|
|
11624
|
+
};
|
|
10987
11625
|
/** The Online Store capability data for the metaobject definition. */
|
|
10988
11626
|
type MetaobjectCapabilityDefinitionDataOnlineStore = {
|
|
10989
11627
|
__typename?: 'MetaobjectCapabilityDefinitionDataOnlineStore';
|
|
@@ -10992,6 +11630,13 @@ type MetaobjectCapabilityDefinitionDataOnlineStore = {
|
|
|
10992
11630
|
/** The URL handle for accessing pages of this metaobject type in the Online Store. */
|
|
10993
11631
|
urlHandle: Scalars['String']['output'];
|
|
10994
11632
|
};
|
|
11633
|
+
/** The input fields of the Online Store capability. */
|
|
11634
|
+
type MetaobjectCapabilityDefinitionDataOnlineStoreInput = {
|
|
11635
|
+
/** Whether to redirect published metaobjects automatically when the URL handle changes. */
|
|
11636
|
+
createRedirects?: InputMaybe<Scalars['Boolean']['input']>;
|
|
11637
|
+
/** The URL handle for accessing pages of this metaobject type in the Online Store. */
|
|
11638
|
+
urlHandle: Scalars['String']['input'];
|
|
11639
|
+
};
|
|
10995
11640
|
/** The renderable capability data for the metaobject definition. */
|
|
10996
11641
|
type MetaobjectCapabilityDefinitionDataRenderable = {
|
|
10997
11642
|
__typename?: 'MetaobjectCapabilityDefinitionDataRenderable';
|
|
@@ -11000,7 +11645,38 @@ type MetaobjectCapabilityDefinitionDataRenderable = {
|
|
|
11000
11645
|
/** The metaobject field used as an alias for the SEO page title. */
|
|
11001
11646
|
metaTitleKey?: Maybe<Scalars['String']['output']>;
|
|
11002
11647
|
};
|
|
11003
|
-
/**
|
|
11648
|
+
/** The input fields of the renderable capability for SEO aliases. */
|
|
11649
|
+
type MetaobjectCapabilityDefinitionDataRenderableInput = {
|
|
11650
|
+
/** The metaobject field used as an alias for the SEO page description. */
|
|
11651
|
+
metaDescriptionKey?: InputMaybe<Scalars['String']['input']>;
|
|
11652
|
+
/** The metaobject field used as an alias for the SEO page title. */
|
|
11653
|
+
metaTitleKey?: InputMaybe<Scalars['String']['input']>;
|
|
11654
|
+
};
|
|
11655
|
+
/** The input fields for enabling and disabling the Online Store capability. */
|
|
11656
|
+
type MetaobjectCapabilityOnlineStoreInput = {
|
|
11657
|
+
/** The data associated with the Online Store capability. */
|
|
11658
|
+
data?: InputMaybe<MetaobjectCapabilityDefinitionDataOnlineStoreInput>;
|
|
11659
|
+
/** Indicates whether the capability should be enabled or disabled. */
|
|
11660
|
+
enabled: Scalars['Boolean']['input'];
|
|
11661
|
+
};
|
|
11662
|
+
/** The input fields for enabling and disabling the publishable capability. */
|
|
11663
|
+
type MetaobjectCapabilityPublishableInput = {
|
|
11664
|
+
/** Indicates whether the capability should be enabled or disabled. */
|
|
11665
|
+
enabled: Scalars['Boolean']['input'];
|
|
11666
|
+
};
|
|
11667
|
+
/** The input fields for enabling and disabling the renderable capability. */
|
|
11668
|
+
type MetaobjectCapabilityRenderableInput = {
|
|
11669
|
+
/** The data associated with the renderable capability. */
|
|
11670
|
+
data?: InputMaybe<MetaobjectCapabilityDefinitionDataRenderableInput>;
|
|
11671
|
+
/** Indicates whether the capability should be enabled or disabled. */
|
|
11672
|
+
enabled: Scalars['Boolean']['input'];
|
|
11673
|
+
};
|
|
11674
|
+
/** The input fields for enabling and disabling the translatable capability. */
|
|
11675
|
+
type MetaobjectCapabilityTranslatableInput = {
|
|
11676
|
+
/** Indicates whether the capability should be enabled or disabled. */
|
|
11677
|
+
enabled: Scalars['Boolean']['input'];
|
|
11678
|
+
};
|
|
11679
|
+
/** Metaobject Capabilities types which can be enabled. */
|
|
11004
11680
|
declare enum MetaobjectCapabilityType {
|
|
11005
11681
|
/** Allows for a Metaobject to be rendered as an Online Store page. */
|
|
11006
11682
|
OnlineStore = "ONLINE_STORE",
|
|
@@ -11017,7 +11693,7 @@ type MetaobjectConnection = {
|
|
|
11017
11693
|
/** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
|
|
11018
11694
|
edges: Array<MetaobjectEdge>;
|
|
11019
11695
|
/** A list of nodes that are contained in MetaobjectEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
|
|
11020
|
-
nodes: Array<Metaobject>;
|
|
11696
|
+
nodes: Array<Metaobject$1>;
|
|
11021
11697
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
11022
11698
|
pageInfo: PageInfo;
|
|
11023
11699
|
};
|
|
@@ -11057,13 +11733,34 @@ type MetaobjectDefinition = Node & {
|
|
|
11057
11733
|
/** The type of the object definition. Defines the namespace of associated metafields. */
|
|
11058
11734
|
type: Scalars['String']['output'];
|
|
11059
11735
|
};
|
|
11736
|
+
/** The input fields for creating a metaobject definition. */
|
|
11737
|
+
type MetaobjectDefinitionCreateInput = {
|
|
11738
|
+
/** Access configuration for the metaobjects created with this definition. */
|
|
11739
|
+
access?: InputMaybe<MetaobjectAccessInput>;
|
|
11740
|
+
/** The capabilities of the metaobject definition. */
|
|
11741
|
+
capabilities?: InputMaybe<MetaobjectCapabilityCreateInput>;
|
|
11742
|
+
/** An administrative description of the definition. */
|
|
11743
|
+
description?: InputMaybe<Scalars['String']['input']>;
|
|
11744
|
+
/** The key of a field to reference as the display name for metaobjects of this type. */
|
|
11745
|
+
displayNameKey?: InputMaybe<Scalars['String']['input']>;
|
|
11746
|
+
/** A set of field definitions to create on this metaobject definition. */
|
|
11747
|
+
fieldDefinitions: Array<MetaobjectFieldDefinitionCreateInput>;
|
|
11748
|
+
/** A human-readable name for the definition. This can be changed at any time. */
|
|
11749
|
+
name?: InputMaybe<Scalars['String']['input']>;
|
|
11750
|
+
/**
|
|
11751
|
+
* The type of the metaobject definition. This can't be changed.
|
|
11752
|
+
*
|
|
11753
|
+
* Must be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.
|
|
11754
|
+
*/
|
|
11755
|
+
type: Scalars['String']['input'];
|
|
11756
|
+
};
|
|
11060
11757
|
/** An auto-generated type which holds one Metaobject and a cursor during pagination. */
|
|
11061
11758
|
type MetaobjectEdge = {
|
|
11062
11759
|
__typename?: 'MetaobjectEdge';
|
|
11063
11760
|
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
11064
11761
|
cursor: Scalars['String']['output'];
|
|
11065
11762
|
/** The item at the end of MetaobjectEdge. */
|
|
11066
|
-
node: Metaobject;
|
|
11763
|
+
node: Metaobject$1;
|
|
11067
11764
|
};
|
|
11068
11765
|
/** Provides a field definition and the data value assigned to it. */
|
|
11069
11766
|
type MetaobjectField = {
|
|
@@ -11107,6 +11804,39 @@ type MetaobjectFieldDefinition = {
|
|
|
11107
11804
|
*/
|
|
11108
11805
|
validations: Array<MetafieldDefinitionValidation>;
|
|
11109
11806
|
};
|
|
11807
|
+
/** The input fields for creating a metaobject field definition. */
|
|
11808
|
+
type MetaobjectFieldDefinitionCreateInput = {
|
|
11809
|
+
/** An administrative description of the field. */
|
|
11810
|
+
description?: InputMaybe<Scalars['String']['input']>;
|
|
11811
|
+
/**
|
|
11812
|
+
* The key of the new field definition. This can't be changed.
|
|
11813
|
+
*
|
|
11814
|
+
* Must be 2-64 characters long and only contain alphanumeric, hyphen, and underscore characters.
|
|
11815
|
+
*/
|
|
11816
|
+
key: Scalars['String']['input'];
|
|
11817
|
+
/** A human-readable name for the field. This can be changed at any time. */
|
|
11818
|
+
name?: InputMaybe<Scalars['String']['input']>;
|
|
11819
|
+
/** Whether metaobjects require a saved value for the field. */
|
|
11820
|
+
required?: InputMaybe<Scalars['Boolean']['input']>;
|
|
11821
|
+
/** The metafield type applied to values of the field. */
|
|
11822
|
+
type: Scalars['String']['input'];
|
|
11823
|
+
/** Custom validations that apply to values assigned to the field. */
|
|
11824
|
+
validations?: InputMaybe<Array<MetafieldDefinitionValidationInput>>;
|
|
11825
|
+
};
|
|
11826
|
+
/** The input fields for a metaobject field value. */
|
|
11827
|
+
type MetaobjectFieldInput = {
|
|
11828
|
+
/** The key of the field. */
|
|
11829
|
+
key: Scalars['String']['input'];
|
|
11830
|
+
/** The value of the field. */
|
|
11831
|
+
value: Scalars['String']['input'];
|
|
11832
|
+
};
|
|
11833
|
+
/** The input fields for retrieving a metaobject by handle. */
|
|
11834
|
+
type MetaobjectHandleInput = {
|
|
11835
|
+
/** The handle of the metaobject to create or update. */
|
|
11836
|
+
handle: Scalars['String']['input'];
|
|
11837
|
+
/** The type of the metaobject. Must match an existing metaobject definition type. */
|
|
11838
|
+
type: Scalars['String']['input'];
|
|
11839
|
+
};
|
|
11110
11840
|
/** Defines visibility status for metaobjects. */
|
|
11111
11841
|
declare enum MetaobjectStatus {
|
|
11112
11842
|
/** The metaobjects is active for public use. */
|
|
@@ -11129,6 +11859,100 @@ type MetaobjectThumbnail = {
|
|
|
11129
11859
|
/** The hexadecimal color code to be used for respresenting this metaobject. */
|
|
11130
11860
|
hex?: Maybe<Scalars['String']['output']>;
|
|
11131
11861
|
};
|
|
11862
|
+
/** The input fields for upserting a metaobject. */
|
|
11863
|
+
type MetaobjectUpsertInput = {
|
|
11864
|
+
/** Capabilities for the metaobject. */
|
|
11865
|
+
capabilities?: InputMaybe<MetaobjectCapabilityDataInput>;
|
|
11866
|
+
/** Values for fields. These are mapped by key to fields of the metaobject definition. */
|
|
11867
|
+
fields?: InputMaybe<Array<MetaobjectFieldInput>>;
|
|
11868
|
+
/** The handle of the metaobject. */
|
|
11869
|
+
handle?: InputMaybe<Scalars['String']['input']>;
|
|
11870
|
+
};
|
|
11871
|
+
/** Defines errors encountered while managing metaobject resources. */
|
|
11872
|
+
type MetaobjectUserError = DisplayableError & {
|
|
11873
|
+
__typename?: 'MetaobjectUserError';
|
|
11874
|
+
/** The error code. */
|
|
11875
|
+
code?: Maybe<MetaobjectUserErrorCode>;
|
|
11876
|
+
/** The index of the failing list element in an array. */
|
|
11877
|
+
elementIndex?: Maybe<Scalars['Int']['output']>;
|
|
11878
|
+
/** The key of the failing object element. */
|
|
11879
|
+
elementKey?: Maybe<Scalars['String']['output']>;
|
|
11880
|
+
/** The path to the input field that caused the error. */
|
|
11881
|
+
field?: Maybe<Array<Scalars['String']['output']>>;
|
|
11882
|
+
/** The error message. */
|
|
11883
|
+
message: Scalars['String']['output'];
|
|
11884
|
+
};
|
|
11885
|
+
/** Possible error codes that can be returned by `MetaobjectUserError`. */
|
|
11886
|
+
declare enum MetaobjectUserErrorCode {
|
|
11887
|
+
/** Admin access can only be specified on metaobject definitions that have an app-reserved type. */
|
|
11888
|
+
AdminAccessInputNotAllowed = "ADMIN_ACCESS_INPUT_NOT_ALLOWED",
|
|
11889
|
+
/** Definition is managed by app configuration and cannot be modified through the API. */
|
|
11890
|
+
AppConfigManaged = "APP_CONFIG_MANAGED",
|
|
11891
|
+
/** The input value is blank. */
|
|
11892
|
+
Blank = "BLANK",
|
|
11893
|
+
/** The capability you are using is not enabled. */
|
|
11894
|
+
CapabilityNotEnabled = "CAPABILITY_NOT_ENABLED",
|
|
11895
|
+
/** The display name cannot be the same when using the metaobject as a product option. */
|
|
11896
|
+
DisplayNameConflict = "DISPLAY_NAME_CONFLICT",
|
|
11897
|
+
/** Duplicate inputs were provided for this field key. */
|
|
11898
|
+
DuplicateFieldInput = "DUPLICATE_FIELD_INPUT",
|
|
11899
|
+
/** Renderable data input is referencing an invalid field. */
|
|
11900
|
+
FieldTypeInvalid = "FIELD_TYPE_INVALID",
|
|
11901
|
+
/** The targeted object cannot be modified. */
|
|
11902
|
+
Immutable = "IMMUTABLE",
|
|
11903
|
+
/** The input value isn't included in the list. */
|
|
11904
|
+
Inclusion = "INCLUSION",
|
|
11905
|
+
/** The maximum number of input metaobjects has been exceeded. */
|
|
11906
|
+
InputLimitExceeded = "INPUT_LIMIT_EXCEEDED",
|
|
11907
|
+
/** An unexpected error occurred. */
|
|
11908
|
+
InternalError = "INTERNAL_ERROR",
|
|
11909
|
+
/** The input value is invalid. */
|
|
11910
|
+
Invalid = "INVALID",
|
|
11911
|
+
/** The value for the metafield definition option was invalid. */
|
|
11912
|
+
InvalidOption = "INVALID_OPTION",
|
|
11913
|
+
/** The metafield type is invalid. */
|
|
11914
|
+
InvalidType = "INVALID_TYPE",
|
|
11915
|
+
/** The value is invalid for the metafield type or the definition options. */
|
|
11916
|
+
InvalidValue = "INVALID_VALUE",
|
|
11917
|
+
/** The maximum number of metaobjects definitions has been exceeded. */
|
|
11918
|
+
MaxDefinitionsExceeded = "MAX_DEFINITIONS_EXCEEDED",
|
|
11919
|
+
/** The maximum number of metaobjects per shop has been exceeded. */
|
|
11920
|
+
MaxObjectsExceeded = "MAX_OBJECTS_EXCEEDED",
|
|
11921
|
+
/** The input is missing required keys. */
|
|
11922
|
+
MissingRequiredKeys = "MISSING_REQUIRED_KEYS",
|
|
11923
|
+
/** Not authorized. */
|
|
11924
|
+
NotAuthorized = "NOT_AUTHORIZED",
|
|
11925
|
+
/** Missing required fields were found for this object. */
|
|
11926
|
+
ObjectFieldRequired = "OBJECT_FIELD_REQUIRED",
|
|
11927
|
+
/** The specified field key is already in use. */
|
|
11928
|
+
ObjectFieldTaken = "OBJECT_FIELD_TAKEN",
|
|
11929
|
+
/** The input value needs to be blank. */
|
|
11930
|
+
Present = "PRESENT",
|
|
11931
|
+
/** The requested record couldn't be found. */
|
|
11932
|
+
RecordNotFound = "RECORD_NOT_FOUND",
|
|
11933
|
+
/** The action cannot be completed because associated metaobjects are referenced by another resource. */
|
|
11934
|
+
ReferenceExistsError = "REFERENCE_EXISTS_ERROR",
|
|
11935
|
+
/** The provided name is reserved for system use. */
|
|
11936
|
+
ReservedName = "RESERVED_NAME",
|
|
11937
|
+
/** Definition is required by an installed app and cannot be deleted. */
|
|
11938
|
+
StandardMetaobjectDefinitionDependentOnApp = "STANDARD_METAOBJECT_DEFINITION_DEPENDENT_ON_APP",
|
|
11939
|
+
/** The input value is already taken. */
|
|
11940
|
+
Taken = "TAKEN",
|
|
11941
|
+
/** The input value is too long. */
|
|
11942
|
+
TooLong = "TOO_LONG",
|
|
11943
|
+
/** The input value is too short. */
|
|
11944
|
+
TooShort = "TOO_SHORT",
|
|
11945
|
+
/** No field definition found for this key. */
|
|
11946
|
+
UndefinedObjectField = "UNDEFINED_OBJECT_FIELD",
|
|
11947
|
+
/** No metaobject definition found for this type. */
|
|
11948
|
+
UndefinedObjectType = "UNDEFINED_OBJECT_TYPE",
|
|
11949
|
+
/** The Online Store URL handle cannot be blank. */
|
|
11950
|
+
UrlHandleBlank = "URL_HANDLE_BLANK",
|
|
11951
|
+
/** The Online Store URL handle is invalid. */
|
|
11952
|
+
UrlHandleInvalid = "URL_HANDLE_INVALID",
|
|
11953
|
+
/** The Online Store URL handle is already taken. */
|
|
11954
|
+
UrlHandleTaken = "URL_HANDLE_TAKEN"
|
|
11955
|
+
}
|
|
11132
11956
|
/** Represents a Shopify hosted 3D model. */
|
|
11133
11957
|
type Model3d = File & Media & Node & {
|
|
11134
11958
|
__typename?: 'Model3d';
|
|
@@ -11394,7 +12218,7 @@ type Order = CommentEventSubject & HasEvents & HasLocalizationExtensions & HasLo
|
|
|
11394
12218
|
* The customer who placed an order. Returns `null` if an order was created through a checkout without customer authentication, such as a guest checkout.
|
|
11395
12219
|
* Learn more about [customer accounts](https://help.shopify.com/manual/customers/customer-accounts).
|
|
11396
12220
|
*/
|
|
11397
|
-
customer?: Maybe<Customer>;
|
|
12221
|
+
customer?: Maybe<Customer$1>;
|
|
11398
12222
|
/**
|
|
11399
12223
|
* Whether the customer agreed to receive marketing emails at the time of purchase.
|
|
11400
12224
|
* Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns.
|
|
@@ -11480,7 +12304,7 @@ type Order = CommentEventSubject & HasEvents & HasLocalizationExtensions & HasLo
|
|
|
11480
12304
|
*/
|
|
11481
12305
|
fulfillmentOrders: FulfillmentOrderConnection;
|
|
11482
12306
|
/** A list of shipments for the order. Fulfillments represent the physical shipment of products to customers. */
|
|
11483
|
-
fulfillments: Array<Fulfillment>;
|
|
12307
|
+
fulfillments: Array<Fulfillment$1>;
|
|
11484
12308
|
/** The total number of fulfillments for the order, including canceled ones. */
|
|
11485
12309
|
fulfillmentsCount?: Maybe<Count>;
|
|
11486
12310
|
/** Whether the order has been paid in full. This field returns `true` when the total amount received equals or exceeds the order total. */
|
|
@@ -11759,7 +12583,7 @@ type Order = CommentEventSubject & HasEvents & HasLocalizationExtensions & HasLo
|
|
|
11759
12583
|
* A calculated refund suggestion for the order based on specified line items, shipping, and duties.
|
|
11760
12584
|
* Use this to preview refund amounts, taxes, and processing fees before creating an actual refund.
|
|
11761
12585
|
*/
|
|
11762
|
-
suggestedRefund?: Maybe<SuggestedRefund>;
|
|
12586
|
+
suggestedRefund?: Maybe<SuggestedRefund$1>;
|
|
11763
12587
|
/**
|
|
11764
12588
|
* A comma separated list of tags associated with the order. Updating `tags` overwrites
|
|
11765
12589
|
* any existing tags that were previously added to the order. To add new tags without overwriting
|
|
@@ -11938,6 +12762,17 @@ type OrderAdjustmentEdge = {
|
|
|
11938
12762
|
/** The item at the end of OrderAdjustmentEdge. */
|
|
11939
12763
|
node: OrderAdjustment;
|
|
11940
12764
|
};
|
|
12765
|
+
/** Discrepancy reasons for order adjustments. */
|
|
12766
|
+
declare enum OrderAdjustmentInputDiscrepancyReason {
|
|
12767
|
+
/** The discrepancy reason is customer. */
|
|
12768
|
+
Customer = "CUSTOMER",
|
|
12769
|
+
/** The discrepancy reason is damage. */
|
|
12770
|
+
Damage = "DAMAGE",
|
|
12771
|
+
/** The discrepancy reason is not one of the predefined reasons. */
|
|
12772
|
+
Other = "OTHER",
|
|
12773
|
+
/** The discrepancy reason is restocking. */
|
|
12774
|
+
Restock = "RESTOCK"
|
|
12775
|
+
}
|
|
11941
12776
|
/**
|
|
11942
12777
|
* 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.
|
|
11943
12778
|
*
|
|
@@ -12266,7 +13101,9 @@ type OrderTransaction = Node & {
|
|
|
12266
13101
|
processedAt?: Maybe<Scalars['DateTime']['output']>;
|
|
12267
13102
|
/**
|
|
12268
13103
|
* The transaction receipt that the payment gateway attaches to the transaction.
|
|
12269
|
-
*
|
|
13104
|
+
* > **Note:** This field is **gateway-specific** and **not a stable contract**.
|
|
13105
|
+
* > Its structure and contents can vary by payment gateway and may change without notice.
|
|
13106
|
+
* > Apps **shouldn't parse or rely on this field for business logic**; prefer typed fields on `OrderTransaction` and related objects.
|
|
12270
13107
|
*/
|
|
12271
13108
|
receiptJson?: Maybe<Scalars['JSON']['output']>;
|
|
12272
13109
|
/** The settlement currency. */
|
|
@@ -12374,6 +13211,19 @@ declare enum OrderTransactionErrorCode {
|
|
|
12374
13211
|
/** The gateway or merchant configuration doesn't support a feature, such as network tokenization. */
|
|
12375
13212
|
UnsupportedFeature = "UNSUPPORTED_FEATURE"
|
|
12376
13213
|
}
|
|
13214
|
+
/** The input fields for the information needed to create an order transaction. */
|
|
13215
|
+
type OrderTransactionInput = {
|
|
13216
|
+
/** The amount of money for this transaction. */
|
|
13217
|
+
amount: Scalars['Money']['input'];
|
|
13218
|
+
/** The payment gateway to use for this transaction. */
|
|
13219
|
+
gateway: Scalars['String']['input'];
|
|
13220
|
+
/** The kind of transaction. */
|
|
13221
|
+
kind: OrderTransactionKind;
|
|
13222
|
+
/** The ID of the order associated with the transaction. */
|
|
13223
|
+
orderId: Scalars['ID']['input'];
|
|
13224
|
+
/** The ID of the optional parent transaction, for example the authorization of a capture. */
|
|
13225
|
+
parentId?: InputMaybe<Scalars['ID']['input']>;
|
|
13226
|
+
};
|
|
12377
13227
|
/** The different kinds of order transactions. */
|
|
12378
13228
|
declare enum OrderTransactionKind {
|
|
12379
13229
|
/**
|
|
@@ -12764,7 +13614,7 @@ type PriceListPrice = {
|
|
|
12764
13614
|
/** A list of quantity breaks for the product variant. */
|
|
12765
13615
|
quantityPriceBreaks: QuantityPriceBreakConnection;
|
|
12766
13616
|
/** The product variant associated with this price. */
|
|
12767
|
-
variant: ProductVariant;
|
|
13617
|
+
variant: ProductVariant$1;
|
|
12768
13618
|
};
|
|
12769
13619
|
/** An auto-generated type for paginating through multiple PriceListPrices. */
|
|
12770
13620
|
type PriceListPriceConnection = {
|
|
@@ -13041,6 +13891,7 @@ type Product = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishe
|
|
|
13041
13891
|
* Whether the resource is published to the app's
|
|
13042
13892
|
* [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
|
|
13043
13893
|
* For example, the resource might be published to the app's online store channel.
|
|
13894
|
+
* @deprecated Use `publishedOnPublication` instead.
|
|
13044
13895
|
*/
|
|
13045
13896
|
publishedOnCurrentPublication: Scalars['Boolean']['output'];
|
|
13046
13897
|
/**
|
|
@@ -13058,6 +13909,7 @@ type Product = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishe
|
|
|
13058
13909
|
/**
|
|
13059
13910
|
* The resource that's either published or staged to be published to
|
|
13060
13911
|
* the [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
|
|
13912
|
+
* @deprecated Use `resourcePublications` instead.
|
|
13061
13913
|
*/
|
|
13062
13914
|
resourcePublicationOnCurrentPublication?: Maybe<ResourcePublicationV2>;
|
|
13063
13915
|
/**
|
|
@@ -13468,7 +14320,7 @@ type ProductTaxonomyNode = Node & {
|
|
|
13468
14320
|
*
|
|
13469
14321
|
* Learn more about [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components).
|
|
13470
14322
|
*/
|
|
13471
|
-
type ProductVariant = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & LegacyInteroperability & Navigable & Node & {
|
|
14323
|
+
type ProductVariant$1 = HasEvents & HasMetafieldDefinitions & HasMetafields & HasPublishedTranslations & LegacyInteroperability & Navigable & Node & {
|
|
13472
14324
|
__typename?: 'ProductVariant';
|
|
13473
14325
|
/** Whether the product variant is available for sale. */
|
|
13474
14326
|
availableForSale: Scalars['Boolean']['output'];
|
|
@@ -13596,7 +14448,7 @@ type ProductVariantComponent = Node & {
|
|
|
13596
14448
|
/** A globally-unique ID. */
|
|
13597
14449
|
id: Scalars['ID']['output'];
|
|
13598
14450
|
/** The product variant associated with the component. */
|
|
13599
|
-
productVariant: ProductVariant;
|
|
14451
|
+
productVariant: ProductVariant$1;
|
|
13600
14452
|
/** The required quantity of the component. */
|
|
13601
14453
|
quantity: Scalars['Int']['output'];
|
|
13602
14454
|
};
|
|
@@ -13624,7 +14476,7 @@ type ProductVariantConnection = {
|
|
|
13624
14476
|
/** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */
|
|
13625
14477
|
edges: Array<ProductVariantEdge>;
|
|
13626
14478
|
/** A list of nodes that are contained in ProductVariantEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */
|
|
13627
|
-
nodes: Array<ProductVariant>;
|
|
14479
|
+
nodes: Array<ProductVariant$1>;
|
|
13628
14480
|
/** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */
|
|
13629
14481
|
pageInfo: PageInfo;
|
|
13630
14482
|
};
|
|
@@ -13649,7 +14501,7 @@ type ProductVariantEdge = {
|
|
|
13649
14501
|
/** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */
|
|
13650
14502
|
cursor: Scalars['String']['output'];
|
|
13651
14503
|
/** The item at the end of ProductVariantEdge. */
|
|
13652
|
-
node: ProductVariant;
|
|
14504
|
+
node: ProductVariant$1;
|
|
13653
14505
|
};
|
|
13654
14506
|
/** The valid values for the inventory policy of a product variant once it is out of stock. */
|
|
13655
14507
|
declare enum ProductVariantInventoryPolicy {
|
|
@@ -13684,6 +14536,45 @@ type ProductVariantPricePairEdge = {
|
|
|
13684
14536
|
/** The item at the end of ProductVariantPricePairEdge. */
|
|
13685
14537
|
node: ProductVariantPricePair;
|
|
13686
14538
|
};
|
|
14539
|
+
/** The input fields for specifying a product variant to create as part of a variant bulk mutation. */
|
|
14540
|
+
type ProductVariantsBulkInput = {
|
|
14541
|
+
/** The value of the barcode associated with the product variant. */
|
|
14542
|
+
barcode?: InputMaybe<Scalars['String']['input']>;
|
|
14543
|
+
/** The compare-at price of the variant. */
|
|
14544
|
+
compareAtPrice?: InputMaybe<Scalars['Money']['input']>;
|
|
14545
|
+
/** Specifies the product variant to update or delete. */
|
|
14546
|
+
id?: InputMaybe<Scalars['ID']['input']>;
|
|
14547
|
+
/** The inventory item associated with the variant, used for unit cost. */
|
|
14548
|
+
inventoryItem?: InputMaybe<InventoryItemInput>;
|
|
14549
|
+
/** Whether customers are allowed to place an order for the variant when it's out of stock. Defaults to `DENY`. */
|
|
14550
|
+
inventoryPolicy?: InputMaybe<ProductVariantInventoryPolicy>;
|
|
14551
|
+
/**
|
|
14552
|
+
* The inventory quantities at each location where the variant is stocked. The number of elements
|
|
14553
|
+
* in the array of inventory quantities can't exceed the amount specified for the plan.
|
|
14554
|
+
* Supported as input with the `productVariantsBulkCreate` mutation only.
|
|
14555
|
+
*/
|
|
14556
|
+
inventoryQuantities?: InputMaybe<Array<InventoryLevelInput>>;
|
|
14557
|
+
/** The ID of the media that's associated with the variant. */
|
|
14558
|
+
mediaId?: InputMaybe<Scalars['ID']['input']>;
|
|
14559
|
+
/** The URL of the media to associate with the variant. */
|
|
14560
|
+
mediaSrc?: InputMaybe<Array<Scalars['String']['input']>>;
|
|
14561
|
+
/** The additional customizable information about the product variant. */
|
|
14562
|
+
metafields?: InputMaybe<Array<MetafieldInput>>;
|
|
14563
|
+
/** The custom properties that a shop owner uses to define product variants. */
|
|
14564
|
+
optionValues?: InputMaybe<Array<VariantOptionValueInput>>;
|
|
14565
|
+
/** The price of the variant. */
|
|
14566
|
+
price?: InputMaybe<Scalars['Money']['input']>;
|
|
14567
|
+
/**
|
|
14568
|
+
* Whether a product variant requires components. The default value is `false`.
|
|
14569
|
+
* If `true`, then the product variant can only be purchased as a parent bundle with components and it will be
|
|
14570
|
+
* omitted from channels that don't support bundles.
|
|
14571
|
+
*/
|
|
14572
|
+
requiresComponents?: InputMaybe<Scalars['Boolean']['input']>;
|
|
14573
|
+
/** The tax code associated with the variant. */
|
|
14574
|
+
taxCode?: InputMaybe<Scalars['String']['input']>;
|
|
14575
|
+
/** Whether the variant is taxable. */
|
|
14576
|
+
taxable?: InputMaybe<Scalars['Boolean']['input']>;
|
|
14577
|
+
};
|
|
13687
14578
|
/** Error codes for failed variant bulk update mutations. */
|
|
13688
14579
|
type ProductVariantsBulkUpdateUserError = DisplayableError & {
|
|
13689
14580
|
__typename?: 'ProductVariantsBulkUpdateUserError';
|
|
@@ -13859,6 +14750,7 @@ type Publishable = {
|
|
|
13859
14750
|
* Whether the resource is published to the app's
|
|
13860
14751
|
* [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
|
|
13861
14752
|
* For example, the resource might be published to the app's online store channel.
|
|
14753
|
+
* @deprecated Use `publishedOnPublication` instead.
|
|
13862
14754
|
*/
|
|
13863
14755
|
publishedOnCurrentPublication: Scalars['Boolean']['output'];
|
|
13864
14756
|
/**
|
|
@@ -13905,7 +14797,7 @@ type PurchasingCompany = {
|
|
|
13905
14797
|
location: CompanyLocation;
|
|
13906
14798
|
};
|
|
13907
14799
|
/** Represents information about the purchasing entity for the order or draft order. */
|
|
13908
|
-
type PurchasingEntity = Customer | PurchasingCompany;
|
|
14800
|
+
type PurchasingEntity = Customer$1 | PurchasingCompany;
|
|
13909
14801
|
/**
|
|
13910
14802
|
* Quantity price breaks lets you offer different rates that are based on the
|
|
13911
14803
|
* amount of a specific variant being ordered.
|
|
@@ -13921,7 +14813,7 @@ type QuantityPriceBreak = Node & {
|
|
|
13921
14813
|
/** The price list associated with this quantity break. */
|
|
13922
14814
|
priceList: PriceList;
|
|
13923
14815
|
/** The product variant associated with this quantity break. */
|
|
13924
|
-
variant: ProductVariant;
|
|
14816
|
+
variant: ProductVariant$1;
|
|
13925
14817
|
};
|
|
13926
14818
|
/** An auto-generated type for paginating through multiple QuantityPriceBreaks. */
|
|
13927
14819
|
type QuantityPriceBreakConnection = {
|
|
@@ -13967,7 +14859,7 @@ type QuantityRule = {
|
|
|
13967
14859
|
/** Whether the values of the quantity rule were explicitly set. */
|
|
13968
14860
|
originType: QuantityRuleOriginType;
|
|
13969
14861
|
/** The product variant for which the quantity rule is applied. */
|
|
13970
|
-
productVariant: ProductVariant;
|
|
14862
|
+
productVariant: ProductVariant$1;
|
|
13971
14863
|
};
|
|
13972
14864
|
/** An auto-generated type for paginating through multiple QuantityRules. */
|
|
13973
14865
|
type QuantityRuleConnection = {
|
|
@@ -14085,6 +14977,20 @@ type RefundDuty = {
|
|
|
14085
14977
|
/** The duty associated with this refunded duty. */
|
|
14086
14978
|
originalDuty?: Maybe<Duty>;
|
|
14087
14979
|
};
|
|
14980
|
+
/** The input fields required to reimburse duties on a refund. */
|
|
14981
|
+
type RefundDutyInput = {
|
|
14982
|
+
/** The ID of the duty in the refund. */
|
|
14983
|
+
dutyId: Scalars['ID']['input'];
|
|
14984
|
+
/** The type of refund for this duty. */
|
|
14985
|
+
refundType?: InputMaybe<RefundDutyRefundType>;
|
|
14986
|
+
};
|
|
14987
|
+
/** The type of refund to perform for a particular refund duty. */
|
|
14988
|
+
declare enum RefundDutyRefundType {
|
|
14989
|
+
/** The duty is fully refunded. */
|
|
14990
|
+
Full = "FULL",
|
|
14991
|
+
/** The duty is proportionally refunded based on the quantity of the refunded line item. */
|
|
14992
|
+
Proportional = "PROPORTIONAL"
|
|
14993
|
+
}
|
|
14088
14994
|
/** An auto-generated type which holds one Refund and a cursor during pagination. */
|
|
14089
14995
|
type RefundEdge = {
|
|
14090
14996
|
__typename?: 'RefundEdge';
|
|
@@ -14093,6 +14999,27 @@ type RefundEdge = {
|
|
|
14093
14999
|
/** The item at the end of RefundEdge. */
|
|
14094
15000
|
node: Refund;
|
|
14095
15001
|
};
|
|
15002
|
+
/** The input fields to create a refund. */
|
|
15003
|
+
type RefundInput = {
|
|
15004
|
+
/** The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ. */
|
|
15005
|
+
currency?: InputMaybe<CurrencyCode>;
|
|
15006
|
+
/** An optional reason for a discrepancy between calculated and actual refund amounts. */
|
|
15007
|
+
discrepancyReason?: InputMaybe<OrderAdjustmentInputDiscrepancyReason>;
|
|
15008
|
+
/** An optional note that's attached to the refund. */
|
|
15009
|
+
note?: InputMaybe<Scalars['String']['input']>;
|
|
15010
|
+
/** Whether to send a refund notification to the customer. */
|
|
15011
|
+
notify?: InputMaybe<Scalars['Boolean']['input']>;
|
|
15012
|
+
/** The ID of the order that's being refunded. */
|
|
15013
|
+
orderId: Scalars['ID']['input'];
|
|
15014
|
+
/** A list of duties to refund. */
|
|
15015
|
+
refundDuties?: InputMaybe<Array<RefundDutyInput>>;
|
|
15016
|
+
/** A list of line items to refund. */
|
|
15017
|
+
refundLineItems?: InputMaybe<Array<RefundLineItemInput>>;
|
|
15018
|
+
/** The input fields that are required to reimburse shipping costs. */
|
|
15019
|
+
shipping?: InputMaybe<ShippingRefundInput>;
|
|
15020
|
+
/** A list of transactions involved in the refund. */
|
|
15021
|
+
transactions?: InputMaybe<Array<OrderTransactionInput>>;
|
|
15022
|
+
};
|
|
14096
15023
|
/**
|
|
14097
15024
|
* A [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) or [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) being refunded from an order. Each refund line item tracks the quantity, pricing, and restocking details for items returned to the merchant.
|
|
14098
15025
|
*
|
|
@@ -14152,6 +15079,17 @@ type RefundLineItemEdge = {
|
|
|
14152
15079
|
/** The item at the end of RefundLineItemEdge. */
|
|
14153
15080
|
node: RefundLineItem;
|
|
14154
15081
|
};
|
|
15082
|
+
/** The input fields required to reimburse line items on a refund. */
|
|
15083
|
+
type RefundLineItemInput = {
|
|
15084
|
+
/** The ID of the line item in the refund. */
|
|
15085
|
+
lineItemId: Scalars['ID']['input'];
|
|
15086
|
+
/** The intended location for restocking. If the `restockType` is set to `NO_RESTOCK`, then this value is empty. */
|
|
15087
|
+
locationId?: InputMaybe<Scalars['ID']['input']>;
|
|
15088
|
+
/** The quantity of the associated line item to be refunded. */
|
|
15089
|
+
quantity: Scalars['Int']['input'];
|
|
15090
|
+
/** The type of restock for this line item. */
|
|
15091
|
+
restockType?: InputMaybe<RefundLineItemRestockType>;
|
|
15092
|
+
};
|
|
14155
15093
|
/** The type of restock performed for a particular refund line item. */
|
|
14156
15094
|
declare enum RefundLineItemRestockType {
|
|
14157
15095
|
/** The refund line item was canceled. Use this when restocking unfulfilled line items. */
|
|
@@ -14994,6 +15932,20 @@ type Segment = Node & {
|
|
|
14994
15932
|
/** A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers. */
|
|
14995
15933
|
query: Scalars['String']['output'];
|
|
14996
15934
|
};
|
|
15935
|
+
/** The statistics of a given attribute. */
|
|
15936
|
+
type SegmentAttributeStatistics$1 = {
|
|
15937
|
+
__typename?: 'SegmentAttributeStatistics';
|
|
15938
|
+
/** The average of a given attribute. */
|
|
15939
|
+
average: Scalars['Float']['output'];
|
|
15940
|
+
/** The sum of a given attribute. */
|
|
15941
|
+
sum: Scalars['Float']['output'];
|
|
15942
|
+
};
|
|
15943
|
+
/** The statistics of a given segment. */
|
|
15944
|
+
type SegmentStatistics = {
|
|
15945
|
+
__typename?: 'SegmentStatistics';
|
|
15946
|
+
/** The statistics of a given attribute. */
|
|
15947
|
+
attributeStatistics: SegmentAttributeStatistics$1;
|
|
15948
|
+
};
|
|
14997
15949
|
/**
|
|
14998
15950
|
* Properties used by customers to select a product variant.
|
|
14999
15951
|
* Products can have multiple options, like different sizes or colors.
|
|
@@ -15575,6 +16527,13 @@ type ShippingRefund = {
|
|
|
15575
16527
|
/** The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies. */
|
|
15576
16528
|
taxSet: MoneyBag;
|
|
15577
16529
|
};
|
|
16530
|
+
/** The input fields that are required to reimburse shipping costs. */
|
|
16531
|
+
type ShippingRefundInput = {
|
|
16532
|
+
/** The monetary value of the shipping fees to be reimbursed. */
|
|
16533
|
+
amount?: InputMaybe<Scalars['Money']['input']>;
|
|
16534
|
+
/** Whether a full refund is provided. */
|
|
16535
|
+
fullRefund?: InputMaybe<Scalars['Boolean']['input']>;
|
|
16536
|
+
};
|
|
15578
16537
|
/**
|
|
15579
16538
|
* The central configuration and settings hub for a Shopify store. Access business information, operational preferences, feature availability, and store-wide settings that control how the shop operates.
|
|
15580
16539
|
*
|
|
@@ -17299,21 +18258,27 @@ type SubscriptionBillingAttempt = Node & {
|
|
|
17299
18258
|
createdAt: Scalars['DateTime']['output'];
|
|
17300
18259
|
/**
|
|
17301
18260
|
* A code corresponding to a payment error during processing.
|
|
17302
|
-
* @deprecated Use `
|
|
18261
|
+
* @deprecated Use `state` instead.
|
|
17303
18262
|
*/
|
|
17304
18263
|
errorCode?: Maybe<SubscriptionBillingAttemptErrorCode>;
|
|
17305
18264
|
/**
|
|
17306
18265
|
* A message describing a payment error during processing.
|
|
17307
|
-
* @deprecated Use `
|
|
18266
|
+
* @deprecated Use `state` instead.
|
|
17308
18267
|
*/
|
|
17309
18268
|
errorMessage?: Maybe<Scalars['String']['output']>;
|
|
17310
18269
|
/** A globally-unique ID. */
|
|
17311
18270
|
id: Scalars['ID']['output'];
|
|
17312
18271
|
/** A unique key generated by the client to avoid duplicate payments. */
|
|
17313
18272
|
idempotencyKey: Scalars['String']['output'];
|
|
17314
|
-
/**
|
|
18273
|
+
/**
|
|
18274
|
+
* The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
|
|
18275
|
+
* @deprecated Use `state` instead.
|
|
18276
|
+
*/
|
|
17315
18277
|
nextActionUrl?: Maybe<Scalars['URL']['output']>;
|
|
17316
|
-
/**
|
|
18278
|
+
/**
|
|
18279
|
+
* The result of this billing attempt if completed successfully.
|
|
18280
|
+
* @deprecated Use `state` instead.
|
|
18281
|
+
*/
|
|
17317
18282
|
order?: Maybe<Order>;
|
|
17318
18283
|
/**
|
|
17319
18284
|
* The date and time used to calculate fulfillment intervals for a billing attempt that
|
|
@@ -17325,9 +18290,15 @@ type SubscriptionBillingAttempt = Node & {
|
|
|
17325
18290
|
paymentGroupId?: Maybe<Scalars['String']['output']>;
|
|
17326
18291
|
/** The reference shared between payment attempts with similar payment details. */
|
|
17327
18292
|
paymentSessionId?: Maybe<Scalars['String']['output']>;
|
|
17328
|
-
/**
|
|
18293
|
+
/**
|
|
18294
|
+
* Error information from processing the billing attempt.
|
|
18295
|
+
* @deprecated Use `state` instead.
|
|
18296
|
+
*/
|
|
17329
18297
|
processingError?: Maybe<SubscriptionBillingAttemptProcessingError>;
|
|
17330
|
-
/**
|
|
18298
|
+
/**
|
|
18299
|
+
* Whether the billing attempt is still processing.
|
|
18300
|
+
* @deprecated Use `state` instead.
|
|
18301
|
+
*/
|
|
17331
18302
|
ready: Scalars['Boolean']['output'];
|
|
17332
18303
|
/** Whether the billing attempt respects the merchant's inventory policy. */
|
|
17333
18304
|
respectInventoryPolicy: Scalars['Boolean']['output'];
|
|
@@ -17361,7 +18332,7 @@ type SubscriptionBillingAttemptEdge = {
|
|
|
17361
18332
|
declare enum SubscriptionBillingAttemptErrorCode {
|
|
17362
18333
|
/** The amount is too small. */
|
|
17363
18334
|
AmountTooSmall = "AMOUNT_TOO_SMALL",
|
|
17364
|
-
/** There was an error during the authentication. */
|
|
18335
|
+
/** There was an error during the payment authentication. */
|
|
17365
18336
|
AuthenticationError = "AUTHENTICATION_ERROR",
|
|
17366
18337
|
/** Payment method was canceled by buyer. */
|
|
17367
18338
|
BuyerCanceledPaymentMethod = "BUYER_CANCELED_PAYMENT_METHOD",
|
|
@@ -17457,7 +18428,7 @@ type SubscriptionContract = Node & SubscriptionContractBase & {
|
|
|
17457
18428
|
/** A list of the custom attributes to be added to the generated orders. */
|
|
17458
18429
|
customAttributes: Array<Attribute>;
|
|
17459
18430
|
/** The customer to whom the subscription contract belongs. */
|
|
17460
|
-
customer?: Maybe<Customer>;
|
|
18431
|
+
customer?: Maybe<Customer$1>;
|
|
17461
18432
|
/** The customer payment method that's used for the subscription contract. */
|
|
17462
18433
|
customerPaymentMethod?: Maybe<CustomerPaymentMethod>;
|
|
17463
18434
|
/** The delivery method for each billing of the subscription contract. */
|
|
@@ -17514,7 +18485,7 @@ type SubscriptionContractBase = {
|
|
|
17514
18485
|
/** A list of the custom attributes to be added to the generated orders. */
|
|
17515
18486
|
customAttributes: Array<Attribute>;
|
|
17516
18487
|
/** The customer to whom the subscription contract belongs. */
|
|
17517
|
-
customer?: Maybe<Customer>;
|
|
18488
|
+
customer?: Maybe<Customer$1>;
|
|
17518
18489
|
/** The customer payment method that's used for the subscription contract. */
|
|
17519
18490
|
customerPaymentMethod?: Maybe<CustomerPaymentMethod>;
|
|
17520
18491
|
/** The delivery method for each billing of the subscription contract. */
|
|
@@ -17960,7 +18931,7 @@ declare enum SuggestedOrderTransactionKind {
|
|
|
17960
18931
|
*
|
|
17961
18932
|
* 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).
|
|
17962
18933
|
*/
|
|
17963
|
-
type SuggestedRefund = {
|
|
18934
|
+
type SuggestedRefund$1 = {
|
|
17964
18935
|
__typename?: 'SuggestedRefund';
|
|
17965
18936
|
/**
|
|
17966
18937
|
* The total monetary value to be refunded.
|
|
@@ -18432,6 +19403,19 @@ type UserError = DisplayableError & {
|
|
|
18432
19403
|
/** The error message. */
|
|
18433
19404
|
message: Scalars['String']['output'];
|
|
18434
19405
|
};
|
|
19406
|
+
/** The input fields required to create or modify a product variant's option value. */
|
|
19407
|
+
type VariantOptionValueInput = {
|
|
19408
|
+
/** Specifies the product option value by ID. */
|
|
19409
|
+
id?: InputMaybe<Scalars['ID']['input']>;
|
|
19410
|
+
/** Metafield value associated with an option. */
|
|
19411
|
+
linkedMetafieldValue?: InputMaybe<Scalars['String']['input']>;
|
|
19412
|
+
/** Specifies the product option value by name. */
|
|
19413
|
+
name?: InputMaybe<Scalars['String']['input']>;
|
|
19414
|
+
/** Specifies the product option by ID. */
|
|
19415
|
+
optionId?: InputMaybe<Scalars['ID']['input']>;
|
|
19416
|
+
/** Specifies the product option by name. */
|
|
19417
|
+
optionName?: InputMaybe<Scalars['String']['input']>;
|
|
19418
|
+
};
|
|
18435
19419
|
/** Represents a credit card payment instrument. */
|
|
18436
19420
|
type VaultCreditCard = {
|
|
18437
19421
|
__typename?: 'VaultCreditCard';
|
|
@@ -18553,6 +19537,13 @@ type Weight = {
|
|
|
18553
19537
|
/** The weight value using the unit system specified with `unit`. */
|
|
18554
19538
|
value: Scalars['Float']['output'];
|
|
18555
19539
|
};
|
|
19540
|
+
/** The input fields for the weight unit and value inputs. */
|
|
19541
|
+
type WeightInput = {
|
|
19542
|
+
/** Unit of measurement for `value`. */
|
|
19543
|
+
unit: WeightUnit;
|
|
19544
|
+
/** The weight value using the unit system specified with `weight_unit`. */
|
|
19545
|
+
value: Scalars['Float']['input'];
|
|
19546
|
+
};
|
|
18556
19547
|
/** Units of measurement for weight. */
|
|
18557
19548
|
declare enum WeightUnit {
|
|
18558
19549
|
/** Metric system unit of mass. */
|
|
@@ -18565,6 +19556,104 @@ declare enum WeightUnit {
|
|
|
18565
19556
|
Pounds = "POUNDS"
|
|
18566
19557
|
}
|
|
18567
19558
|
|
|
19559
|
+
type CreateRefundLineItem = {
|
|
19560
|
+
lineItemId: number | bigint | string;
|
|
19561
|
+
quantity: number;
|
|
19562
|
+
restockType?: 'NO_RESTOCK' | 'CANCEL' | 'RETURN';
|
|
19563
|
+
locationId?: number | bigint | string;
|
|
19564
|
+
};
|
|
19565
|
+
type CreateRefundTransaction = {
|
|
19566
|
+
amount: string;
|
|
19567
|
+
gateway: string;
|
|
19568
|
+
parentId?: number | bigint | string;
|
|
19569
|
+
};
|
|
19570
|
+
type CreateRefundOptions = {
|
|
19571
|
+
currency?: CurrencyCode;
|
|
19572
|
+
note?: string;
|
|
19573
|
+
notify?: boolean;
|
|
19574
|
+
refundLineItems?: CreateRefundLineItem[];
|
|
19575
|
+
shipping?: {
|
|
19576
|
+
fullRefund?: boolean;
|
|
19577
|
+
amount?: string;
|
|
19578
|
+
};
|
|
19579
|
+
transactions?: CreateRefundTransaction[];
|
|
19580
|
+
};
|
|
19581
|
+
type RefundMoney = {
|
|
19582
|
+
amount: string;
|
|
19583
|
+
currencyCode: string;
|
|
19584
|
+
};
|
|
19585
|
+
type CreateRefundResult = {
|
|
19586
|
+
id: string;
|
|
19587
|
+
totalRefunded: {
|
|
19588
|
+
shopMoney: RefundMoney;
|
|
19589
|
+
presentmentMoney: RefundMoney;
|
|
19590
|
+
};
|
|
19591
|
+
};
|
|
19592
|
+
/**
|
|
19593
|
+
* Creates a refund for an order.
|
|
19594
|
+
*
|
|
19595
|
+
* @param orderId - The order ID (numeric, bigint, or GID string)
|
|
19596
|
+
* @param options - Refund configuration options
|
|
19597
|
+
* @returns Promise resolving to the created refund
|
|
19598
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
19599
|
+
* @throws {Error} When GraphQL errors occur
|
|
19600
|
+
*
|
|
19601
|
+
* @example
|
|
19602
|
+
* await createRefund(12345678901234, {
|
|
19603
|
+
* currency: 'EUR',
|
|
19604
|
+
* notify: true,
|
|
19605
|
+
* note: 'Customer return',
|
|
19606
|
+
* refundLineItems: [
|
|
19607
|
+
* { lineItemId: 111, quantity: 1, restockType: 'NO_RESTOCK' }
|
|
19608
|
+
* ],
|
|
19609
|
+
* transactions: [
|
|
19610
|
+
* { amount: '25.00', gateway: 'shopify_payments', parentId: 222 }
|
|
19611
|
+
* ]
|
|
19612
|
+
* })
|
|
19613
|
+
*/
|
|
19614
|
+
declare function createRefund(orderId: number | bigint | string, options?: CreateRefundOptions): Promise<CreateRefundResult>;
|
|
19615
|
+
|
|
19616
|
+
type VariantUpdateInput = Omit<ProductVariantsBulkInput, 'id'> & {
|
|
19617
|
+
id: string;
|
|
19618
|
+
};
|
|
19619
|
+
type BulkUpdateProductVariantsResult = {
|
|
19620
|
+
id: string;
|
|
19621
|
+
sku: string | null;
|
|
19622
|
+
};
|
|
19623
|
+
/**
|
|
19624
|
+
* Bulk updates product variants.
|
|
19625
|
+
*
|
|
19626
|
+
* @param productId - The product GID
|
|
19627
|
+
* @param variants - Array of variant updates (id required, plus fields to update)
|
|
19628
|
+
* @returns Array of updated variants with id and sku
|
|
19629
|
+
* @throws {ShopifyUserError} When the mutation fails
|
|
19630
|
+
*/
|
|
19631
|
+
declare function bulkUpdateProductVariants(productId: string, variants: VariantUpdateInput[]): Promise<BulkUpdateProductVariantsResult[]>;
|
|
19632
|
+
|
|
19633
|
+
type UpsertMetaobjectInput = {
|
|
19634
|
+
type: string;
|
|
19635
|
+
handle: string;
|
|
19636
|
+
fields: MetaobjectFieldInput[];
|
|
19637
|
+
};
|
|
19638
|
+
type UpsertMetaobjectResult = {
|
|
19639
|
+
id: string;
|
|
19640
|
+
handle: string;
|
|
19641
|
+
displayName: string;
|
|
19642
|
+
fields: Array<{
|
|
19643
|
+
key: string;
|
|
19644
|
+
value: string | null;
|
|
19645
|
+
}>;
|
|
19646
|
+
};
|
|
19647
|
+
/**
|
|
19648
|
+
* Creates or updates a metaobject in Shopify based on its type and handle.
|
|
19649
|
+
*
|
|
19650
|
+
* @param input - The metaobject type, handle, and fields
|
|
19651
|
+
* @returns The created/updated metaobject
|
|
19652
|
+
* @throws {ShopifyUserError} When the upsert fails due to validation errors
|
|
19653
|
+
* @throws {Error} When GraphQL errors occur or no metaobject is returned
|
|
19654
|
+
*/
|
|
19655
|
+
declare function upsertMetaobject(input: UpsertMetaobjectInput): Promise<UpsertMetaobjectResult>;
|
|
19656
|
+
|
|
18568
19657
|
type CustomerDeleteMutationVariables = Exact<{
|
|
18569
19658
|
input: CustomerDeleteInput;
|
|
18570
19659
|
}>;
|
|
@@ -18573,6 +19662,69 @@ type CustomerDeleteMutation = {
|
|
|
18573
19662
|
userErrors: Array<Pick<UserError, 'field' | 'message'>>;
|
|
18574
19663
|
})>;
|
|
18575
19664
|
};
|
|
19665
|
+
type CreateFileMutationVariables = Exact<{
|
|
19666
|
+
files: Array<FileCreateInput> | FileCreateInput;
|
|
19667
|
+
}>;
|
|
19668
|
+
type CreateFileMutation = {
|
|
19669
|
+
fileCreate?: Maybe<{
|
|
19670
|
+
files?: Maybe<Array<Pick<ExternalVideo, 'id'> | Pick<GenericFile, 'id'> | Pick<MediaImage, 'id'> | Pick<Model3d, 'id'> | Pick<Video, 'id'>>>;
|
|
19671
|
+
userErrors: Array<Pick<FilesUserError, 'code' | 'field' | 'message'>>;
|
|
19672
|
+
}>;
|
|
19673
|
+
};
|
|
19674
|
+
type FileDeleteMutationVariables = Exact<{
|
|
19675
|
+
fileIds: Array<Scalars['ID']['input']> | Scalars['ID']['input'];
|
|
19676
|
+
}>;
|
|
19677
|
+
type FileDeleteMutation = {
|
|
19678
|
+
fileDelete?: Maybe<(Pick<FileDeletePayload, 'deletedFileIds'> & {
|
|
19679
|
+
userErrors: Array<Pick<FilesUserError, 'code' | 'field' | 'message'>>;
|
|
19680
|
+
})>;
|
|
19681
|
+
};
|
|
19682
|
+
type CreateFulfillmentMutationVariables = Exact<{
|
|
19683
|
+
fulfillment: FulfillmentInput;
|
|
19684
|
+
}>;
|
|
19685
|
+
type CreateFulfillmentMutation = {
|
|
19686
|
+
fulfillmentCreate?: Maybe<{
|
|
19687
|
+
fulfillment?: Maybe<(Pick<Fulfillment$1, 'id' | 'status'> & {
|
|
19688
|
+
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'company' | 'number'>>;
|
|
19689
|
+
})>;
|
|
19690
|
+
userErrors: Array<Pick<UserError, 'field' | 'message'>>;
|
|
19691
|
+
}>;
|
|
19692
|
+
};
|
|
19693
|
+
type UpdateFulfillmentTrackingMutationVariables = Exact<{
|
|
19694
|
+
fulfillmentId: Scalars['ID']['input'];
|
|
19695
|
+
trackingNumbers: Array<Scalars['String']['input']> | Scalars['String']['input'];
|
|
19696
|
+
company?: InputMaybe<Scalars['String']['input']>;
|
|
19697
|
+
notifyCustomer?: InputMaybe<Scalars['Boolean']['input']>;
|
|
19698
|
+
}>;
|
|
19699
|
+
type UpdateFulfillmentTrackingMutation = {
|
|
19700
|
+
fulfillmentTrackingInfoUpdate?: Maybe<{
|
|
19701
|
+
fulfillment?: Maybe<{
|
|
19702
|
+
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'number' | 'company'>>;
|
|
19703
|
+
}>;
|
|
19704
|
+
userErrors: Array<Pick<UserError, 'field' | 'message'>>;
|
|
19705
|
+
}>;
|
|
19706
|
+
};
|
|
19707
|
+
type CreateMetaobjectDefinitionMutationVariables = Exact<{
|
|
19708
|
+
definition: MetaobjectDefinitionCreateInput;
|
|
19709
|
+
}>;
|
|
19710
|
+
type CreateMetaobjectDefinitionMutation = {
|
|
19711
|
+
metaobjectDefinitionCreate?: Maybe<{
|
|
19712
|
+
metaobjectDefinition?: Maybe<Pick<MetaobjectDefinition, 'id' | 'name' | 'type'>>;
|
|
19713
|
+
userErrors: Array<Pick<MetaobjectUserError, 'code' | 'field' | 'message'>>;
|
|
19714
|
+
}>;
|
|
19715
|
+
};
|
|
19716
|
+
type UpsertMetaobjectMutationVariables = Exact<{
|
|
19717
|
+
handle: MetaobjectHandleInput;
|
|
19718
|
+
metaobject: MetaobjectUpsertInput;
|
|
19719
|
+
}>;
|
|
19720
|
+
type UpsertMetaobjectMutation = {
|
|
19721
|
+
metaobjectUpsert?: Maybe<{
|
|
19722
|
+
metaobject?: Maybe<(Pick<Metaobject$1, 'id' | 'handle' | 'displayName'> & {
|
|
19723
|
+
fields: Array<Pick<MetaobjectField, 'key' | 'value'>>;
|
|
19724
|
+
})>;
|
|
19725
|
+
userErrors: Array<Pick<MetaobjectUserError, 'code' | 'field' | 'message'>>;
|
|
19726
|
+
}>;
|
|
19727
|
+
};
|
|
18576
19728
|
type OrderCancelMutationVariables = Exact<{
|
|
18577
19729
|
orderId: Scalars['ID']['input'];
|
|
18578
19730
|
}>;
|
|
@@ -18581,6 +19733,16 @@ type OrderCancelMutation = {
|
|
|
18581
19733
|
orderCancelUserErrors: Array<Pick<OrderCancelUserError, 'code' | 'field' | 'message'>>;
|
|
18582
19734
|
}>;
|
|
18583
19735
|
};
|
|
19736
|
+
type BulkUpdateProductVariantsMutationVariables = Exact<{
|
|
19737
|
+
productId: Scalars['ID']['input'];
|
|
19738
|
+
variants: Array<ProductVariantsBulkInput> | ProductVariantsBulkInput;
|
|
19739
|
+
}>;
|
|
19740
|
+
type BulkUpdateProductVariantsMutation = {
|
|
19741
|
+
productVariantsBulkUpdate?: Maybe<{
|
|
19742
|
+
productVariants?: Maybe<Array<Pick<ProductVariant$1, 'id' | 'sku'>>>;
|
|
19743
|
+
userErrors: Array<Pick<ProductVariantsBulkUpdateUserError, 'code' | 'field' | 'message'>>;
|
|
19744
|
+
}>;
|
|
19745
|
+
};
|
|
18584
19746
|
type ConnectMetaObjectToProductVariantMutationVariables = Exact<{
|
|
18585
19747
|
productId: Scalars['ID']['input'];
|
|
18586
19748
|
variantId: Scalars['ID']['input'];
|
|
@@ -18589,10 +19751,176 @@ type ConnectMetaObjectToProductVariantMutationVariables = Exact<{
|
|
|
18589
19751
|
}>;
|
|
18590
19752
|
type ConnectMetaObjectToProductVariantMutation = {
|
|
18591
19753
|
productVariantsBulkUpdate?: Maybe<{
|
|
18592
|
-
productVariants?: Maybe<Array<Pick<ProductVariant, 'id'>>>;
|
|
19754
|
+
productVariants?: Maybe<Array<Pick<ProductVariant$1, 'id'>>>;
|
|
18593
19755
|
userErrors: Array<Pick<ProductVariantsBulkUpdateUserError, 'field' | 'message'>>;
|
|
18594
19756
|
}>;
|
|
18595
19757
|
};
|
|
19758
|
+
type CreateRefundMutationVariables = Exact<{
|
|
19759
|
+
input: RefundInput;
|
|
19760
|
+
}>;
|
|
19761
|
+
type CreateRefundMutation = {
|
|
19762
|
+
refundCreate?: Maybe<{
|
|
19763
|
+
refund?: Maybe<(Pick<Refund, 'id'> & {
|
|
19764
|
+
totalRefundedSet: {
|
|
19765
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19766
|
+
presentmentMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19767
|
+
};
|
|
19768
|
+
})>;
|
|
19769
|
+
userErrors: Array<Pick<UserError, 'field' | 'message'>>;
|
|
19770
|
+
}>;
|
|
19771
|
+
};
|
|
19772
|
+
type CustomerSegmentMembersWithStatisticsQueryVariables = Exact<{
|
|
19773
|
+
query: Scalars['String']['input'];
|
|
19774
|
+
first: Scalars['Int']['input'];
|
|
19775
|
+
statisticsAttributeName: Scalars['String']['input'];
|
|
19776
|
+
}>;
|
|
19777
|
+
type CustomerSegmentMembersWithStatisticsQuery = {
|
|
19778
|
+
customerSegmentMembers: (Pick<CustomerSegmentMemberConnection, 'totalCount'> & {
|
|
19779
|
+
statistics: {
|
|
19780
|
+
attributeStatistics: Pick<SegmentAttributeStatistics$1, 'sum' | 'average'>;
|
|
19781
|
+
};
|
|
19782
|
+
edges: Array<{
|
|
19783
|
+
node: (Pick<CustomerSegmentMember$1, 'id' | 'firstName' | 'lastName' | 'displayName'> & {
|
|
19784
|
+
defaultEmailAddress?: Maybe<Pick<CustomerEmailAddress, 'emailAddress'>>;
|
|
19785
|
+
});
|
|
19786
|
+
}>;
|
|
19787
|
+
pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
|
|
19788
|
+
});
|
|
19789
|
+
};
|
|
19790
|
+
type CustomersByEmailQueryVariables = Exact<{
|
|
19791
|
+
query: Scalars['String']['input'];
|
|
19792
|
+
first: Scalars['Int']['input'];
|
|
19793
|
+
}>;
|
|
19794
|
+
type CustomersByEmailQuery = {
|
|
19795
|
+
customers: {
|
|
19796
|
+
edges: Array<{
|
|
19797
|
+
node: (Pick<Customer$1, 'id' | 'email' | 'firstName' | 'lastName' | 'numberOfOrders'> & {
|
|
19798
|
+
amountSpent: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19799
|
+
defaultAddress?: Maybe<Pick<MailingAddress, 'id' | 'address1' | 'address2' | 'city' | 'province' | 'country' | 'zip' | 'phone'>>;
|
|
19800
|
+
addresses: Array<Pick<MailingAddress, 'id' | 'address1' | 'address2' | 'city' | 'province' | 'country' | 'zip' | 'phone'>>;
|
|
19801
|
+
});
|
|
19802
|
+
}>;
|
|
19803
|
+
};
|
|
19804
|
+
};
|
|
19805
|
+
type FulfillmentOrdersByOrderIdQueryVariables = Exact<{
|
|
19806
|
+
orderId: Scalars['ID']['input'];
|
|
19807
|
+
}>;
|
|
19808
|
+
type FulfillmentOrdersByOrderIdQuery = {
|
|
19809
|
+
order?: Maybe<{
|
|
19810
|
+
fulfillmentOrders: {
|
|
19811
|
+
edges: Array<{
|
|
19812
|
+
node: (Pick<FulfillmentOrder$1, 'id' | 'status'> & {
|
|
19813
|
+
lineItems: {
|
|
19814
|
+
edges: Array<{
|
|
19815
|
+
node: (Pick<FulfillmentOrderLineItem, 'id' | 'remainingQuantity' | 'totalQuantity'> & {
|
|
19816
|
+
lineItem: Pick<LineItem, 'id'>;
|
|
19817
|
+
});
|
|
19818
|
+
}>;
|
|
19819
|
+
};
|
|
19820
|
+
});
|
|
19821
|
+
}>;
|
|
19822
|
+
};
|
|
19823
|
+
}>;
|
|
19824
|
+
};
|
|
19825
|
+
type FulfillmentByIdQueryVariables = Exact<{
|
|
19826
|
+
id: Scalars['ID']['input'];
|
|
19827
|
+
}>;
|
|
19828
|
+
type FulfillmentByIdQuery = {
|
|
19829
|
+
fulfillment?: Maybe<(Pick<Fulfillment$1, 'id' | 'name' | 'createdAt' | 'updatedAt' | 'status' | 'totalQuantity' | 'estimatedDeliveryAt' | 'deliveredAt'> & {
|
|
19830
|
+
location?: Maybe<Pick<Location, 'id' | 'legacyResourceId' | 'name'>>;
|
|
19831
|
+
service?: Maybe<Pick<FulfillmentService, 'handle' | 'serviceName'>>;
|
|
19832
|
+
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'company' | 'number' | 'url'>>;
|
|
19833
|
+
originAddress?: Maybe<Pick<FulfillmentOriginAddress, 'address1' | 'address2' | 'city' | 'countryCode' | 'provinceCode' | 'zip'>>;
|
|
19834
|
+
fulfillmentLineItems: {
|
|
19835
|
+
edges: Array<{
|
|
19836
|
+
node: (Pick<FulfillmentLineItem, 'id' | 'quantity'> & {
|
|
19837
|
+
originalTotalSet: {
|
|
19838
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19839
|
+
};
|
|
19840
|
+
lineItem: (Pick<LineItem, 'id' | 'title' | 'sku'> & {
|
|
19841
|
+
variant?: Maybe<Pick<ProductVariant$1, 'id'>>;
|
|
19842
|
+
});
|
|
19843
|
+
});
|
|
19844
|
+
}>;
|
|
19845
|
+
};
|
|
19846
|
+
})>;
|
|
19847
|
+
};
|
|
19848
|
+
type FulfillmentTrackingIdsQueryVariables = Exact<{
|
|
19849
|
+
id: Scalars['ID']['input'];
|
|
19850
|
+
}>;
|
|
19851
|
+
type FulfillmentTrackingIdsQuery = {
|
|
19852
|
+
fulfillment?: Maybe<(Pick<Fulfillment$1, 'id'> & {
|
|
19853
|
+
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'company' | 'number'>>;
|
|
19854
|
+
})>;
|
|
19855
|
+
};
|
|
19856
|
+
type MetaobjectByHandleQueryVariables = Exact<{
|
|
19857
|
+
handle: MetaobjectHandleInput;
|
|
19858
|
+
}>;
|
|
19859
|
+
type MetaobjectByHandleQuery = {
|
|
19860
|
+
metaobjectByHandle?: Maybe<(Pick<Metaobject$1, 'id' | 'handle' | 'type' | 'displayName' | 'updatedAt'> & {
|
|
19861
|
+
fields: Array<Pick<MetaobjectField, 'key' | 'value' | 'type'>>;
|
|
19862
|
+
})>;
|
|
19863
|
+
};
|
|
19864
|
+
type SuggestedRefundQueryVariables = Exact<{
|
|
19865
|
+
orderId: Scalars['ID']['input'];
|
|
19866
|
+
refundLineItems?: InputMaybe<Array<RefundLineItemInput> | RefundLineItemInput>;
|
|
19867
|
+
refundShipping?: InputMaybe<Scalars['Boolean']['input']>;
|
|
19868
|
+
shippingAmount?: InputMaybe<Scalars['Money']['input']>;
|
|
19869
|
+
suggestFullRefund?: InputMaybe<Scalars['Boolean']['input']>;
|
|
19870
|
+
}>;
|
|
19871
|
+
type SuggestedRefundQuery = {
|
|
19872
|
+
order?: Maybe<(Pick<Order, 'id' | 'name'> & {
|
|
19873
|
+
suggestedRefund?: Maybe<{
|
|
19874
|
+
amountSet: {
|
|
19875
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19876
|
+
};
|
|
19877
|
+
maximumRefundableSet: {
|
|
19878
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19879
|
+
};
|
|
19880
|
+
subtotalSet: {
|
|
19881
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19882
|
+
};
|
|
19883
|
+
totalTaxSet: {
|
|
19884
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19885
|
+
};
|
|
19886
|
+
discountedSubtotalSet: {
|
|
19887
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19888
|
+
};
|
|
19889
|
+
totalCartDiscountAmountSet: {
|
|
19890
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19891
|
+
};
|
|
19892
|
+
shipping: {
|
|
19893
|
+
amountSet: {
|
|
19894
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19895
|
+
};
|
|
19896
|
+
maximumRefundableSet: {
|
|
19897
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19898
|
+
};
|
|
19899
|
+
};
|
|
19900
|
+
refundLineItems: Array<(Pick<RefundLineItem, 'quantity' | 'restockType'> & {
|
|
19901
|
+
lineItem: Pick<LineItem, 'id' | 'sku' | 'title' | 'quantity'>;
|
|
19902
|
+
priceSet: {
|
|
19903
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19904
|
+
};
|
|
19905
|
+
subtotalSet: {
|
|
19906
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19907
|
+
};
|
|
19908
|
+
totalTaxSet: {
|
|
19909
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19910
|
+
};
|
|
19911
|
+
})>;
|
|
19912
|
+
suggestedTransactions: Array<(Pick<SuggestedOrderTransaction, 'gateway' | 'kind'> & {
|
|
19913
|
+
amountSet: {
|
|
19914
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19915
|
+
};
|
|
19916
|
+
maximumRefundableSet?: Maybe<{
|
|
19917
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
19918
|
+
}>;
|
|
19919
|
+
parentTransaction?: Maybe<Pick<OrderTransaction, 'id'>>;
|
|
19920
|
+
})>;
|
|
19921
|
+
}>;
|
|
19922
|
+
})>;
|
|
19923
|
+
};
|
|
18596
19924
|
type OrderByIdQueryVariables = Exact<{
|
|
18597
19925
|
id: Scalars['ID']['input'];
|
|
18598
19926
|
}>;
|
|
@@ -18601,7 +19929,7 @@ type OrderByIdQuery = {
|
|
|
18601
19929
|
totalPriceSet: {
|
|
18602
19930
|
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
18603
19931
|
};
|
|
18604
|
-
customer?: Maybe<(Pick<Customer, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
19932
|
+
customer?: Maybe<(Pick<Customer$1, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
18605
19933
|
defaultEmailAddress?: Maybe<Pick<CustomerEmailAddress, 'emailAddress'>>;
|
|
18606
19934
|
})>;
|
|
18607
19935
|
shippingAddress?: Maybe<Pick<MailingAddress, 'firstName' | 'lastName' | 'address1' | 'address2' | 'city' | 'province' | 'country' | 'zip'>>;
|
|
@@ -18615,7 +19943,7 @@ type OrderByIdFullQuery = {
|
|
|
18615
19943
|
totalPriceSet: {
|
|
18616
19944
|
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
18617
19945
|
};
|
|
18618
|
-
customer?: Maybe<Pick<Customer, 'id' | 'firstName' | 'lastName' | 'email' | 'phone'>>;
|
|
19946
|
+
customer?: Maybe<Pick<Customer$1, 'id' | 'firstName' | 'lastName' | 'email' | 'phone'>>;
|
|
18619
19947
|
shippingAddress?: Maybe<Pick<MailingAddress, 'firstName' | 'lastName' | 'address1' | 'address2' | 'city' | 'province' | 'country' | 'zip'>>;
|
|
18620
19948
|
billingAddress?: Maybe<Pick<MailingAddress, 'firstName' | 'lastName' | 'address1' | 'address2' | 'city' | 'province' | 'country' | 'zip'>>;
|
|
18621
19949
|
lineItems: {
|
|
@@ -18629,7 +19957,7 @@ type OrderByIdFullQuery = {
|
|
|
18629
19957
|
});
|
|
18630
19958
|
}>;
|
|
18631
19959
|
};
|
|
18632
|
-
fulfillments: Array<(Pick<Fulfillment, 'id' | 'name' | 'totalQuantity' | 'status' | 'createdAt' | 'estimatedDeliveryAt' | 'deliveredAt'> & {
|
|
19960
|
+
fulfillments: Array<(Pick<Fulfillment$1, 'id' | 'name' | 'totalQuantity' | 'status' | 'createdAt' | 'estimatedDeliveryAt' | 'deliveredAt'> & {
|
|
18633
19961
|
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'company' | 'number' | 'url'>>;
|
|
18634
19962
|
fulfillmentLineItems: {
|
|
18635
19963
|
edges: Array<{
|
|
@@ -18670,7 +19998,7 @@ type OrdersByNameQuery = {
|
|
|
18670
19998
|
totalPriceSet: {
|
|
18671
19999
|
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
18672
20000
|
};
|
|
18673
|
-
customer?: Maybe<(Pick<Customer, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
20001
|
+
customer?: Maybe<(Pick<Customer$1, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
18674
20002
|
defaultEmailAddress?: Maybe<Pick<CustomerEmailAddress, 'emailAddress'>>;
|
|
18675
20003
|
})>;
|
|
18676
20004
|
});
|
|
@@ -18726,11 +20054,11 @@ type OrdersByNameFullQuery = {
|
|
|
18726
20054
|
presentmentMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
18727
20055
|
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
18728
20056
|
};
|
|
18729
|
-
customer?: Maybe<(Pick<Customer, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
20057
|
+
customer?: Maybe<(Pick<Customer$1, 'id' | 'lastName' | 'displayName' | 'firstName'> & {
|
|
18730
20058
|
defaultEmailAddress?: Maybe<Pick<CustomerEmailAddress, 'emailAddress'>>;
|
|
18731
20059
|
})>;
|
|
18732
20060
|
displayAddress?: Maybe<Pick<MailingAddress, 'address1' | 'address2' | 'city' | 'company' | 'country' | 'countryCodeV2' | 'firstName' | 'formattedArea' | 'id' | 'lastName' | 'name' | 'phone' | 'province' | 'provinceCode' | 'timeZone' | 'zip'>>;
|
|
18733
|
-
fulfillments: Array<(Pick<Fulfillment, 'createdAt' | 'deliveredAt' | 'displayStatus' | 'estimatedDeliveryAt' | 'updatedAt' | 'totalQuantity' | 'status' | 'name' | 'id'> & {
|
|
20061
|
+
fulfillments: Array<(Pick<Fulfillment$1, 'createdAt' | 'deliveredAt' | 'displayStatus' | 'estimatedDeliveryAt' | 'updatedAt' | 'totalQuantity' | 'status' | 'name' | 'id'> & {
|
|
18734
20062
|
trackingInfo: Array<Pick<FulfillmentTrackingInfo, 'company' | 'url'>>;
|
|
18735
20063
|
})>;
|
|
18736
20064
|
lineItems: {
|
|
@@ -18769,6 +20097,17 @@ type OrdersByNameFullQuery = {
|
|
|
18769
20097
|
pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
|
|
18770
20098
|
};
|
|
18771
20099
|
};
|
|
20100
|
+
type OrderCancellationInfoByNameQueryVariables = Exact<{
|
|
20101
|
+
first: Scalars['Int']['input'];
|
|
20102
|
+
queryFilter: Scalars['String']['input'];
|
|
20103
|
+
}>;
|
|
20104
|
+
type OrderCancellationInfoByNameQuery = {
|
|
20105
|
+
orders: {
|
|
20106
|
+
edges: Array<{
|
|
20107
|
+
node: Pick<Order, 'id' | 'name' | 'cancelledAt'>;
|
|
20108
|
+
}>;
|
|
20109
|
+
};
|
|
20110
|
+
};
|
|
18772
20111
|
type OrderPaymentDetailsByIdQueryVariables = Exact<{
|
|
18773
20112
|
id: Scalars['ID']['input'];
|
|
18774
20113
|
}>;
|
|
@@ -18781,6 +20120,46 @@ type OrderPaymentDetailsByIdQuery = {
|
|
|
18781
20120
|
})>;
|
|
18782
20121
|
}>;
|
|
18783
20122
|
};
|
|
20123
|
+
type OrdersByCustomerIdQueryVariables = Exact<{
|
|
20124
|
+
customerId: Scalars['ID']['input'];
|
|
20125
|
+
first: Scalars['Int']['input'];
|
|
20126
|
+
}>;
|
|
20127
|
+
type OrdersByCustomerIdQuery = {
|
|
20128
|
+
customer?: Maybe<(Pick<Customer$1, 'id'> & {
|
|
20129
|
+
orders: {
|
|
20130
|
+
edges: Array<{
|
|
20131
|
+
node: (Pick<Order, 'id' | 'name' | 'createdAt' | 'cancelledAt' | 'cancelReason' | 'displayFulfillmentStatus'> & {
|
|
20132
|
+
totalPriceSet: {
|
|
20133
|
+
shopMoney: Pick<MoneyV2, 'amount' | 'currencyCode'>;
|
|
20134
|
+
};
|
|
20135
|
+
lineItems: {
|
|
20136
|
+
edges: Array<{
|
|
20137
|
+
node: (Pick<LineItem, 'sku' | 'title'> & {
|
|
20138
|
+
image?: Maybe<Pick<Image, 'url' | 'width' | 'height' | 'altText'>>;
|
|
20139
|
+
});
|
|
20140
|
+
}>;
|
|
20141
|
+
};
|
|
20142
|
+
});
|
|
20143
|
+
}>;
|
|
20144
|
+
};
|
|
20145
|
+
})>;
|
|
20146
|
+
};
|
|
20147
|
+
type AllProductVariantsQueryVariables = Exact<{
|
|
20148
|
+
first: Scalars['Int']['input'];
|
|
20149
|
+
after?: InputMaybe<Scalars['String']['input']>;
|
|
20150
|
+
}>;
|
|
20151
|
+
type AllProductVariantsQuery = {
|
|
20152
|
+
productVariants: {
|
|
20153
|
+
edges: Array<{
|
|
20154
|
+
node: (Pick<ProductVariant$1, 'id' | 'legacyResourceId' | 'sku' | 'barcode' | 'inventoryQuantity' | 'price' | 'title'> & {
|
|
20155
|
+
product: (Pick<Product, 'status' | 'title' | 'description' | 'handle' | 'onlineStoreUrl'> & {
|
|
20156
|
+
featuredImage?: Maybe<Pick<Image, 'url'>>;
|
|
20157
|
+
});
|
|
20158
|
+
});
|
|
20159
|
+
}>;
|
|
20160
|
+
pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
|
|
20161
|
+
};
|
|
20162
|
+
};
|
|
18784
20163
|
type LeanProductVariantsQueryVariables = Exact<{
|
|
18785
20164
|
first: Scalars['Int']['input'];
|
|
18786
20165
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -18789,13 +20168,28 @@ type LeanProductVariantsQueryVariables = Exact<{
|
|
|
18789
20168
|
type LeanProductVariantsQuery = {
|
|
18790
20169
|
productVariants: {
|
|
18791
20170
|
edges: Array<{
|
|
18792
|
-
node: (Pick<ProductVariant, 'id' | 'title' | 'sku'> & {
|
|
20171
|
+
node: (Pick<ProductVariant$1, 'id' | 'title' | 'sku'> & {
|
|
18793
20172
|
product: Pick<Product, 'id' | 'title'>;
|
|
18794
20173
|
});
|
|
18795
20174
|
}>;
|
|
18796
20175
|
pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
|
|
18797
20176
|
};
|
|
18798
20177
|
};
|
|
20178
|
+
type ProductVariantsBySkusQueryVariables = Exact<{
|
|
20179
|
+
first: Scalars['Int']['input'];
|
|
20180
|
+
after?: InputMaybe<Scalars['String']['input']>;
|
|
20181
|
+
queryFilter?: InputMaybe<Scalars['String']['input']>;
|
|
20182
|
+
}>;
|
|
20183
|
+
type ProductVariantsBySkusQuery = {
|
|
20184
|
+
productVariants: {
|
|
20185
|
+
edges: Array<{
|
|
20186
|
+
node: (Pick<ProductVariant$1, 'id' | 'title' | 'sku'> & {
|
|
20187
|
+
product: Pick<Product, 'id' | 'title' | 'status'>;
|
|
20188
|
+
});
|
|
20189
|
+
}>;
|
|
20190
|
+
pageInfo: Pick<PageInfo, 'hasNextPage' | 'endCursor'>;
|
|
20191
|
+
};
|
|
20192
|
+
};
|
|
18799
20193
|
type ProductHandlesQueryVariables = Exact<{
|
|
18800
20194
|
first: Scalars['Int']['input'];
|
|
18801
20195
|
}>;
|
|
@@ -18807,6 +20201,34 @@ type ProductHandlesQuery = {
|
|
|
18807
20201
|
};
|
|
18808
20202
|
};
|
|
18809
20203
|
interface GeneratedQueryTypes {
|
|
20204
|
+
"#graphql\n query customerSegmentMembersWithStatistics($query: String!, $first: Int!, $statisticsAttributeName: String!) {\n customerSegmentMembers(query: $query, first: $first) {\n statistics {\n attributeStatistics(attributeName: $statisticsAttributeName) {\n sum\n average\n }\n }\n edges {\n node {\n id\n firstName\n lastName\n displayName\n defaultEmailAddress {\n emailAddress\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n totalCount\n }\n }\n": {
|
|
20205
|
+
return: CustomerSegmentMembersWithStatisticsQuery;
|
|
20206
|
+
variables: CustomerSegmentMembersWithStatisticsQueryVariables;
|
|
20207
|
+
};
|
|
20208
|
+
"#graphql\n query customersByEmail($query: String!, $first: Int!) {\n customers(first: $first, query: $query) {\n edges {\n node {\n id\n email\n firstName\n lastName\n numberOfOrders\n amountSpent {\n amount\n currencyCode\n }\n defaultAddress {\n id\n address1\n address2\n city\n province\n country\n zip\n phone\n }\n addresses {\n id\n address1\n address2\n city\n province\n country\n zip\n phone\n }\n }\n }\n }\n }\n": {
|
|
20209
|
+
return: CustomersByEmailQuery;
|
|
20210
|
+
variables: CustomersByEmailQueryVariables;
|
|
20211
|
+
};
|
|
20212
|
+
"#graphql\n query fulfillmentOrdersByOrderId($orderId: ID!) {\n order(id: $orderId) {\n fulfillmentOrders(first: 50) {\n edges {\n node {\n id\n status\n lineItems(first: 100) {\n edges {\n node {\n id\n remainingQuantity\n totalQuantity\n lineItem {\n id\n }\n }\n }\n }\n }\n }\n }\n }\n }\n": {
|
|
20213
|
+
return: FulfillmentOrdersByOrderIdQuery;
|
|
20214
|
+
variables: FulfillmentOrdersByOrderIdQueryVariables;
|
|
20215
|
+
};
|
|
20216
|
+
"#graphql\n query fulfillmentById($id: ID!) {\n fulfillment(id: $id) {\n id\n name\n createdAt\n updatedAt\n status\n totalQuantity\n estimatedDeliveryAt\n deliveredAt\n location {\n id\n legacyResourceId\n name\n }\n service {\n handle\n serviceName\n }\n trackingInfo(first: 10) {\n company\n number\n url\n }\n originAddress {\n address1\n address2\n city\n countryCode\n provinceCode\n zip\n }\n fulfillmentLineItems(first: 100) {\n edges {\n node {\n id\n quantity\n originalTotalSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n lineItem {\n id\n title\n sku\n variant {\n id\n }\n }\n }\n }\n }\n }\n }\n": {
|
|
20217
|
+
return: FulfillmentByIdQuery;
|
|
20218
|
+
variables: FulfillmentByIdQueryVariables;
|
|
20219
|
+
};
|
|
20220
|
+
"#graphql\n query fulfillmentTrackingIds($id: ID!) {\n fulfillment(id: $id) {\n id\n trackingInfo(first: 50) {\n company\n number\n }\n }\n }\n": {
|
|
20221
|
+
return: FulfillmentTrackingIdsQuery;
|
|
20222
|
+
variables: FulfillmentTrackingIdsQueryVariables;
|
|
20223
|
+
};
|
|
20224
|
+
"#graphql\n query metaobjectByHandle($handle: MetaobjectHandleInput!) {\n metaobjectByHandle(handle: $handle) {\n id\n handle\n type\n displayName\n updatedAt\n fields {\n key\n value\n type\n }\n }\n }\n": {
|
|
20225
|
+
return: MetaobjectByHandleQuery;
|
|
20226
|
+
variables: MetaobjectByHandleQueryVariables;
|
|
20227
|
+
};
|
|
20228
|
+
"#graphql\n query suggestedRefund(\n $orderId: ID!\n $refundLineItems: [RefundLineItemInput!]\n $refundShipping: Boolean\n $shippingAmount: Money\n $suggestFullRefund: Boolean\n ) {\n order(id: $orderId) {\n id\n name\n suggestedRefund(\n refundLineItems: $refundLineItems\n refundShipping: $refundShipping\n shippingAmount: $shippingAmount\n suggestFullRefund: $suggestFullRefund\n ) {\n amountSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n maximumRefundableSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n subtotalSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n totalTaxSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n discountedSubtotalSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n totalCartDiscountAmountSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n shipping {\n amountSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n maximumRefundableSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n }\n refundLineItems {\n lineItem {\n id\n sku\n title\n quantity\n }\n quantity\n priceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n subtotalSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n totalTaxSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n restockType\n }\n suggestedTransactions {\n gateway\n kind\n amountSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n maximumRefundableSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n parentTransaction {\n id\n }\n }\n }\n }\n }\n": {
|
|
20229
|
+
return: SuggestedRefundQuery;
|
|
20230
|
+
variables: SuggestedRefundQueryVariables;
|
|
20231
|
+
};
|
|
18810
20232
|
"#graphql\n query orderById($id: ID!) {\n order(id: $id) {\n id\n name\n createdAt\n updatedAt\n cancelledAt\n cancelReason\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 shippingAddress {\n firstName\n lastName\n address1\n address2\n city\n province\n country\n zip\n }\n }\n }\n": {
|
|
18811
20233
|
return: OrderByIdQuery;
|
|
18812
20234
|
variables: OrderByIdQueryVariables;
|
|
@@ -18823,14 +20245,30 @@ interface GeneratedQueryTypes {
|
|
|
18823
20245
|
return: OrdersByNameFullQuery;
|
|
18824
20246
|
variables: OrdersByNameFullQueryVariables;
|
|
18825
20247
|
};
|
|
20248
|
+
"#graphql\n query orderCancellationInfoByName($first: Int!, $queryFilter: String!) {\n orders(first: $first, query: $queryFilter) {\n edges {\n node {\n id\n name\n cancelledAt\n }\n }\n }\n }\n": {
|
|
20249
|
+
return: OrderCancellationInfoByNameQuery;
|
|
20250
|
+
variables: OrderCancellationInfoByNameQueryVariables;
|
|
20251
|
+
};
|
|
18826
20252
|
"#graphql\n query orderPaymentDetailsById($id: ID!) {\n order(id: $id) {\n transactions {\n amountSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n createdAt\n gateway\n formattedGateway\n kind\n paymentId\n }\n }\n }\n": {
|
|
18827
20253
|
return: OrderPaymentDetailsByIdQuery;
|
|
18828
20254
|
variables: OrderPaymentDetailsByIdQueryVariables;
|
|
18829
20255
|
};
|
|
20256
|
+
"#graphql\n query ordersByCustomerId($customerId: ID!, $first: Int!) {\n customer(id: $customerId) {\n id\n orders(first: $first, reverse: true) {\n edges {\n node {\n id\n name\n createdAt\n cancelledAt\n cancelReason\n displayFulfillmentStatus\n totalPriceSet {\n shopMoney {\n amount\n currencyCode\n }\n }\n lineItems(first: 100) {\n edges {\n node {\n sku\n title\n image {\n url\n width\n height\n altText\n }\n }\n }\n }\n }\n }\n }\n }\n }\n": {
|
|
20257
|
+
return: OrdersByCustomerIdQuery;
|
|
20258
|
+
variables: OrdersByCustomerIdQueryVariables;
|
|
20259
|
+
};
|
|
20260
|
+
"#graphql\n query allProductVariants($first: Int!, $after: String) {\n productVariants(first: $first, after: $after) {\n edges {\n node {\n id\n legacyResourceId\n sku\n barcode\n inventoryQuantity\n price\n title\n product {\n status\n title\n description\n handle\n onlineStoreUrl\n featuredImage {\n url\n }\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n": {
|
|
20261
|
+
return: AllProductVariantsQuery;
|
|
20262
|
+
variables: AllProductVariantsQueryVariables;
|
|
20263
|
+
};
|
|
18830
20264
|
"#graphql\n query leanProductVariants($first: Int!, $after: String, $queryFilter: String) {\n productVariants(first: $first, after: $after, query: $queryFilter) {\n edges {\n node { \n id\n title\n sku\n product {\n id\n title\n }\n }\n }\n pageInfo { \n hasNextPage\n endCursor\n }\n }\n }\n ": {
|
|
18831
20265
|
return: LeanProductVariantsQuery;
|
|
18832
20266
|
variables: LeanProductVariantsQueryVariables;
|
|
18833
20267
|
};
|
|
20268
|
+
"#graphql\n query productVariantsBySkus($first: Int!, $after: String, $queryFilter: String) {\n productVariants(first: $first, after: $after, query: $queryFilter) {\n edges {\n node {\n id\n title\n sku\n product {\n id\n title\n status\n }\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n ": {
|
|
20269
|
+
return: ProductVariantsBySkusQuery;
|
|
20270
|
+
variables: ProductVariantsBySkusQueryVariables;
|
|
20271
|
+
};
|
|
18834
20272
|
"#graphql\n query productHandles($first: Int!) {\n products(first: $first) {\n edges {\n node {\n handle\n title\n }\n }\n }\n }": {
|
|
18835
20273
|
return: ProductHandlesQuery;
|
|
18836
20274
|
variables: ProductHandlesQueryVariables;
|
|
@@ -18841,14 +20279,46 @@ interface GeneratedMutationTypes {
|
|
|
18841
20279
|
return: CustomerDeleteMutation;
|
|
18842
20280
|
variables: CustomerDeleteMutationVariables;
|
|
18843
20281
|
};
|
|
20282
|
+
"#graphql\n mutation createFile($files: [FileCreateInput!]!) {\n fileCreate(files: $files) {\n files {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\n": {
|
|
20283
|
+
return: CreateFileMutation;
|
|
20284
|
+
variables: CreateFileMutationVariables;
|
|
20285
|
+
};
|
|
20286
|
+
"#graphql\n mutation fileDelete($fileIds: [ID!]!) {\n fileDelete(fileIds: $fileIds) {\n deletedFileIds\n userErrors {\n code\n field\n message\n }\n }\n }\n ": {
|
|
20287
|
+
return: FileDeleteMutation;
|
|
20288
|
+
variables: FileDeleteMutationVariables;
|
|
20289
|
+
};
|
|
20290
|
+
"#graphql\n mutation createFulfillment($fulfillment: FulfillmentInput!) {\n fulfillmentCreate(fulfillment: $fulfillment) {\n fulfillment {\n id\n status\n trackingInfo {\n company\n number\n }\n }\n userErrors {\n field\n message\n }\n }\n }\n": {
|
|
20291
|
+
return: CreateFulfillmentMutation;
|
|
20292
|
+
variables: CreateFulfillmentMutationVariables;
|
|
20293
|
+
};
|
|
20294
|
+
"#graphql\n mutation updateFulfillmentTracking(\n $fulfillmentId: ID!\n $trackingNumbers: [String!]!\n $company: String\n $notifyCustomer: Boolean\n ) {\n fulfillmentTrackingInfoUpdate(\n fulfillmentId: $fulfillmentId\n trackingInfoInput: { numbers: $trackingNumbers, company: $company }\n notifyCustomer: $notifyCustomer\n ) {\n fulfillment {\n trackingInfo {\n number\n company\n }\n }\n userErrors {\n field\n message\n }\n }\n }\n": {
|
|
20295
|
+
return: UpdateFulfillmentTrackingMutation;
|
|
20296
|
+
variables: UpdateFulfillmentTrackingMutationVariables;
|
|
20297
|
+
};
|
|
20298
|
+
"#graphql\n mutation createMetaobjectDefinition($definition: MetaobjectDefinitionCreateInput!) {\n metaobjectDefinitionCreate(definition: $definition) {\n metaobjectDefinition {\n id\n name\n type\n }\n userErrors {\n code\n field\n message\n }\n }\n }\n": {
|
|
20299
|
+
return: CreateMetaobjectDefinitionMutation;
|
|
20300
|
+
variables: CreateMetaobjectDefinitionMutationVariables;
|
|
20301
|
+
};
|
|
20302
|
+
"#graphql\n mutation upsertMetaobject(\n $handle: MetaobjectHandleInput!\n $metaobject: MetaobjectUpsertInput!\n ) {\n metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n metaobject {\n id\n handle\n displayName\n fields {\n key\n value\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }\n": {
|
|
20303
|
+
return: UpsertMetaobjectMutation;
|
|
20304
|
+
variables: UpsertMetaobjectMutationVariables;
|
|
20305
|
+
};
|
|
18844
20306
|
"#graphql\n mutation orderCancel($orderId: ID!) {\n orderCancel(\n orderId: $orderId\n refund: true\n restock: false\n reason: CUSTOMER\n notifyCustomer: true\n ) {\n orderCancelUserErrors {\n code\n field\n message\n }\n }\n }\n": {
|
|
18845
20307
|
return: OrderCancelMutation;
|
|
18846
20308
|
variables: OrderCancelMutationVariables;
|
|
18847
20309
|
};
|
|
20310
|
+
"#graphql\n mutation bulkUpdateProductVariants(\n $productId: ID!\n $variants: [ProductVariantsBulkInput!]!\n ) {\n productVariantsBulkUpdate(\n productId: $productId\n variants: $variants\n ) {\n productVariants {\n id\n sku\n }\n userErrors {\n code\n field\n message\n }\n }\n }\n": {
|
|
20311
|
+
return: BulkUpdateProductVariantsMutation;
|
|
20312
|
+
variables: BulkUpdateProductVariantsMutationVariables;
|
|
20313
|
+
};
|
|
18848
20314
|
"#graphql\n mutation connectMetaObjectToProductVariant($productId: ID!, $variantId: ID!, $metaObjectId: String!, $metaObjectKey: String!) {\n productVariantsBulkUpdate(\n productId: $productId\n variants: [\n {\n id: $variantId\n metafields: [\n {\n namespace: \"custom\"\n key: $metaObjectKey\n value: $metaObjectId\n type: \"metaobject_reference\"\n }\n ]\n }\n ] \n ) {\n productVariants { \n id\n }\n userErrors {\n field\n message\n }\n }\n }\n ": {
|
|
18849
20315
|
return: ConnectMetaObjectToProductVariantMutation;
|
|
18850
20316
|
variables: ConnectMetaObjectToProductVariantMutationVariables;
|
|
18851
20317
|
};
|
|
20318
|
+
"#graphql\n mutation createRefund($input: RefundInput!) {\n refundCreate(input: $input) {\n refund {\n id\n totalRefundedSet {\n shopMoney {\n amount\n currencyCode\n }\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\n": {
|
|
20319
|
+
return: CreateRefundMutation;
|
|
20320
|
+
variables: CreateRefundMutationVariables;
|
|
20321
|
+
};
|
|
18852
20322
|
}
|
|
18853
20323
|
declare module '@shopify/admin-api-client' {
|
|
18854
20324
|
type InputMaybe<T> = InputMaybe<T>;
|
|
@@ -18858,7 +20328,54 @@ declare module '@shopify/admin-api-client' {
|
|
|
18858
20328
|
}
|
|
18859
20329
|
}
|
|
18860
20330
|
|
|
18861
|
-
|
|
20331
|
+
type SuggestedRefund = NonNullable<NonNullable<SuggestedRefundQuery['order']>['suggestedRefund']>;
|
|
20332
|
+
interface CalculateRefundLineItem {
|
|
20333
|
+
lineItemId: number | bigint | string;
|
|
20334
|
+
quantity: number;
|
|
20335
|
+
restockType?: 'NO_RESTOCK' | 'CANCEL' | 'RETURN';
|
|
20336
|
+
locationId?: string;
|
|
20337
|
+
}
|
|
20338
|
+
interface CalculateRefundOptions {
|
|
20339
|
+
refundLineItems?: CalculateRefundLineItem[];
|
|
20340
|
+
refundShipping?: boolean;
|
|
20341
|
+
shippingAmount?: string;
|
|
20342
|
+
suggestFullRefund?: boolean;
|
|
20343
|
+
}
|
|
20344
|
+
/**
|
|
20345
|
+
* Calculate a suggested refund for an order.
|
|
20346
|
+
* Returns undefined if the order is not found or has no refundable items.
|
|
20347
|
+
*
|
|
20348
|
+
* @param orderId - The order ID (numeric, bigint, or GID string)
|
|
20349
|
+
* @param options - Options for the refund calculation
|
|
20350
|
+
* @returns The suggested refund or undefined
|
|
20351
|
+
*/
|
|
20352
|
+
declare function calculateRefund(orderId: number | bigint | string, options?: CalculateRefundOptions): Promise<SuggestedRefund | undefined>;
|
|
20353
|
+
|
|
20354
|
+
interface ShopifyUserErrorDetail {
|
|
20355
|
+
code?: string | null;
|
|
20356
|
+
field?: string[] | null;
|
|
20357
|
+
message?: string | null;
|
|
20358
|
+
}
|
|
20359
|
+
/**
|
|
20360
|
+
* Custom error class for Shopify mutation userErrors.
|
|
20361
|
+
* Preserves the full error array so callers can inspect specific error codes.
|
|
20362
|
+
*
|
|
20363
|
+
* @example
|
|
20364
|
+
* try {
|
|
20365
|
+
* await cancelOrderById(orderId)
|
|
20366
|
+
* } catch (error) {
|
|
20367
|
+
* if (error instanceof ShopifyUserError) {
|
|
20368
|
+
* const alreadyCancelled = error.errors.some(e => e.code === 'ORDER_ALREADY_CANCELLED')
|
|
20369
|
+
* if (alreadyCancelled) { ... }
|
|
20370
|
+
* }
|
|
20371
|
+
* }
|
|
20372
|
+
*/
|
|
20373
|
+
declare class ShopifyUserError extends Error {
|
|
20374
|
+
readonly errors: ShopifyUserErrorDetail[];
|
|
20375
|
+
constructor(message: string, errors: ShopifyUserErrorDetail[]);
|
|
20376
|
+
}
|
|
20377
|
+
|
|
20378
|
+
declare const GetLeanOrderByIdReturn: z.ZodObject<{
|
|
18862
20379
|
id: z.ZodString;
|
|
18863
20380
|
name: z.ZodString;
|
|
18864
20381
|
createdAt: z.ZodString;
|
|
@@ -18869,11 +20386,11 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18869
20386
|
amount: z.ZodString;
|
|
18870
20387
|
currencyCode: z.ZodString;
|
|
18871
20388
|
}, "strip", z.ZodTypeAny, {
|
|
18872
|
-
currencyCode: string;
|
|
18873
20389
|
amount: string;
|
|
18874
|
-
}, {
|
|
18875
20390
|
currencyCode: string;
|
|
20391
|
+
}, {
|
|
18876
20392
|
amount: string;
|
|
20393
|
+
currencyCode: string;
|
|
18877
20394
|
}>;
|
|
18878
20395
|
customer: z.ZodNullable<z.ZodObject<{
|
|
18879
20396
|
id: z.ZodString;
|
|
@@ -18884,14 +20401,14 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18884
20401
|
}, "strip", z.ZodTypeAny, {
|
|
18885
20402
|
id: string;
|
|
18886
20403
|
displayName: string;
|
|
18887
|
-
lastName: string | null;
|
|
18888
20404
|
firstName: string | null;
|
|
20405
|
+
lastName: string | null;
|
|
18889
20406
|
emailAddress: string | null;
|
|
18890
20407
|
}, {
|
|
18891
20408
|
id: string;
|
|
18892
20409
|
displayName: string;
|
|
18893
|
-
lastName: string | null;
|
|
18894
20410
|
firstName: string | null;
|
|
20411
|
+
lastName: string | null;
|
|
18895
20412
|
emailAddress: string | null;
|
|
18896
20413
|
}>>;
|
|
18897
20414
|
financialStatus: z.ZodNullable<z.ZodString>;
|
|
@@ -18906,8 +20423,8 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18906
20423
|
country: z.ZodNullable<z.ZodString>;
|
|
18907
20424
|
zip: z.ZodNullable<z.ZodString>;
|
|
18908
20425
|
}, "strip", z.ZodTypeAny, {
|
|
18909
|
-
lastName: string | null;
|
|
18910
20426
|
firstName: string | null;
|
|
20427
|
+
lastName: string | null;
|
|
18911
20428
|
address1: string | null;
|
|
18912
20429
|
address2: string | null;
|
|
18913
20430
|
city: string | null;
|
|
@@ -18915,8 +20432,8 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18915
20432
|
country: string | null;
|
|
18916
20433
|
zip: string | null;
|
|
18917
20434
|
}, {
|
|
18918
|
-
lastName: string | null;
|
|
18919
20435
|
firstName: string | null;
|
|
20436
|
+
lastName: string | null;
|
|
18920
20437
|
address1: string | null;
|
|
18921
20438
|
address2: string | null;
|
|
18922
20439
|
city: string | null;
|
|
@@ -18929,18 +20446,19 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18929
20446
|
createdAt: string;
|
|
18930
20447
|
updatedAt: string;
|
|
18931
20448
|
name: string;
|
|
18932
|
-
|
|
20449
|
+
fulfillmentStatus: string | null;
|
|
18933
20450
|
cancelReason: string | null;
|
|
20451
|
+
cancelledAt: string | null;
|
|
18934
20452
|
customer: {
|
|
18935
20453
|
id: string;
|
|
18936
20454
|
displayName: string;
|
|
18937
|
-
lastName: string | null;
|
|
18938
20455
|
firstName: string | null;
|
|
20456
|
+
lastName: string | null;
|
|
18939
20457
|
emailAddress: string | null;
|
|
18940
20458
|
} | null;
|
|
18941
20459
|
shippingAddress: {
|
|
18942
|
-
lastName: string | null;
|
|
18943
20460
|
firstName: string | null;
|
|
20461
|
+
lastName: string | null;
|
|
18944
20462
|
address1: string | null;
|
|
18945
20463
|
address2: string | null;
|
|
18946
20464
|
city: string | null;
|
|
@@ -18949,28 +20467,28 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18949
20467
|
zip: string | null;
|
|
18950
20468
|
} | null;
|
|
18951
20469
|
totalPrice: {
|
|
18952
|
-
currencyCode: string;
|
|
18953
20470
|
amount: string;
|
|
20471
|
+
currencyCode: string;
|
|
18954
20472
|
};
|
|
18955
|
-
fulfillmentStatus: string | null;
|
|
18956
20473
|
financialStatus: string | null;
|
|
18957
20474
|
}, {
|
|
18958
20475
|
id: string;
|
|
18959
20476
|
createdAt: string;
|
|
18960
20477
|
updatedAt: string;
|
|
18961
20478
|
name: string;
|
|
18962
|
-
|
|
20479
|
+
fulfillmentStatus: string | null;
|
|
18963
20480
|
cancelReason: string | null;
|
|
20481
|
+
cancelledAt: string | null;
|
|
18964
20482
|
customer: {
|
|
18965
20483
|
id: string;
|
|
18966
20484
|
displayName: string;
|
|
18967
|
-
lastName: string | null;
|
|
18968
20485
|
firstName: string | null;
|
|
20486
|
+
lastName: string | null;
|
|
18969
20487
|
emailAddress: string | null;
|
|
18970
20488
|
} | null;
|
|
18971
20489
|
shippingAddress: {
|
|
18972
|
-
lastName: string | null;
|
|
18973
20490
|
firstName: string | null;
|
|
20491
|
+
lastName: string | null;
|
|
18974
20492
|
address1: string | null;
|
|
18975
20493
|
address2: string | null;
|
|
18976
20494
|
city: string | null;
|
|
@@ -18979,19 +20497,18 @@ declare const GetLeanOrderByIdReturn: z.ZodNullable<z.ZodObject<{
|
|
|
18979
20497
|
zip: string | null;
|
|
18980
20498
|
} | null;
|
|
18981
20499
|
totalPrice: {
|
|
18982
|
-
currencyCode: string;
|
|
18983
20500
|
amount: string;
|
|
20501
|
+
currencyCode: string;
|
|
18984
20502
|
};
|
|
18985
|
-
fulfillmentStatus: string | null;
|
|
18986
20503
|
financialStatus: string | null;
|
|
18987
|
-
}
|
|
18988
|
-
type LeanOrder = z.infer<typeof GetLeanOrderByIdReturn
|
|
20504
|
+
}>;
|
|
20505
|
+
type LeanOrder = z.infer<typeof GetLeanOrderByIdReturn> | undefined;
|
|
18989
20506
|
type FullOrder = NonNullable<OrderByIdFullQuery['order']>;
|
|
18990
20507
|
declare function getOrderById(id: number | bigint): Promise<LeanOrder>;
|
|
18991
20508
|
declare function getOrderById(id: number | bigint, detailLevel: 'lean'): Promise<LeanOrder>;
|
|
18992
|
-
declare function getOrderById(id: number | bigint, detailLevel: 'full'): Promise<FullOrder |
|
|
20509
|
+
declare function getOrderById(id: number | bigint, detailLevel: 'full'): Promise<FullOrder | undefined>;
|
|
18993
20510
|
|
|
18994
|
-
declare const GetLeanOrderByNameReturn: z.
|
|
20511
|
+
declare const GetLeanOrderByNameReturn: z.ZodObject<{
|
|
18995
20512
|
id: z.ZodString;
|
|
18996
20513
|
name: z.ZodString;
|
|
18997
20514
|
createdAt: z.ZodString;
|
|
@@ -19000,11 +20517,11 @@ declare const GetLeanOrderByNameReturn: z.ZodNullable<z.ZodObject<{
|
|
|
19000
20517
|
amount: z.ZodString;
|
|
19001
20518
|
currencyCode: z.ZodString;
|
|
19002
20519
|
}, "strip", z.ZodTypeAny, {
|
|
19003
|
-
currencyCode: string;
|
|
19004
20520
|
amount: string;
|
|
19005
|
-
}, {
|
|
19006
20521
|
currencyCode: string;
|
|
20522
|
+
}, {
|
|
19007
20523
|
amount: string;
|
|
20524
|
+
currencyCode: string;
|
|
19008
20525
|
}>;
|
|
19009
20526
|
customer: z.ZodNullable<z.ZodObject<{
|
|
19010
20527
|
id: z.ZodString;
|
|
@@ -19026,40 +20543,51 @@ declare const GetLeanOrderByNameReturn: z.ZodNullable<z.ZodObject<{
|
|
|
19026
20543
|
createdAt: string;
|
|
19027
20544
|
updatedAt: string;
|
|
19028
20545
|
name: string;
|
|
20546
|
+
fulfillmentStatus: string | null;
|
|
19029
20547
|
customer: {
|
|
19030
20548
|
id: string;
|
|
19031
20549
|
displayName: string;
|
|
19032
20550
|
emailAddress: string | null;
|
|
19033
20551
|
} | null;
|
|
19034
20552
|
totalPrice: {
|
|
19035
|
-
currencyCode: string;
|
|
19036
20553
|
amount: string;
|
|
20554
|
+
currencyCode: string;
|
|
19037
20555
|
};
|
|
19038
|
-
fulfillmentStatus: string | null;
|
|
19039
20556
|
financialStatus: string | null;
|
|
19040
20557
|
}, {
|
|
19041
20558
|
id: string;
|
|
19042
20559
|
createdAt: string;
|
|
19043
20560
|
updatedAt: string;
|
|
19044
20561
|
name: string;
|
|
20562
|
+
fulfillmentStatus: string | null;
|
|
19045
20563
|
customer: {
|
|
19046
20564
|
id: string;
|
|
19047
20565
|
displayName: string;
|
|
19048
20566
|
emailAddress: string | null;
|
|
19049
20567
|
} | null;
|
|
19050
20568
|
totalPrice: {
|
|
19051
|
-
currencyCode: string;
|
|
19052
20569
|
amount: string;
|
|
20570
|
+
currencyCode: string;
|
|
19053
20571
|
};
|
|
19054
|
-
fulfillmentStatus: string | null;
|
|
19055
20572
|
financialStatus: string | null;
|
|
19056
|
-
}
|
|
19057
|
-
type LeanOrderByName = z.infer<typeof GetLeanOrderByNameReturn
|
|
19058
|
-
type FullOrderByName = NonNullable<NonNullable<OrdersByNameFullQuery['orders']>['edges'][number]['node']> |
|
|
20573
|
+
}>;
|
|
20574
|
+
type LeanOrderByName = z.infer<typeof GetLeanOrderByNameReturn> | undefined;
|
|
20575
|
+
type FullOrderByName = NonNullable<NonNullable<OrdersByNameFullQuery['orders']>['edges'][number]['node']> | undefined;
|
|
19059
20576
|
declare function getOrderByName(orderName: string, detailLevel: 'lean'): Promise<LeanOrderByName>;
|
|
19060
20577
|
declare function getOrderByName(orderName: string, detailLevel: 'full'): Promise<FullOrderByName>;
|
|
19061
20578
|
declare function getOrderByName(orderName: string): Promise<LeanOrderByName>;
|
|
19062
20579
|
|
|
20580
|
+
type OrderCancellationInfo = NonNullable<OrderCancellationInfoByNameQuery['orders']['edges'][number]['node']>;
|
|
20581
|
+
/**
|
|
20582
|
+
* Retrieves cancellation information for an order by its name (e.g., "B12345").
|
|
20583
|
+
* Returns undefined if no order is found with the specified name.
|
|
20584
|
+
*
|
|
20585
|
+
* @param {string} orderName - The order name to search for (e.g., "B12345").
|
|
20586
|
+
* @returns {Promise<OrderCancellationInfo | undefined>} A promise that resolves to the order cancellation info or undefined if not found.
|
|
20587
|
+
* @throws {Error} If the GraphQL query fails or if the response structure is invalid.
|
|
20588
|
+
*/
|
|
20589
|
+
declare function getOrderCancellationInfoByName(orderName: string): Promise<OrderCancellationInfo | undefined>;
|
|
20590
|
+
|
|
19063
20591
|
declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<{
|
|
19064
20592
|
productId: z.ZodString;
|
|
19065
20593
|
productTitle: z.ZodString;
|
|
@@ -19068,16 +20596,16 @@ declare const GetLeanProductVariantsReturn: z.ZodArray<z.ZodObject<{
|
|
|
19068
20596
|
sku: z.ZodString;
|
|
19069
20597
|
}, "strip", z.ZodTypeAny, {
|
|
19070
20598
|
productId: string;
|
|
19071
|
-
variantId: string;
|
|
19072
20599
|
sku: string;
|
|
19073
|
-
|
|
20600
|
+
variantId: string;
|
|
19074
20601
|
productTitle: string;
|
|
20602
|
+
variantTitle: string;
|
|
19075
20603
|
}, {
|
|
19076
20604
|
productId: string;
|
|
19077
|
-
variantId: string;
|
|
19078
20605
|
sku: string;
|
|
19079
|
-
|
|
20606
|
+
variantId: string;
|
|
19080
20607
|
productTitle: string;
|
|
20608
|
+
variantTitle: string;
|
|
19081
20609
|
}>, "many">;
|
|
19082
20610
|
type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsReturn>;
|
|
19083
20611
|
/**
|
|
@@ -19091,133 +20619,185 @@ type GetLeanProductVariantsReturnType = z.infer<typeof GetLeanProductVariantsRet
|
|
|
19091
20619
|
*/
|
|
19092
20620
|
declare function getLeanProductVariants(skus?: string[]): Promise<GetLeanProductVariantsReturnType>;
|
|
19093
20621
|
|
|
19094
|
-
declare const
|
|
19095
|
-
|
|
19096
|
-
|
|
19097
|
-
|
|
19098
|
-
|
|
19099
|
-
|
|
19100
|
-
|
|
19101
|
-
}, "strip", z.ZodTypeAny, {
|
|
19102
|
-
currencyCode: string;
|
|
19103
|
-
amount: string;
|
|
19104
|
-
}, {
|
|
19105
|
-
currencyCode: string;
|
|
19106
|
-
amount: string;
|
|
19107
|
-
}>;
|
|
19108
|
-
}, "strip", z.ZodTypeAny, {
|
|
19109
|
-
shopMoney: {
|
|
19110
|
-
currencyCode: string;
|
|
19111
|
-
amount: string;
|
|
19112
|
-
};
|
|
19113
|
-
}, {
|
|
19114
|
-
shopMoney: {
|
|
19115
|
-
currencyCode: string;
|
|
19116
|
-
amount: string;
|
|
19117
|
-
};
|
|
19118
|
-
}>;
|
|
19119
|
-
createdAt: z.ZodString;
|
|
19120
|
-
gateway: z.ZodString;
|
|
19121
|
-
formattedGateway: z.ZodString;
|
|
19122
|
-
kind: z.ZodString;
|
|
19123
|
-
paymentId: z.ZodString;
|
|
19124
|
-
}, "strip", z.ZodTypeAny, {
|
|
19125
|
-
createdAt: string;
|
|
19126
|
-
gateway: string;
|
|
19127
|
-
formattedGateway: string;
|
|
19128
|
-
kind: string;
|
|
19129
|
-
paymentId: string;
|
|
19130
|
-
amountSet: {
|
|
19131
|
-
shopMoney: {
|
|
19132
|
-
currencyCode: string;
|
|
19133
|
-
amount: string;
|
|
19134
|
-
};
|
|
19135
|
-
};
|
|
19136
|
-
}, {
|
|
19137
|
-
createdAt: string;
|
|
19138
|
-
gateway: string;
|
|
19139
|
-
formattedGateway: string;
|
|
19140
|
-
kind: string;
|
|
19141
|
-
paymentId: string;
|
|
19142
|
-
amountSet: {
|
|
19143
|
-
shopMoney: {
|
|
19144
|
-
currencyCode: string;
|
|
19145
|
-
amount: string;
|
|
19146
|
-
};
|
|
19147
|
-
};
|
|
19148
|
-
}>, "many">;
|
|
19149
|
-
}, "strip", z.ZodTypeAny, {
|
|
19150
|
-
transactions: {
|
|
19151
|
-
createdAt: string;
|
|
19152
|
-
gateway: string;
|
|
19153
|
-
formattedGateway: string;
|
|
19154
|
-
kind: string;
|
|
19155
|
-
paymentId: string;
|
|
19156
|
-
amountSet: {
|
|
19157
|
-
shopMoney: {
|
|
19158
|
-
currencyCode: string;
|
|
19159
|
-
amount: string;
|
|
19160
|
-
};
|
|
19161
|
-
};
|
|
19162
|
-
}[];
|
|
19163
|
-
}, {
|
|
19164
|
-
transactions: {
|
|
19165
|
-
createdAt: string;
|
|
19166
|
-
gateway: string;
|
|
19167
|
-
formattedGateway: string;
|
|
19168
|
-
kind: string;
|
|
19169
|
-
paymentId: string;
|
|
19170
|
-
amountSet: {
|
|
19171
|
-
shopMoney: {
|
|
19172
|
-
currencyCode: string;
|
|
19173
|
-
amount: string;
|
|
19174
|
-
};
|
|
19175
|
-
};
|
|
19176
|
-
}[];
|
|
19177
|
-
}>;
|
|
20622
|
+
declare const GetProductVariantsBySkusReturn: z.ZodArray<z.ZodObject<{
|
|
20623
|
+
productId: z.ZodString;
|
|
20624
|
+
productTitle: z.ZodString;
|
|
20625
|
+
variantId: z.ZodString;
|
|
20626
|
+
variantTitle: z.ZodString;
|
|
20627
|
+
sku: z.ZodString;
|
|
20628
|
+
status: z.ZodEnum<["ACTIVE", "ARCHIVED", "DRAFT"]>;
|
|
19178
20629
|
}, "strip", z.ZodTypeAny, {
|
|
19179
|
-
|
|
19180
|
-
|
|
19181
|
-
|
|
19182
|
-
|
|
19183
|
-
|
|
19184
|
-
|
|
19185
|
-
paymentId: string;
|
|
19186
|
-
amountSet: {
|
|
19187
|
-
shopMoney: {
|
|
19188
|
-
currencyCode: string;
|
|
19189
|
-
amount: string;
|
|
19190
|
-
};
|
|
19191
|
-
};
|
|
19192
|
-
}[];
|
|
19193
|
-
};
|
|
20630
|
+
status: "ACTIVE" | "ARCHIVED" | "DRAFT";
|
|
20631
|
+
productId: string;
|
|
20632
|
+
sku: string;
|
|
20633
|
+
variantId: string;
|
|
20634
|
+
productTitle: string;
|
|
20635
|
+
variantTitle: string;
|
|
19194
20636
|
}, {
|
|
19195
|
-
|
|
19196
|
-
|
|
19197
|
-
|
|
19198
|
-
|
|
19199
|
-
|
|
19200
|
-
|
|
19201
|
-
|
|
19202
|
-
|
|
19203
|
-
|
|
19204
|
-
|
|
19205
|
-
|
|
19206
|
-
|
|
19207
|
-
|
|
19208
|
-
|
|
19209
|
-
|
|
20637
|
+
status: "ACTIVE" | "ARCHIVED" | "DRAFT";
|
|
20638
|
+
productId: string;
|
|
20639
|
+
sku: string;
|
|
20640
|
+
variantId: string;
|
|
20641
|
+
productTitle: string;
|
|
20642
|
+
variantTitle: string;
|
|
20643
|
+
}>, "many">;
|
|
20644
|
+
type ProductVariantBySku = z.infer<typeof GetProductVariantsBySkusReturn>[number];
|
|
20645
|
+
type ProductVariantsBySkusOptions = {
|
|
20646
|
+
/** Filter to only active products (excludes ARCHIVED). Defaults to false. */
|
|
20647
|
+
activeOnly?: boolean;
|
|
20648
|
+
};
|
|
20649
|
+
/**
|
|
20650
|
+
* Retrieves product variants from Shopify filtered by SKUs.
|
|
20651
|
+
* Variants missing a SKU will be filtered out and logged.
|
|
20652
|
+
*
|
|
20653
|
+
* @param {string[]} skus - Array of SKUs to filter by.
|
|
20654
|
+
* @param {ProductVariantsBySkusOptions} [options] - Optional settings.
|
|
20655
|
+
* @param {boolean} [options.activeOnly=false] - If true, excludes ARCHIVED products at query level.
|
|
20656
|
+
* @returns {Promise<ProductVariantBySku[]>} A promise that resolves to an array of product variant data.
|
|
20657
|
+
* @throws {Error} If the GraphQL query fails or returns no data.
|
|
20658
|
+
*/
|
|
20659
|
+
declare function getProductVariantsBySkus(skus: string[], options?: ProductVariantsBySkusOptions): Promise<ProductVariantBySku[]>;
|
|
20660
|
+
|
|
20661
|
+
declare const ProductVariantSchema: z.ZodObject<{
|
|
20662
|
+
status: z.ZodEnum<["ACTIVE", "ARCHIVED", "DRAFT"]>;
|
|
20663
|
+
sku: z.ZodString;
|
|
20664
|
+
barcode: z.ZodNullable<z.ZodString>;
|
|
20665
|
+
price: z.ZodString;
|
|
20666
|
+
title: z.ZodString;
|
|
20667
|
+
url: z.ZodNullable<z.ZodString>;
|
|
20668
|
+
handle: z.ZodString;
|
|
20669
|
+
description: z.ZodString;
|
|
20670
|
+
imageUrl: z.ZodNullable<z.ZodString>;
|
|
20671
|
+
inventoryQuantity: z.ZodNumber;
|
|
20672
|
+
}, "strip", z.ZodTypeAny, {
|
|
20673
|
+
status: "ACTIVE" | "ARCHIVED" | "DRAFT";
|
|
20674
|
+
url: string | null;
|
|
20675
|
+
description: string;
|
|
20676
|
+
handle: string;
|
|
20677
|
+
sku: string;
|
|
20678
|
+
barcode: string | null;
|
|
20679
|
+
inventoryQuantity: number;
|
|
20680
|
+
price: string;
|
|
20681
|
+
title: string;
|
|
20682
|
+
imageUrl: string | null;
|
|
20683
|
+
}, {
|
|
20684
|
+
status: "ACTIVE" | "ARCHIVED" | "DRAFT";
|
|
20685
|
+
url: string | null;
|
|
20686
|
+
description: string;
|
|
20687
|
+
handle: string;
|
|
20688
|
+
sku: string;
|
|
20689
|
+
barcode: string | null;
|
|
20690
|
+
inventoryQuantity: number;
|
|
20691
|
+
price: string;
|
|
20692
|
+
title: string;
|
|
20693
|
+
imageUrl: string | null;
|
|
19210
20694
|
}>;
|
|
19211
|
-
type
|
|
20695
|
+
type ProductVariant = z.infer<typeof ProductVariantSchema>;
|
|
20696
|
+
/**
|
|
20697
|
+
* Retrieves all product variants from Shopify with full details.
|
|
20698
|
+
* Automatically handles pagination to fetch all variants.
|
|
20699
|
+
*
|
|
20700
|
+
* Each variant includes product info with combined title (product + variant title
|
|
20701
|
+
* when variant title is not "Default Title"), URL with variant ID, and inventory data.
|
|
20702
|
+
*
|
|
20703
|
+
* @returns {Promise<ProductVariant[]>} A promise that resolves to an array of product variants.
|
|
20704
|
+
* @throws {Error} If the GraphQL query fails or if the response is missing expected data.
|
|
20705
|
+
*/
|
|
20706
|
+
declare function getAllProductVariants(): Promise<ProductVariant[]>;
|
|
20707
|
+
|
|
20708
|
+
type OrderPaymentDetails = NonNullable<OrderPaymentDetailsByIdQuery['order']>;
|
|
19212
20709
|
/**
|
|
19213
20710
|
* Retrieves payment details for a single order from Shopify by its ID.
|
|
19214
|
-
* Returns
|
|
20711
|
+
* Returns undefined if no order is found with the specified ID.
|
|
19215
20712
|
*
|
|
19216
20713
|
* @param {bigint} id - The numerical Shopify order ID (e.g., 12345678n).
|
|
19217
|
-
* @returns {Promise<
|
|
20714
|
+
* @returns {Promise<OrderPaymentDetails | undefined>} A promise that resolves to the order payment data or undefined if not found.
|
|
20715
|
+
* @throws {Error} If the GraphQL query fails.
|
|
20716
|
+
*/
|
|
20717
|
+
declare function getOrderPaymentDetailsById(id: bigint): Promise<OrderPaymentDetails | undefined>;
|
|
20718
|
+
|
|
20719
|
+
type Fulfillment = NonNullable<FulfillmentByIdQuery['fulfillment']>;
|
|
20720
|
+
/**
|
|
20721
|
+
* Retrieves a single fulfillment from Shopify by its ID.
|
|
20722
|
+
* Returns undefined if no fulfillment is found with the specified ID.
|
|
20723
|
+
*
|
|
20724
|
+
* @param {string | number | bigint} id - The Shopify fulfillment ID. Can be a GID string (e.g., "gid://shopify/Fulfillment/123456789") or a numeric ID (e.g., 123456789 or 123456789n).
|
|
20725
|
+
* @returns {Promise<Fulfillment | undefined>} A promise that resolves to the fulfillment data or undefined if not found.
|
|
19218
20726
|
* @throws {Error} If the GraphQL query fails or if the response structure is invalid.
|
|
19219
20727
|
*/
|
|
19220
|
-
declare function
|
|
20728
|
+
declare function getFulfillmentById(id: string | number | bigint): Promise<Fulfillment | undefined>;
|
|
20729
|
+
|
|
20730
|
+
type FulfillmentOrderEdge = NonNullable<FulfillmentOrdersByOrderIdQuery['order']>['fulfillmentOrders']['edges'][number];
|
|
20731
|
+
type FulfillmentOrder = FulfillmentOrderEdge['node'];
|
|
20732
|
+
/**
|
|
20733
|
+
* Retrieves all fulfillment orders for a given Shopify order.
|
|
20734
|
+
* Returns an empty array if no order is found or if the order has no fulfillment orders.
|
|
20735
|
+
*
|
|
20736
|
+
* @param {string | number | bigint} orderId - The Shopify order ID. Can be a GID string (e.g., "gid://shopify/Order/123456789") or a numeric ID (e.g., 123456789 or 123456789n).
|
|
20737
|
+
* @returns {Promise<FulfillmentOrder[]>} A promise that resolves to an array of fulfillment orders.
|
|
20738
|
+
* @throws {Error} If the GraphQL query fails or if the response structure is invalid.
|
|
20739
|
+
*/
|
|
20740
|
+
declare function getFulfillmentOrdersByOrderId(orderId: string | number | bigint): Promise<FulfillmentOrder[]>;
|
|
20741
|
+
|
|
20742
|
+
type FulfillmentTrackingIds = {
|
|
20743
|
+
trackingNumbers: string[];
|
|
20744
|
+
trackingCompany: string | null;
|
|
20745
|
+
};
|
|
20746
|
+
/**
|
|
20747
|
+
* Retrieves tracking information for a fulfillment by its ID.
|
|
20748
|
+
* Returns the tracking numbers and the tracking company.
|
|
20749
|
+
*
|
|
20750
|
+
* @param {string | number | bigint} id - The Shopify fulfillment ID. Can be a GID string (e.g., "gid://shopify/Fulfillment/123456789") or a numeric ID (e.g., 123456789 or 123456789n).
|
|
20751
|
+
* @returns {Promise<FulfillmentTrackingIds | undefined>} A promise that resolves to the tracking info or undefined if fulfillment not found.
|
|
20752
|
+
* @throws {Error} If the GraphQL query fails.
|
|
20753
|
+
*/
|
|
20754
|
+
declare function getFulfillmentTrackingIds(id: string | number | bigint): Promise<FulfillmentTrackingIds | undefined>;
|
|
20755
|
+
|
|
20756
|
+
type Customer = CustomersByEmailQuery['customers']['edges'][number]['node'];
|
|
20757
|
+
/**
|
|
20758
|
+
* Retrieves customers from Shopify by their email address.
|
|
20759
|
+
* Returns an empty array if no customers are found.
|
|
20760
|
+
*
|
|
20761
|
+
* @param {string} email - The email address to search for.
|
|
20762
|
+
* @param {number} limit - Maximum number of customers to return. Defaults to 10.
|
|
20763
|
+
* @returns {Promise<Customer[]>} A promise that resolves to an array of customers.
|
|
20764
|
+
* @throws {Error} If the GraphQL query fails or if the response structure is invalid.
|
|
20765
|
+
*/
|
|
20766
|
+
declare function getCustomersByEmail(email: string, limit?: number): Promise<Customer[]>;
|
|
20767
|
+
|
|
20768
|
+
type CustomerSegmentMember = CustomerSegmentMembersWithStatisticsQuery['customerSegmentMembers']['edges'][number]['node'];
|
|
20769
|
+
type SegmentAttributeStatistics = CustomerSegmentMembersWithStatisticsQuery['customerSegmentMembers']['statistics']['attributeStatistics'];
|
|
20770
|
+
interface CustomerSegmentMembersResult {
|
|
20771
|
+
members: CustomerSegmentMember[];
|
|
20772
|
+
totalCount: number;
|
|
20773
|
+
statistics: {
|
|
20774
|
+
attributeStatistics: SegmentAttributeStatistics;
|
|
20775
|
+
};
|
|
20776
|
+
}
|
|
20777
|
+
/**
|
|
20778
|
+
* Retrieves customer segment members from Shopify based on a segment query.
|
|
20779
|
+
* Returns members with statistics for the specified attribute.
|
|
20780
|
+
*
|
|
20781
|
+
* @param {string} query - The segment query filter string (e.g., "customer_account_status = 'ENABLED'").
|
|
20782
|
+
* @param {string} statisticsAttributeName - Attribute name for statistics (e.g., "amount_spent").
|
|
20783
|
+
* @param {number} limit - Maximum number of members to return. Defaults to 250.
|
|
20784
|
+
* @returns {Promise<CustomerSegmentMembersResult>} Members with statistics.
|
|
20785
|
+
* @throws {Error} If the GraphQL query fails.
|
|
20786
|
+
*/
|
|
20787
|
+
declare function getCustomerSegmentMembers(query: string, statisticsAttributeName: string, limit?: number): Promise<CustomerSegmentMembersResult>;
|
|
20788
|
+
|
|
20789
|
+
type CustomerOrders = NonNullable<OrdersByCustomerIdQuery['customer']>['orders'];
|
|
20790
|
+
type OrderPreview = CustomerOrders['edges'][number]['node'];
|
|
20791
|
+
/**
|
|
20792
|
+
* Retrieves orders for a specific customer from Shopify.
|
|
20793
|
+
* Returns orders sorted by most recent first, or an empty array if customer not found.
|
|
20794
|
+
*
|
|
20795
|
+
* @param {number | bigint} customerId - The numerical Shopify customer ID.
|
|
20796
|
+
* @param {number} limit - Maximum number of orders to return. Defaults to 250.
|
|
20797
|
+
* @returns {Promise<OrderPreview[]>} A promise that resolves to an array of order previews.
|
|
20798
|
+
* @throws {Error} If the GraphQL query fails.
|
|
20799
|
+
*/
|
|
20800
|
+
declare function getOrdersByCustomerId(customerId: number | bigint, limit?: number): Promise<OrderPreview[]>;
|
|
19221
20801
|
|
|
19222
20802
|
/**
|
|
19223
20803
|
* Extract numeric ID from a Shopify GID string.
|
|
@@ -19228,4 +20808,14 @@ declare function getOrderPaymentDetailsById(id: bigint): Promise<GetOrderPayment
|
|
|
19228
20808
|
*/
|
|
19229
20809
|
declare function parseGid(gid: string): number;
|
|
19230
20810
|
|
|
19231
|
-
|
|
20811
|
+
type Metaobject = NonNullable<MetaobjectByHandleQuery['metaobjectByHandle']>;
|
|
20812
|
+
/**
|
|
20813
|
+
* Retrieves a metaobject from Shopify by its handle.
|
|
20814
|
+
* Returns undefined if no metaobject is found with the specified type and handle.
|
|
20815
|
+
*
|
|
20816
|
+
* @param handle - The handle input containing type and handle
|
|
20817
|
+
* @returns A promise that resolves to the metaobject data or undefined if not found.
|
|
20818
|
+
*/
|
|
20819
|
+
declare function getMetaobjectByHandle(handle: MetaobjectHandleInput): Promise<Metaobject | undefined>;
|
|
20820
|
+
|
|
20821
|
+
export { type BulkUpdateProductVariantsResult, type CalculateRefundLineItem, type CalculateRefundOptions, type CreateFulfillmentResult, type CreateMetaobjectDefinitionInput, type CreateMetaobjectDefinitionResult, type CreateRefundLineItem, type CreateRefundOptions, type CreateRefundResult, type CreateRefundTransaction, type Customer, type CustomerSegmentMember, type CustomerSegmentMembersResult, type Fulfillment, type FulfillmentLineItem$1 as FulfillmentLineItem, type FulfillmentOrder, type FulfillmentTrackingIds, type FullOrder, type FullOrderByName, type LeanOrder, type LeanOrderByName, type Metaobject, type MetaobjectFieldDefinition$1 as MetaobjectFieldDefinition, type MetaobjectHandleInput, type OrderCancellationInfo, type OrderPaymentDetails, type OrderPreview, type ProductVariant, type ProductVariantBySku, type ProductVariantsBySkusOptions, type RefundMoney, type SegmentAttributeStatistics, ShopifyUserError, type ShopifyUserErrorDetail, type SuggestedRefund, type UpdateFulfillmentTrackingResult, type UpsertMetaobjectInput, type UpsertMetaobjectResult, type VariantUpdateInput, bulkUpdateProductVariants, calculateRefund, cancelOrderById, createFile, createFulfillment, createMetaobjectDefinition, createRefund, deleteCustomerById, deleteFilesByIds, getAllProductVariants, getCustomerSegmentMembers, getCustomersByEmail, getFulfillmentById, getFulfillmentOrdersByOrderId, getFulfillmentTrackingIds, getLeanProductVariants, getMetaobjectByHandle, getOrderById, getOrderByName, getOrderCancellationInfoByName, getOrderPaymentDetailsById, getOrdersByCustomerId, getProductVariantsBySkus, parseGid, updateFulfillmentTracking, upsertMetaobject };
|