Skip to content

Commit c86e0ca

Browse files
lizkenyonlizkenyon
committed
Preparing for release 16.1.0
1 parent 4918102 commit c86e0ca

File tree

6 files changed

+204
-2
lines changed

6 files changed

+204
-2
lines changed

‎.DS_Store‎

8 KB
Binary file not shown.

‎.bundle/config‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
BUNDLE_BUILD__OPENSSL: "--with-openssl-dir=/opt/homebrew/opt/openssl@3.0"

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Note: For changes to the API, see https://shopify.dev/changelog?filter=api
44
## Unreleased
5+
6+
## 16.1.0 (2026-01-15)
57
- Add support for 2026-01 API version
68

79
## 16.0.0 (2025-12-10)

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
shopify_api (16.0.0)
4+
shopify_api (16.1.0)
55
activesupport
66
concurrent-ruby
77
hash_diff

‎api-verision-differences.md‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
# Shopify Admin REST API: 2025-07 to 2025-10 Version Differences
2+
3+
## Executive Summary
4+
5+
The Shopify Admin REST API version 2025-10 represents a significant cleanup release that removes 6 deprecated resources from the API. This is primarily a **breaking change release** focused on removing legacy endpoints rather than introducing new features.
6+
7+
**Key Changes:**
8+
- ❌ **6 resources completely removed**
9+
- ✅ **0 new resources added**
10+
- 🔄 **All remaining resources updated with version numbers only**
11+
- ⚠️ **Breaking changes require migration**
12+
13+
---
14+
15+
## 🗑️ Resources Removed in 2025-10
16+
17+
The following resources are **completely removed** and will no longer be available:
18+
19+
### 1. Access Scope Management
20+
| Resource | File | Impact |
21+
|----------|------|---------|
22+
| **AccessScope** | `access/_accessscope.open-api.json` | Apps can no longer query granted access scopes via REST API |
23+
24+
**Description:** The AccessScope resource allowed apps to retrieve permissions granted by merchants (e.g., `read_orders`, `write_products`).
25+
26+
**Migration:** Apps should use alternative methods for managing and verifying access scopes.
27+
28+
---
29+
30+
### 2. Legacy Product Management (Already Deprecated)
31+
| Resource | File | Impact |
32+
|----------|------|---------|
33+
| **Product** | `products/_product.open-api.json` | Product CRUD operations no longer available |
34+
| **ProductImage** | `products/_product-image.open-api.json` | Product image management no longer available |
35+
36+
**Description:** These endpoints were already deprecated since REST API 2024-04 as part of Shopify's migration to the new product model.
37+
38+
**Migration:** Use the [new product model APIs](https://shopify.dev/docs/api/admin/migrate/new-product-model) through GraphQL Admin API or updated REST endpoints.
39+
40+
---
41+
42+
### 3. Legacy Discount System
43+
| Resource | File | Impact |
44+
|----------|------|---------|
45+
| **PriceRule** | `discounts/_pricerule.open-api.json` | Legacy discount rules no longer manageable |
46+
47+
**Description:** The PriceRule resource was part of the legacy discount system for creating and managing discount codes and automatic discounts.
48+
49+
**Migration:** Use modern discount APIs through GraphQL Admin API or updated REST discount endpoints.
50+
51+
---
52+
53+
### 4. Sales Channel Management
54+
| Resource | File | Impact |
55+
|----------|------|---------|
56+
| **ProductListing** | `sales-channels/_productlisting.open-api.json` | Product listing management for sales channels removed |
57+
| **ProductResourceFeedback** | `sales-channels/_productresourcefeedback.open-api.json` | Product resource feedback system removed |
58+
59+
**Description:** These endpoints managed product listings and feedback for sales channel applications.
60+
61+
**Migration:** Use alternative sales channel management approaches or GraphQL equivalents.
62+
63+
---
64+
65+
## 📊 Impact Analysis
66+
67+
### Directory Structure Changes
68+
- ✅ **No changes** - All functional areas (access, billing, customers, etc.) remain the same
69+
- ✅ **Same organization** - Directory hierarchy unchanged
70+
71+
### File Count Changes
72+
```
73+
2025-07: 67 schema files
74+
2025-10: 61 schema files
75+
Difference: -6 files (9% reduction)
76+
```
77+
78+
### Breaking Changes Summary
79+
| Category | 2025-07 | 2025-10 | Change |
80+
|----------|---------|---------|---------|
81+
| **Access Management** | 2 files | 1 file | -1 (AccessScope removed) |
82+
| **Product Management** | 7 files | 5 files | -2 (Product, ProductImage removed) |
83+
| **Discount Management** | 2 files | 1 file | -1 (PriceRule removed) |
84+
| **Sales Channels** | 6 files | 4 files | -2 (ProductListing, ProductResourceFeedback removed) |
85+
| **Other Categories** | 50 files | 50 files | No change |
86+
87+
---
88+
89+
## 🛠️ Migration Recommendations
90+
91+
### Immediate Actions Required
92+
93+
1. **Audit Current API Usage**
94+
```bash
95+
# Search codebase for removed endpoints
96+
grep -r "access_scopes" your-app/
97+
grep -r "/products\.json" your-app/
98+
grep -r "price_rules" your-app/
99+
grep -r "product_listings" your-app/
100+
```
101+
102+
2. **Update API Version References**
103+
```javascript
104+
// Before (2025-07)
105+
const apiUrl = 'https://shop.myshopify.com/admin/api/2025-07/';
106+
107+
// After (2025-10) - Only after migration complete
108+
const apiUrl = 'https://shop.myshopify.com/admin/api/2025-10/';
109+
```
110+
111+
### Migration Pathways
112+
113+
#### For Product Management
114+
- **Use GraphQL Admin API** for product operations
115+
- **Use Shopify CLI** for product model migration
116+
- **Review new product model documentation**
117+
118+
#### For Discount Management
119+
- **Migrate to GraphQL** discount mutations
120+
- **Use Shopify Functions** for advanced discount logic
121+
- **Review modern discount documentation**
122+
123+
#### For Access Scope Management
124+
- **Use OAuth flow** for scope verification
125+
- **Implement client-side scope tracking**
126+
- **Use Shopify Partner Dashboard** for app permissions
127+
128+
### Testing Strategy
129+
130+
1. **Create test environment** with 2025-10 API version
131+
2. **Run integration tests** to identify breaking changes
132+
3. **Monitor API responses** for removed endpoint errors
133+
4. **Validate alternative endpoints** work as expected
134+
135+
---
136+
137+
## 📋 Complete File Comparison
138+
139+
### Files Present Only in 2025-07 (Removed in 2025-10)
140+
```
141+
access/_accessscope.open-api.json
142+
discounts/_pricerule.open-api.json
143+
products/_product.open-api.json
144+
products/_product-image.open-api.json
145+
sales-channels/_productlisting.open-api.json
146+
sales-channels/_productresourcefeedback.open-api.json
147+
```
148+
149+
### Files Present in Both Versions (Version-Only Changes)
150+
All remaining 61 files exist in both versions with identical content except for version numbers:
151+
- `"version": "2025-07"` → `"version": "2025-10"`
152+
- No functional endpoint changes
153+
- No new parameters or response modifications
154+
155+
### Files Present Only in 2025-10 (New Additions)
156+
```
157+
None - No new resources added
158+
```
159+
160+
---
161+
162+
## ⚠️ Important Considerations
163+
164+
### Backward Compatibility
165+
- **No backward compatibility** for removed endpoints
166+
- **Existing apps will break** if they use removed resources
167+
- **Migration is mandatory** before upgrading to 2025-10
168+
169+
### Timeline Considerations
170+
- **Test thoroughly** before upgrading production systems
171+
- **Coordinate with stakeholders** about breaking changes
172+
- **Have rollback plan** ready during migration
173+
- **Monitor API usage** after migration
174+
175+
### Support Resources
176+
- [Shopify API Versioning Guide](https://shopify.dev/api/usage/versioning)
177+
- [New Product Model Migration](https://shopify.dev/docs/api/admin/migrate/new-product-model)
178+
- [GraphQL Admin API Documentation](https://shopify.dev/api/admin-graphql)
179+
- [Shopify Developer Community](https://community.shopify.com/c/shopify-developers/ct-p/developers)
180+
181+
---
182+
183+
## 🏁 Conclusion
184+
185+
The 2025-10 release represents Shopify's continued effort to modernize and streamline the Admin REST API by removing deprecated functionality. While this creates short-term migration work, it results in a cleaner, more maintainable API surface.
186+
187+
**Next Steps:**
188+
1. Audit your current API usage against the removed endpoints
189+
2. Plan migration timeline with your development team
190+
3. Test extensively in development environment
191+
4. Update to 2025-10 only after successful migration
192+
5. Monitor application performance post-migration
193+
194+
---
195+
196+
*Document generated on: $(date)*
197+
*API Schema Location: `/db/schemas/admin_rest/`*
198+
*Analysis performed on: Shopify Developer Repository*

‎lib/shopify_api/version.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
# frozen_string_literal: true
33

44
module ShopifyAPI
5-
VERSION = "16.0.0"
5+
VERSION = "16.1.0"
66
end

0 commit comments

Comments
 (0)