shopify-client 1.2.0

Type-safe, async Rust client for the Shopify Admin and Storefront APIs
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use std::sync::OnceLock;

// MONEY_FRAGMENT is brought in only where Customer/Order types actually reference MoneyV2.

const ADDRESS_FRAGMENT: &str = r#"
  fragment AddressFields on MailingAddress {
    id
    firstName
    lastName
    name
    company
    address1
    address2
    city
    province
    provinceCode
    country
    countryCodeV2
    zip
    phone
    formatted
    formattedArea
    latitude
    longitude
  }
"#;

const ORDER_FRAGMENT: &str = r#"
  fragment OrderFields on Order {
    id
    name
    orderNumber
    processedAt
    canceledAt
    cancelReason
    fulfillmentStatus
    financialStatus
    statusUrl
    email
    phone
    currencyCode
    currentTotalPrice {
      ...MoneyFields
    }
    currentSubtotalPrice {
      ...MoneyFields
    }
    currentTotalTax {
      ...MoneyFields
    }
    totalPrice {
      ...MoneyFields
    }
    subtotalPrice {
      ...MoneyFields
    }
    totalShippingPrice {
      ...MoneyFields
    }
    totalTax {
      ...MoneyFields
    }
    totalRefunded {
      ...MoneyFields
    }
    shippingAddress {
      ...AddressFields
    }
    lineItems(first: 50) {
      edges {
        node {
          title
          quantity
          currentQuantity
          originalTotalPrice {
            ...MoneyFields
          }
          discountedTotalPrice {
            ...MoneyFields
          }
          variant {
            id
            title
            sku
            image {
              url
              altText
            }
            product {
              id
              handle
              title
            }
          }
        }
      }
    }
  }
"#;

const CUSTOMER_FRAGMENT: &str = r#"
  fragment CustomerFields on Customer {
    id
    email
    firstName
    lastName
    displayName
    phone
    acceptsMarketing
    createdAt
    updatedAt
    numberOfOrders
    tags
    defaultAddress {
      ...AddressFields
    }
  }
"#;

const CUSTOMER_USER_ERROR_FRAGMENT: &str = r#"
  fragment UserErrorFields on CustomerUserError {
    field
    message
    code
  }
"#;

