Shopify Shop

1type ShopifyShop {
2  """
3  The globally unique, unchanging identifier for this record. Assigned and managed by Shopify.
4  """
5  id: GadgetID!
6
7  """
8  The time at which this record was first created. Set once upon record creation and never changed. Managed by Gadget.
9  """
10  createdAt: DateTime!
11
12  """
13  The time at which this record was last changed. Set each time the record is successfully acted upon by an action. Managed by Gadget.
14  """
15  updatedAt: DateTime!
16
17  """
18  The current state this record is in. Changed by invoking actions. Managed by Gadget.
19  """
20  state: RecordState!
21  customers(
22    """
23    Returns the items in the list that come after the specified cursor.
24    """
25    after: String
26
27    """
28    Returns the first n items from the list.
29    """
30    first: Int
31
32    """
33    Returns the items in the list that come before the specified cursor.
34    """
35    before: String
36
37    """
38    Returns the last n items from the list.
39    """
40    last: Int
41
42    """
43    A list of sort orders to return the results in
44    """
45    sort: [ShopifyCustomerSort!]
46
47    """
48    A list of filters to refine the results by
49    """
50    filter: [ShopifyCustomerFilter!]
51
52    """
53    A free form text search query to find records matching
54    """
55    search: String
56  ): ShopifyCustomerConnection!
57  syncs(
58    """
59    Returns the items in the list that come after the specified cursor.
60    """
61    after: String
62
63    """
64    Returns the first n items from the list.
65    """
66    first: Int
67
68    """
69    Returns the items in the list that come before the specified cursor.
70    """
71    before: String
72
73    """
74    Returns the last n items from the list.
75    """
76    last: Int
77
78    """
79    A list of sort orders to return the results in
80    """
81    sort: [ShopifySyncSort!]
82
83    """
84    A list of filters to refine the results by
85    """
86    filter: [ShopifySyncFilter!]
87
88    """
89    A free form text search query to find records matching
90    """
91    search: String
92  ): ShopifySyncConnection!
93  gdprRequests(
94    """
95    Returns the items in the list that come after the specified cursor.
96    """
97    after: String
98
99    """
100    Returns the first n items from the list.
101    """
102    first: Int
103
104    """
105    Returns the items in the list that come before the specified cursor.
106    """
107    before: String
108
109    """
110    Returns the last n items from the list.
111    """
112    last: Int
113
114    """
115    A list of sort orders to return the results in
116    """
117    sort: [ShopifyGdprRequestSort!]
118
119    """
120    A list of filters to refine the results by
121    """
122    filter: [ShopifyGdprRequestFilter!]
123
124    """
125    A free form text search query to find records matching
126    """
127    search: String
128  ): ShopifyGdprRequestConnection!
129  accessToken: String
130  address1: String
131  address2: String
132  checkoutApiSupported: Boolean
133  city: String
134  cookieConsentLevel: String
135  country: String
136  countryCode: String
137  countryName: String
138  countyTaxes: JSON
139  shopifyCreatedAt: DateTime
140  currency: String
141  customerEmail: String
142  domain: String
143  eligibleForCardReaderGiveaway: Boolean
144  eligibleForPayments: Boolean
145  email: String
146  enabledPresentmentCurrencies: JSON
147  finances: Boolean
148  forceSsl: Boolean
149  googleAppsDomain: String
150  googleAppsLoginEnabled: Boolean
151  grantedScopes: JSON
152  hasDiscounts: Boolean
153  hasGiftCards: Boolean
154  hasStorefront: Boolean
155  ianaTimezone: String
156  installedViaApiKey: String
157  latitude: Float
158  longitude: Float
159  moneyFormat: String
160  moneyInEmailsFormat: String
161  moneyWithCurrencyFormat: String
162  moneyWithCurrencyInEmailsFormat: String
163  multiLocationEnabled: Boolean
164  myshopifyDomain: String
165  name: String
166  passwordEnabled: Boolean
167  phone: String
168  planDisplayName: String
169  planName: String
170  preLaunchEnabled: Boolean
171  primaryLocale: String
172  province: String
173  provinceCode: String
174  products(
175    """
176    Returns the items in the list that come after the specified cursor.
177    """
178    after: String
179
180    """
181    Returns the first n items from the list.
182    """
183    first: Int
184
185    """
186    Returns the items in the list that come before the specified cursor.
187    """
188    before: String
189
190    """
191    Returns the last n items from the list.
192    """
193    last: Int
194
195    """
196    A list of sort orders to return the results in
197    """
198    sort: [ShopifyProductSort!]
199
200    """
201    A list of filters to refine the results by
202    """
203    filter: [ShopifyProductFilter!]
204
205    """
206    A free form text search query to find records matching
207    """
208    search: String
209  ): ShopifyProductConnection!
210  productVariants(
211    """
212    Returns the items in the list that come after the specified cursor.
213    """
214    after: String
215
216    """
217    Returns the first n items from the list.
218    """
219    first: Int
220
221    """
222    Returns the items in the list that come before the specified cursor.
223    """
224    before: String
225
226    """
227    Returns the last n items from the list.
228    """
229    last: Int
230
231    """
232    A list of sort orders to return the results in
233    """
234    sort: [ShopifyProductVariantSort!]
235
236    """
237    A list of filters to refine the results by
238    """
239    filter: [ShopifyProductVariantFilter!]
240
241    """
242    A free form text search query to find records matching
243    """
244    search: String
245  ): ShopifyProductVariantConnection!
246  registeredWebhooks: JSON
247  requiresExtraPaymentsAgreement: Boolean
248  setupRequired: Boolean
249  shopOwner: String
250  source: String
251  taxShipping: Boolean
252  taxesIncluded: Boolean
253  timezone: String
254  shopifyUpdatedAt: DateTime
255  weightUnit: String
256  zipCode: String
257  tasks(
258    """
259    Returns the items in the list that come after the specified cursor.
260    """
261    after: String
262
263    """
264    Returns the first n items from the list.
265    """
266    first: Int
267
268    """
269    Returns the items in the list that come before the specified cursor.
270    """
271    before: String
272
273    """
274    Returns the last n items from the list.
275    """
276    last: Int
277
278    """
279    A list of sort orders to return the results in
280    """
281    sort: [TaskSort!]
282
283    """
284    A list of filters to refine the results by
285    """
286    filter: [TaskFilter!]
287
288    """
289    A free form text search query to find records matching
290    """
291    search: String
292  ): TaskConnection!
293  marketingSmsContentEnabledAtCheckout: Boolean
294  transactionalSmsDisabled: Boolean
295
296  """
297  Get all the fields for this record. Useful for not having to list out all the fields you want to retrieve, but slower.
298  """
299  _all: JSONObject!
300}

