shopify-client 0.19.0

Modular Shopify library for Rust: API client, type-safe models, and webhook parsing utilities
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
use crate::{
    common::{
        http::execute_graphql,
        types::{APIError, RequestCallbacks},
    },
    types::bulk_operation::{
        CancelResp, GetBulkOperationResp, ListBulkOperationsParams, ListBulkOperationsResp,
        RunMutationResp, RunQueryResp, StagedUploadInput, StagedUploadsCreateResp,
    },
};
use serde_json::json;

// region: Core Operations

pub async fn run_query(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    query_string: &str,
    group_objects: Option<bool>,
) -> Result<RunQueryResp, APIError> {
    let query = r#"
        mutation bulkOperationRunQuery($query: String!) {
            bulkOperationRunQuery(query: $query) {
                bulkOperation {
                    id
                    status
                    errorCode
                    createdAt
                    objectCount
                    rootObjectCount
                    url
                    query
                    type
                }
                userErrors {
                    code
                    field
                    message
                }
            }
        }
    "#
    .to_string();

    let mut query_with_group = query_string.to_string();
    if let Some(true) = group_objects {
        // Wrap the query to enable object grouping if not already present
        if !query_with_group.contains("groupObjects") {
            query_with_group = query_string.to_string();
        }
    }

    let variables = json!({
        "query": query_with_group
    });

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

pub async fn run_mutation(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    mutation: &str,
    staged_upload_path: &str,
    client_identifier: Option<&str>,
) -> Result<RunMutationResp, APIError> {
    let query = r#"
        mutation bulkOperationRunMutation($mutation: String!, $stagedUploadPath: String!, $clientIdentifier: String) {
            bulkOperationRunMutation(mutation: $mutation, stagedUploadPath: $stagedUploadPath, clientIdentifier: $clientIdentifier) {
                bulkOperation {
                    id
                    status
                    errorCode
                    createdAt
                    objectCount
                    rootObjectCount
                    url
                    type
                }
                userErrors {
                    code
                    field
                    message
                }
            }
        }
    "#
    .to_string();

    let variables = json!({
        "mutation": mutation,
        "stagedUploadPath": staged_upload_path,
        "clientIdentifier": client_identifier
    });

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

pub async fn cancel(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    id: &str,
) -> Result<CancelResp, APIError> {
    let query = r#"
        mutation bulkOperationCancel($id: ID!) {
            bulkOperationCancel(id: $id) {
                bulkOperation {
                    id
                    status
                    errorCode
                }
                userErrors {
                    field
                    message
                }
            }
        }
    "#
    .to_string();

    let variables = json!({ "id": id });

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

pub async fn get(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    id: &str,
) -> Result<GetBulkOperationResp, APIError> {
    let query = format!(
        r#"
        query {{
            node(id: "{}") {{
                ... on BulkOperation {{
                    id
                    status
                    errorCode
                    createdAt
                    completedAt
                    objectCount
                    rootObjectCount
                    fileSize
                    url
                    partialDataUrl
                    query
                    type
                }}
            }}
        }}
    "#,
        id
    );

    let variables = json!({});

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

pub async fn list(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    params: &ListBulkOperationsParams,
) -> Result<ListBulkOperationsResp, APIError> {
    let mut args = Vec::new();

    if let Some(first) = params.first {
        args.push(format!("first: {}", first));
    }
    if let Some(after) = &params.after {
        args.push(format!("after: \"{}\"", after));
    }
    if let Some(last) = params.last {
        args.push(format!("last: {}", last));
    }
    if let Some(before) = &params.before {
        args.push(format!("before: \"{}\"", before));
    }
    if let Some(reverse) = params.reverse {
        args.push(format!("reverse: {}", reverse));
    }
    if let Some(sort_key) = &params.sort_key {
        let key_str = serde_json::to_string(sort_key).unwrap_or_default();
        args.push(format!("sortKey: {}", key_str.trim_matches('"')));
    }

    let mut query_filters = Vec::new();
    if let Some(status) = &params.status {
        let status_str = serde_json::to_string(status).unwrap_or_default();
        query_filters.push(format!("status:{}", status_str.trim_matches('"')));
    }
    if let Some(op_type) = &params.operation_type {
        let type_str = serde_json::to_string(op_type).unwrap_or_default();
        query_filters.push(format!("type:{}", type_str.trim_matches('"')));
    }
    if !query_filters.is_empty() {
        args.push(format!("query: \"{}\"", query_filters.join(" ")));
    }

    let args_str = if args.is_empty() {
        String::new()
    } else {
        format!("({})", args.join(", "))
    };

    let query = format!(
        r#"
        query {{
            bulkOperations{} {{
                nodes {{
                    id
                    status
                    errorCode
                    createdAt
                    completedAt
                    objectCount
                    rootObjectCount
                    fileSize
                    url
                    query
                    type
                }}
                pageInfo {{
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                }}
            }}
        }}
    "#,
        args_str
    );

    let variables = json!({});

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

pub async fn create_staged_upload(
    shop_url: &String,
    version: &String,
    access_token: &String,
    callbacks: &RequestCallbacks,
    input: &[StagedUploadInput],
) -> Result<StagedUploadsCreateResp, APIError> {
    let query = r#"
        mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
            stagedUploadsCreate(input: $input) {
                stagedTargets {
                    url
                    resourceUrl
                    parameters {
                        name
                        value
                    }
                }
                userErrors {
                    field
                    message
                }
            }
        }
    "#
    .to_string();

    let variables = json!({ "input": input });

    execute_graphql(shop_url, version, access_token, callbacks, query, variables).await
}

// endregion

// region: Export Template Queries

fn build_export_query(resource: &str, query_body: &str, filter: Option<&str>) -> String {
    let mut args = Vec::new();

    if resource == "inventoryItems" {
        args.push("first: 1".to_string());
    }
    if let Some(f) = filter {
        args.push(format!("query: \"{}\"", f));
    }

    let args_str = if args.is_empty() {
        String::new()
    } else {
        format!("({})", args.join(", "))
    };

    format!(
        r#"{{
  {}{} {{
    edges {{
      node {{
        {}
      }}
    }}
  }}
}}"#,
        resource, args_str, query_body
    )
}

pub fn products_query(filter: Option<&str>) -> String {
    let body = r#"id
        title
        handle
        descriptionHtml
        status
        vendor
        productType
        tags
        isGiftCard
        hasOnlyDefaultVariant
        templateSuffix
        onlineStoreUrl
        createdAt
        updatedAt
        publishedAt
        seo {
          title
          description
        }
        priceRangeV2 {
          minVariantPrice {
            amount
            currencyCode
          }
          maxVariantPrice {
            amount
            currencyCode
          }
        }
        options {
          id
          name
          values
        }
        category {
          id
          name
          fullName
          isLeaf
          isRoot
          isArchived
          level
          parentId
          ancestorIds
          childrenIds
        }
        featuredMedia {
          preview {
            image {
              url
              altText
              width
              height
            }
          }
        }
        variants {
          edges {
            node {
              id
              title
              sku
              price
              compareAtPrice
              barcode
              position
              inventoryQuantity
              taxable
              taxCode
              availableForSale
              selectedOptions {
                name
                value
              }
              inventoryItem {
                id
                tracked
                requiresShipping
                unitCost {
                  amount
                  currencyCode
                }
              }
              image {
                url
                altText
                width
                height
              }
            }
          }
        }
        media {
          edges {
            node {
              mediaContentType
              status
              alt
              preview {
                image {
                  url
                  altText
                  width
                  height
                }
              }
              ... on MediaImage {
                id
                mimeType
                image {
                  url
                  altText
                  width
                  height
                }
              }
              ... on Video {
                id
                filename
                sources {
                  url
                  format
                  width
                  height
                  mimeType
                }
              }
              ... on ExternalVideo {
                id
                embedUrl
                host
              }
              ... on Model3d {
                id
                filename
                originalSource {
                  url
                  format
                  filesize
                }
              }
            }
          }
        }"#;

    build_export_query("products", body, filter)
}

pub fn orders_query(filter: Option<&str>) -> String {
    let body = r#"id
        name
        email
        phone
        note
        tags
        displayFinancialStatus
        displayFulfillmentStatus
        cancelledAt
        cancelReason
        closedAt
        createdAt
        updatedAt
        processedAt
        test
        confirmed
        taxesIncluded
        currencyCode
        presentmentCurrencyCode
        subtotalPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalDiscountsSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalTaxSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalShippingPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalRefundedSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalWeight
        customer {
          id
          email
          firstName
          lastName
        }
        shippingAddress {
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
          latitude longitude
        }
        billingAddress {
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
          latitude longitude
        }
        sourceName
        fulfillable
        requiresShipping
        riskLevel
        discountCodes
        lineItems {
          edges {
            node {
              id
              title
              name
              sku
              quantity
              variantTitle
              vendor
              product { id }
              variant { id }
              originalUnitPriceSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              discountedUnitPriceSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              discountedTotalSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              totalDiscountSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              taxLines {
                title
                rate
                ratePercentage
                priceSet {
                  shopMoney { amount currencyCode }
                  presentmentMoney { amount currencyCode }
                }
              }
              requiresShipping
              taxable
              fulfillableQuantity
              fulfillmentStatus
              customAttributes { key value }
              duties {
                id
                harmonizedSystemCode
                price {
                  shopMoney { amount currencyCode }
                  presentmentMoney { amount currencyCode }
                }
                taxLines {
                  title rate ratePercentage
                  priceSet {
                    shopMoney { amount currencyCode }
                    presentmentMoney { amount currencyCode }
                  }
                }
              }
            }
          }
        }"#;

    build_export_query("orders", body, filter)
}

pub fn collections_query(filter: Option<&str>) -> String {
    let body = r#"id
        title
        handle
        descriptionHtml
        sortOrder
        templateSuffix
        productsCount {
          count
          precision
        }
        updatedAt
        seo {
          title
          description
        }
        image {
          url
          altText
          width
          height
        }
        products {
          edges {
            node {
              id
              title
              handle
              status
              vendor
              productType
            }
          }
        }"#;

    build_export_query("collections", body, filter)
}

pub fn customers_query(filter: Option<&str>) -> String {
    let body = r#"id
        defaultEmailAddress {
          emailAddress
        }
        firstName
        lastName
        displayName
        defaultPhoneNumber {
          phoneNumber
        }
        note
        tags
        state
        taxExempt
        verifiedEmail
        locale
        numberOfOrders
        amountSpent {
          amount
          currencyCode
        }
        createdAt
        updatedAt
        defaultAddress {
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
          latitude longitude
        }
        image {
          url
          altText
          width
          height
        }
        addresses {
          id
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
        }"#;

    build_export_query("customers", body, filter)
}

pub fn inventory_items_query(filter: Option<&str>) -> String {
    let body = r#"id
        sku
        tracked
        requiresShipping
        countryCodeOfOrigin
        provinceCodeOfOrigin
        harmonizedSystemCode
        createdAt
        updatedAt
        unitCost {
          amount
          currencyCode
        }
        inventoryLevels {
          edges {
            node {
              id
              quantities(names: ["available"]) {
                name
                quantity
              }
              location {
                id
                name
              }
              updatedAt
            }
          }
        }"#;

    build_export_query("inventoryItems", body, filter)
}

pub fn draft_orders_query(filter: Option<&str>) -> String {
    let body = r#"id
        name
        email
        phone
        note2
        tags
        status
        currencyCode
        taxExempt
        taxesIncluded
        createdAt
        updatedAt
        completedAt
        invoiceSentAt
        subtotalPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalTaxSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalDiscountsSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        totalShippingPriceSet {
          shopMoney { amount currencyCode }
          presentmentMoney { amount currencyCode }
        }
        customer {
          id
          email
          firstName
          lastName
        }
        shippingAddress {
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
          latitude longitude
        }
        billingAddress {
          address1 address2 city province provinceCode
          country countryCodeV2 zip phone
          firstName lastName company name
          latitude longitude
        }
        order { id }
        lineItems {
          edges {
            node {
              id
              title
              name
              sku
              quantity
              variantTitle
              vendor
              product { id }
              variant { id }
              originalUnitPriceSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              discountedUnitPriceSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              discountedTotalSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              totalDiscountSet {
                shopMoney { amount currencyCode }
                presentmentMoney { amount currencyCode }
              }
              requiresShipping
              taxable
              customAttributes { key value }
            }
          }
        }"#;

    build_export_query("draftOrders", body, filter)
}

// endregion