shopify_api 0.10.0

Shopify API client
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

# shopify_api

[![crates.io](https://img.shields.io/crates/v/shopify_api.svg)](https://crates.io/crates/shopify_api)
[![Documentation](https://docs.rs/shopify_api/badge.svg)](https://docs.rs/shopify_api)
[![MIT licensed](https://img.shields.io/crates/l/shopify_api.svg)](./LICENSE.txt)
[![CI](https://github.com/0xtlt/shopify_api/actions/workflows/ci.yml/badge.svg)](https://github.com/0xtlt/shopify_api/actions/workflows/ci.yml)

An ergonomic Shopify Admin GraphQL API client for Rust.

Version `0.10` is a breaking refactor for Shopify Admin API `2026-04` and newer:

- GraphQL-first client
- `2026-04` minimum API version
- static access tokens, client credentials tokens, and expiring offline tokens
- dynamic GraphQL schema download
- Bulk operations using the 2026 `bulkOperation(id:)` and `bulkOperations` APIs

## Install

```toml
[dependencies]
shopify_api = "0.10"
tokio = { version = "1", features = ["full"] }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
```

## Basic GraphQL

```rust,no_run
use serde::Deserialize;
use shopify_api::{Shopify, ShopifyAuth, ShopifyConfig};

#[derive(Deserialize)]
struct ShopQuery {
    shop: Shop,
}

#[derive(Deserialize)]
struct Shop {
    name: String,
}

#[tokio::main]
async fn main() -> Result<(), shopify_api::ShopifyAPIError> {
    let shopify = Shopify::new(
        "my-shop",
        ShopifyAuth::AccessToken("shpat_...".to_string()),
        ShopifyConfig::default(),
    )?;

    let data: ShopQuery = shopify
        .graphql(
            "query { shop { name } }",
            &serde_json::json!({}),
        )
        .await?;

    println!("{}", data.shop.name);
    Ok(())
}
```

## Client Credentials

```rust,ignore
use shopify_api::{Shopify, ShopifyAuth, ShopifyConfig};

let shopify = Shopify::new(
    "my-shop",
    ShopifyAuth::client_credentials("client_id", "client_secret"),
    ShopifyConfig::default(),
)?;
```

The crate acquires and refreshes 24-hour client-credentials tokens automatically. Add a `TokenStore` in `ShopifyConfig` when your app needs to persist refreshed token data.

## Dynamic GraphQL Schema

Public Shopify schema:

```rust,no_run
# async fn example() -> Result<(), shopify_api::ShopifyAPIError> {
let schema = shopify_api::download_public_admin_schema("2026-04").await?;
# Ok(())
# }
```

```bash
cargo install shopify_api --features cli
shopify-api schema download \
  --public \
  --api-version 2026-04 \
  --out graphql.schema.json
```

This uses Shopify's public schema proxy:

```txt
https://shopify.dev/admin-graphql-direct-proxy/2026-04
```

The proxy is a GraphQL endpoint for introspection requests, not a static `GET` file.

Runtime:

```rust,no_run
use shopify_api::{Shopify, ShopifyAuth, ShopifyConfig};

# async fn example() -> Result<(), shopify_api::ShopifyAPIError> {
let shopify = Shopify::new(
    "my-shop",
    ShopifyAuth::AccessToken("shpat_...".to_string()),
    ShopifyConfig::default(),
)?;
let schema = shopify.download_admin_schema().await?;
# Ok(())
# }
```

CLI:

```bash
cargo install shopify_api --features cli
shopify-api schema download \
  --shop my-shop \
  --access-token "$SHOPIFY_ACCESS_TOKEN" \
  --out shop.graphql.schema.json
```

The crate no longer ships built-in Shopify schema JSON files. Use the CLI output as the `schema_path` for `graphql_client`.

## Bulk Operations

```rust,no_run
use shopify_api::{BulkWaitOptions, Shopify, ShopifyAuth, ShopifyConfig};

# async fn example() -> Result<(), shopify_api::ShopifyAPIError> {
let shopify = Shopify::new(
    "my-shop",
    ShopifyAuth::AccessToken("shpat_...".to_string()),
    ShopifyConfig::default(),
)?;

let payload = shopify
    .run_bulk_query("{ products { edges { node { id title } } } }")
    .await?;

let operation = payload.bulk_operation.unwrap();
let operation = shopify
    .wait_for_bulk(&operation.id, BulkWaitOptions::default())
    .await?;

if let Some(url) = operation.url {
    let rows: Vec<serde_json::Value> = Shopify::download_bulk_jsonl(&url).await?;
    println!("{} rows", rows.len());
}
# Ok(())
# }
```

## Changelog

See [CHANGELOG.md](CHANGELOG.md).