const [result, refresh] = useFindOne(api.shopifyShop, "some-id");
const { data, error, fetching } = result;
console.log(data?.id); //=> a string
console.log(data?.createdAt); //=> a Date object

1query GetOneShopifyShop($id: GadgetID!) {
2  shopifyShop(id: $id) {
3    __typename
4    id
5    state
6    accessToken
7    address1
8    address2
9    checkoutApiSupported
10    city
11    cookieConsentLevel
12    country
13    countryCode
14    countryName
15    countyTaxes
16    createdAt
17    currency
18    customerEmail
19    domain
20    eligibleForCardReaderGiveaway
21    eligibleForPayments
22    email
23    enabledPresentmentCurrencies
24    finances
25    forceSsl
26    googleAppsDomain
27    googleAppsLoginEnabled
28    grantedScopes
29    hasDiscounts
30    hasGiftCards
31    hasStorefront
32    ianaTimezone
33    installedViaApiKey
34    latitude
35    longitude
36    marketingSmsContentEnabledAtCheckout
37    moneyFormat
38    moneyInEmailsFormat
39    moneyWithCurrencyFormat
40    moneyWithCurrencyInEmailsFormat
41    multiLocationEnabled
42    myshopifyDomain
43    name
44    passwordEnabled
45    phone
46    planDisplayName
47    planName
48    preLaunchEnabled
49    primaryLocale
50    province
51    provinceCode
52    registeredWebhooks
53    requiresExtraPaymentsAgreement
54    setupRequired
55    shopOwner
56    shopifyCreatedAt
57    shopifyUpdatedAt
58    source
59    taxShipping
60    taxesIncluded
61    timezone
62    transactionalSmsDisabled
63    updatedAt
64    weightUnit
65    zipCode
66  }
67}

const [result, refresh] = useFindFirst(api.shopifyShop);
const { data, error, fetching } = result;
console.log(data?.id); //=> a string
console.log(data?.createdAt); //=> a Date object