const CUSTOMER_ACCESS_TOKEN_CREATE: &str = r#"
  mutation CustomerAccessTokenCreate($input: CustomerAccessTokenCreateInput!) {
    customerAccessTokenCreate(input: $input) {
      customerAccessToken {
        accessToken
        expiresAt
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ACCESS_TOKEN_RENEW: &str = r#"
  mutation CustomerAccessTokenRenew($customerAccessToken: String!) {
    customerAccessTokenRenew(customerAccessToken: $customerAccessToken) {
      customerAccessToken {
        accessToken
        expiresAt
      }
      userErrors {
        field
        message
      }
    }
  }
"#;

const CUSTOMER_ACCESS_TOKEN_DELETE: &str = r#"
  mutation CustomerAccessTokenDelete($customerAccessToken: String!) {
    customerAccessTokenDelete(customerAccessToken: $customerAccessToken) {
      deletedAccessToken
      deletedCustomerAccessTokenId
      userErrors {
        field
        message
      }
    }
  }
"#;

const CUSTOMER_CREATE: &str = r#"
  mutation CustomerCreate($input: CustomerCreateInput!) {
    customerCreate(input: $input) {
      customer {
        id
        email
        firstName
        lastName
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_UPDATE: &str = r#"
  mutation CustomerUpdate($customerAccessToken: String!, $customer: CustomerUpdateInput!) {
    customerUpdate(customerAccessToken: $customerAccessToken, customer: $customer) {
      customer {
        ...CustomerFields
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_RECOVER: &str = r#"
  mutation CustomerRecover($email: String!) {
    customerRecover(email: $email) {
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_RESET: &str = r#"
  mutation CustomerReset($id: ID!, $input: CustomerResetInput!) {
    customerReset(id: $id, input: $input) {
      customer {
        id
        email
      }
      customerAccessToken {
        accessToken
        expiresAt
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_RESET_BY_URL: &str = r#"
  mutation CustomerResetByUrl($resetUrl: URL!, $password: String!) {
    customerResetByUrl(resetUrl: $resetUrl, password: $password) {
      customer {
        id
        email
      }
      customerAccessToken {
        accessToken
        expiresAt
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ACTIVATE: &str = r#"
  mutation CustomerActivate($id: ID!, $input: CustomerActivateInput!) {
    customerActivate(id: $id, input: $input) {
      customer {
        id
        email
      }
      customerAccessToken {
        accessToken
        expiresAt
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ACTIVATE_BY_URL: &str = r#"
  mutation CustomerActivateByUrl($activationUrl: URL!, $password: String!) {
    customerActivateByUrl(activationUrl: $activationUrl, password: $password) {
      customer {
        id
        email
      }
      customerAccessToken {
        accessToken
        expiresAt
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ADDRESS_CREATE: &str = r#"
  mutation CustomerAddressCreate($customerAccessToken: String!, $address: MailingAddressInput!) {
    customerAddressCreate(customerAccessToken: $customerAccessToken, address: $address) {
      customerAddress {
        ...AddressFields
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ADDRESS_UPDATE: &str = r#"
  mutation CustomerAddressUpdate($customerAccessToken: String!, $id: ID!, $address: MailingAddressInput!) {
    customerAddressUpdate(customerAccessToken: $customerAccessToken, id: $id, address: $address) {
      customerAddress {
        ...AddressFields
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_ADDRESS_DELETE: &str = r#"
  mutation CustomerAddressDelete($customerAccessToken: String!, $id: ID!) {
    customerAddressDelete(customerAccessToken: $customerAccessToken, id: $id) {
      deletedCustomerAddressId
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const CUSTOMER_DEFAULT_ADDRESS_UPDATE: &str = r#"
  mutation CustomerDefaultAddressUpdate($customerAccessToken: String!, $addressId: ID!) {
    customerDefaultAddressUpdate(customerAccessToken: $customerAccessToken, addressId: $addressId) {
      customer {
        ...CustomerFields
      }
      customerUserErrors {
        ...UserErrorFields
      }
    }
  }
"#;

const GET_CUSTOMER: &str = r#"
  query GetCustomer(
    $customerAccessToken: String!
    $addressesFirst: Int
    $ordersFirst: Int
  ) {
    customer(customerAccessToken: $customerAccessToken) {
      ...CustomerFields
      addresses(first: $addressesFirst) {
        edges {
          node {
            ...AddressFields
          }
        }
      }
      orders(first: $ordersFirst) {
        edges {
          node {
            ...OrderFields
          }
        }
      }
    }
  }
"#;

pub fn customer_access_token_create() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_ACCESS_TOKEN_CREATE].concat())
}

pub fn customer_access_token_renew() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(
        || // No CUSTOMER_USER_ERROR_FRAGMENT here: this mutation returns plain `UserError`
    // (not `CustomerUserError`) and selects `userErrors { field message }` inline,
    // so including the fragment would make it an unused fragment (validation error).
    CUSTOMER_ACCESS_TOKEN_RENEW.to_string(),
    )
}

pub fn customer_access_token_delete() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| CUSTOMER_ACCESS_TOKEN_DELETE.to_string())
}

pub fn customer_create() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_CREATE].concat())
}

pub fn customer_update() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(
        || // CustomerFields/AddressFields don't reference MoneyV2, so MONEY_FRAGMENT
    // would be an unused fragment (validation error).
    [
        ADDRESS_FRAGMENT,
        CUSTOMER_FRAGMENT,
        CUSTOMER_USER_ERROR_FRAGMENT,
        CUSTOMER_UPDATE,
    ]
    .concat(),
    )
}

pub fn customer_recover() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_RECOVER].concat())
}

pub fn customer_reset() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_RESET].concat())
}

pub fn customer_reset_by_url() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_RESET_BY_URL].concat())
}

pub fn customer_activate() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_ACTIVATE].concat())
}

pub fn customer_activate_by_url() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_ACTIVATE_BY_URL].concat())
}

pub fn customer_address_create() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| {
        [
            ADDRESS_FRAGMENT,
            CUSTOMER_USER_ERROR_FRAGMENT,
            CUSTOMER_ADDRESS_CREATE,
        ]
        .concat()
    })
}

pub fn customer_address_update() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| {
        [
            ADDRESS_FRAGMENT,
            CUSTOMER_USER_ERROR_FRAGMENT,
            CUSTOMER_ADDRESS_UPDATE,
        ]
        .concat()
    })
}

pub fn customer_address_delete() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(|| [CUSTOMER_USER_ERROR_FRAGMENT, CUSTOMER_ADDRESS_DELETE].concat())
}

pub fn customer_default_address_update() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(
        || // CustomerFields/AddressFields don't reference MoneyV2, so MONEY_FRAGMENT
    // would be an unused fragment (validation error).
    [
        ADDRESS_FRAGMENT,
        CUSTOMER_FRAGMENT,
        CUSTOMER_USER_ERROR_FRAGMENT,
        CUSTOMER_DEFAULT_ADDRESS_UPDATE,
    ]
    .concat(),
    )
}

pub fn get_customer() -> &'static str {
    static Q: OnceLock<String> = OnceLock::new();
    Q.get_or_init(
        || // OrderFields references MoneyFields heavily, so MONEY_FRAGMENT is required here.
    [
        crate::storefront::fragments::MONEY_FRAGMENT,
        ADDRESS_FRAGMENT,
        ORDER_FRAGMENT,
        CUSTOMER_FRAGMENT,
        GET_CUSTOMER,
    ]
    .concat(),
    )
}