1query FindManyShopifyShops(
2  $first: Int
3  $search: String
4  $sort: [ShopifyShopSort!]
5  $filter: [ShopifyShopFilter!]
6) {
7  shopifyShops(first: $first, search: $search, sort: $sort, filter: $filter) {
8    edges {
9      node {
10        __typename
11        id
12        state
13        accessToken
14        address1
15        address2
16        checkoutApiSupported
17        city
18        cookieConsentLevel
19        country
20        countryCode
21        countryName
22        countyTaxes
23        createdAt
24        currency
25        customerEmail
26        domain
27        eligibleForCardReaderGiveaway
28        eligibleForPayments
29        email
30        enabledPresentmentCurrencies
31        finances
32        forceSsl
33        googleAppsDomain
34        googleAppsLoginEnabled
35        grantedScopes
36        hasDiscounts
37        hasGiftCards
38        hasStorefront
39        ianaTimezone
40        installedViaApiKey
41        latitude
42        longitude
43        marketingSmsContentEnabledAtCheckout
44        moneyFormat
45        moneyInEmailsFormat
46        moneyWithCurrencyFormat
47        moneyWithCurrencyInEmailsFormat
48        multiLocationEnabled
49        myshopifyDomain
50        name
51        passwordEnabled
52        phone
53        planDisplayName
54        planName
55        preLaunchEnabled
56        primaryLocale
57        province
58        provinceCode
59        registeredWebhooks
60        requiresExtraPaymentsAgreement
61        setupRequired
62        shopOwner
63        shopifyCreatedAt
64        shopifyUpdatedAt
65        source
66        taxShipping
67        taxesIncluded
68        timezone
69        transactionalSmsDisabled
70        updatedAt
71        weightUnit
72        zipCode
73      }
74    }
75  }
76}

const [result, refresh] = useFindMany(api.shopifyShop);
const { data, error, fetching } = result;
console.log(data?.length); //=> a number
console.log(data?.[0].length); //=> a string

1query FindManyShopifyShops {
2  shopifyShops {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const [result, refresh] = useFindMany(api.shopifyShop, {
  sort: { createdAt: "Descending" },
});
const { data, error, fetching } = result;

1query FindManyShopifyShops($sort: [ShopifyShopSort!]) {
2  shopifyShops(sort: $sort) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const [result, refresh] = useFindMany(api.shopifyShop, {
  sort: [{ state: "Descending" }, { createdAt: "Ascending" }],
});
const { data, error, fetching } = result;

1query FindManyShopifyShops($sort: [ShopifyShopSort!]) {
2  shopifyShops(sort: $sort) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const [result, refresh] = useFindMany(api.shopifyShop, {
  sort: { id: "Descending" },
});
const { data, error, fetching } = result;

1query FindManyShopifyShops($sort: [ShopifyShopSort!]) {
2  shopifyShops(sort: $sort) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const [result, refresh] = useFindMany(api.shopifyShop, {
  search: "a specific phrase to search for",
});
const { data, error, fetching } = result;

1query FindManyShopifyShops($search: String) {
2  shopifyShops(search: $search) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const yesterday = new Date(Date.now() - 864e5);
const [result, refresh] = useFindMany(api.shopifyShop, {
  filter: { createdAt: { greaterThan: yesterday } },
});
const { data, error, fetching } = result;

1query FindManyShopifyShops($filter: [ShopifyShopFilter!]) {
2  shopifyShops(filter: $filter) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

1const yesterday = new Date(Date.now() - 86400000);
2const oneWeekAgo = new Date(Date.now() - 604800000);
3const [result, refresh] = useFindMany(api.shopifyShop, {
4  filter: {
5    OR: [
6      {
7        createdAt: { greaterThan: oneWeekAgo },
8      },
9      {
10        updated: { greaterThan: yesterday },
11      },
12    ],
13  },
14});
15const { data, error, fetching } = result;

1query FindManyShopifyShops($filter: [ShopifyShopFilter!]) {
2  shopifyShops(filter: $filter) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

1const [result, refresh] = useFindMany(api.shopifyShop, {
2  filter: {
3    state: { inState: "created.installed" },
4  },
5});
6const { data, error, fetching } = result;

1query FindManyShopifyShops($filter: [ShopifyShopFilter!]) {
2  shopifyShops(filter: $filter) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

1const [result, refresh] = useFindMany(api.shopifyShop, {
2  filter: {
3    id: { isSet: true },
4  },
5});
6const { data, error, fetching } = result;

1query FindManyShopifyShops($filter: [ShopifyShopFilter!]) {
2  shopifyShops(filter: $filter) {
3    edges {
4      node {
5        __typename
6        id
7        state
8        # ...
9        createdAt
10        updatedAt
11      }
12    }
13  }
14}

const [result, refresh] = useFindMany(api.shopifyShop, { first: 25 });
const { data, error, fetching } = result;
console.log(data?.length); //=> no greater than 25

1query FindManyShopifyShops($first: Int, $after: String) {
2  shopifyShops(first: $first, after: $after) {
3    edges {
4      cursor
5      node {
6        __typename
7        id
8        state
9        # ...
10        createdAt
11        updatedAt
12      }
13    }
14    pageInfo {
15      endCursor
16      hasNextPage
17      hasPreviousPage
18      startCursor
19    }
20  }
21}