Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Removed redundant fulfillments list API endpoint

Damian Legawiec34be41cc0a7f
diff --git a/packages/next/.changeset/store-api-cleanup.md b/packages/next/.changeset/store-api-cleanup.md
new file mode 100644
index 0000000000..922dfa7657
--- /dev/null
+++ b/packages/next/.changeset/store-api-cleanup.md
@@ -0,0 +1,7 @@
+---
+"@spree/next": minor
+---
+
+**Breaking:** Removed `getFulfillments()` server action — fulfillments are included in the cart response. Use `cart.fulfillments` instead.
+
+Requires `@spree/sdk` >= 0.12.0.
diff --git a/packages/next/src/actions/cart.ts b/packages/next/src/actions/cart.ts
index 90aba69956..6b74c77148 100644
--- a/packages/next/src/actions/cart.ts
+++ b/packages/next/src/actions/cart.ts
@@ -1,7 +1,7 @@
'use server';
import { revalidateTag } from 'next/cache';
-import type { Cart, Order, Fulfillment, CreateCartParams, UpdateCartParams, ListResponse } from '@spree/sdk';
+import type { Cart, Order, CreateCartParams, UpdateCartParams } from '@spree/sdk';
import { getClient } from '../config';
import {
getCartToken, getCartId,
@@ -168,15 +168,6 @@ export async function updateCart(
return result;
}
-/**
- * Get fulfillments with delivery rates for the current cart.
- */
-export async function getFulfillments(): Promise<ListResponse<Fulfillment>> {
- const options = await getCartOptions();
- const cartId = await requireCartId();
- return getClient().carts.fulfillments.list(cartId, options);
-}
-
/**
* Select a delivery rate for a fulfillment.
* Returns the updated cart with recalculated totals.
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
index 15adf3eb76..4a4de50269 100644
--- a/packages/next/src/index.ts
+++ b/packages/next/src/index.ts
@@ -20,7 +20,6 @@ export {
clearCart,
associateCart,
updateCart,
- getFulfillments,
selectDeliveryRate,
applyCoupon,
removeCoupon,
diff --git a/packages/next/tests/actions/cart.test.ts b/packages/next/tests/actions/cart.test.ts
index a25aacada3..f310a6170f 100644
--- a/packages/next/tests/actions/cart.test.ts
+++ b/packages/next/tests/actions/cart.test.ts
@@ -17,7 +17,6 @@ const mockClient = {
delete: vi.fn(),
},
fulfillments: {
- list: vi.fn(),
update: vi.fn(),
},
couponCodes: {
@@ -33,7 +32,7 @@ vi.mock('@spree/sdk', () => ({
import {
getCart, getOrCreateCart, addItem, updateItem, removeItem, clearCart, associateCart,
- updateCart, getFulfillments, selectDeliveryRate, applyCoupon, removeCoupon, complete,
+ updateCart, selectDeliveryRate, applyCoupon, removeCoupon, complete,
} from '../../src/actions/cart';
import { revalidateTag } from 'next/cache';
@@ -253,25 +252,6 @@ describe('cart actions', () => {
});
});
- describe('getFulfillments', () => {
- it('returns fulfillments for the cart', async () => {
- const mockFulfillments = { data: [{ id: 'ful_1', delivery_rates: [] }] };
- mockCookies({
- '_spree_cart_token': 'order_token',
- '_spree_cart_token_id': 'cart_1',
- '_spree_jwt': 'jwt_token',
- });
- mockClient.carts.fulfillments.list.mockResolvedValue(mockFulfillments);
-
- const result = await getFulfillments();
- expect(result).toEqual(mockFulfillments);
- expect(mockClient.carts.fulfillments.list).toHaveBeenCalledWith(
- 'cart_1',
- { spreeToken: 'order_token', token: 'jwt_token' }
- );
- });
- });
-
describe('selectDeliveryRate', () => {
it('selects delivery rate and revalidates', async () => {
const updatedCart = { id: 'cart_1', delivery_total: '10.0' };
diff --git a/packages/sdk/.changeset/store-api-cleanup.md b/packages/sdk/.changeset/store-api-cleanup.md
index 322a5df3c5..dcbb6116d4 100644
--- a/packages/sdk/.changeset/store-api-cleanup.md
+++ b/packages/sdk/.changeset/store-api-cleanup.md
@@ -5,6 +5,6 @@
**Breaking:** Store API endpoint changes requiring backend >= 5.4.0.rc2:
- **Default address:** Removed `markAsDefault()` method. Use `is_default_billing` / `is_default_shipping` booleans on `create()` and `update()` instead (Medusa/Vendure pattern)
-- **Removed redundant endpoints:** `carts.paymentMethods.list()`, `carts.payments.list()`, `carts.payments.get()` — payment methods and payments are included in the cart response
+- **Removed redundant endpoints:** `carts.paymentMethods.list()`, `carts.payments.list()`, `carts.payments.get()`, `carts.fulfillments.list()` — payment methods, payments, and fulfillments are included in the cart response
- **`AddressParams`** now includes `is_default_billing` and `is_default_shipping` fields
- **Address response** now includes `is_default_billing` and `is_default_shipping` fields
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index 64f02d846c..8e3e344d6b 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -270,9 +270,7 @@ await client.carts.couponCodes.remove('cart_xxx', 'SAVE20', options);
```typescript
const options = { spreeToken: cart.token };
-// List fulfillments for the cart
-const fulfillments = await client.carts.fulfillments.list('cart_xxx', options);
-
+// Fulfillments are included in the cart response.
// Select a delivery rate
await client.carts.fulfillments.update('cart_xxx', fulfillmentId, {
selected_delivery_rate_id: 'rate_xxx',
@@ -551,7 +549,7 @@ The SDK uses a resource builder pattern for nested resources:
|-----------------|-----------------|-------------------|
| `carts` | `items` | `create`, `update`, `delete` |
| `carts` | `couponCodes` | `apply`, `remove` |
-| `carts` | `fulfillments` | `list`, `update` |
+| `carts` | `fulfillments` | `update` |
| `carts` | `payments` | `create` |
| `carts` | `paymentSessions` | `create`, `get`, `update`, `complete` |
| `carts` | `storeCredits` | `apply`, `remove` |
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index 7c1299fcd8..204b6b6c09 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -40,7 +40,6 @@ import type {
Payment,
PaymentSession,
PaymentSetupSession,
- Fulfillment,
Wishlist,
WishlistItem,
Address,
@@ -445,17 +444,6 @@ export class StoreClient {
* Nested resource: Fulfillments
*/
fulfillments: {
- /**
- * List fulfillments with delivery rates for the cart
- * @param cartId - Cart prefixed ID
- */
- list: (cartId: string, options?: RequestOptions): Promise<ListResponse<Fulfillment>> =>
- this.request<ListResponse<Fulfillment>>(
- 'GET',
- `/carts/${cartId}/fulfillments`,
- options
- ),
-
/**
* Select a delivery rate for a specific fulfillment.
* Returns the updated cart with recalculated totals.
diff --git a/packages/sdk/tests/cart.test.ts b/packages/sdk/tests/cart.test.ts
index 21c1593335..e5e6d3ae81 100644
--- a/packages/sdk/tests/cart.test.ts
+++ b/packages/sdk/tests/cart.test.ts
@@ -113,11 +113,6 @@ describe('carts', () => {
});
describe('fulfillments', () => {
- it('lists fulfillments', async () => {
- const result = await client.carts.fulfillments.list('cart_1', opts);
- expect(result.data).toBeDefined();
- });
-
it('selects a delivery rate', async () => {
const result = await client.carts.fulfillments.update(
'cart_1',
diff --git a/packages/sdk/tests/mocks/handlers.ts b/packages/sdk/tests/mocks/handlers.ts
index b1e1df342d..068b3bd144 100644
--- a/packages/sdk/tests/mocks/handlers.ts
+++ b/packages/sdk/tests/mocks/handlers.ts
@@ -252,10 +252,6 @@ export const handlers = [
),
// Carts > Fulfillments
- http.get(`${API_PREFIX}/carts/:cartId/fulfillments`, () =>
- HttpResponse.json({ data: [], meta: { count: 0 } })
- ),
-
http.patch(`${API_PREFIX}/carts/:cartId/fulfillments/:id`, () =>
HttpResponse.json(fixtures.cart)
),
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index a2395d4aa5..367d055a17 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -39,7 +39,7 @@ Spree::Core::Engine.add_routes do
end
resources :items, only: [:create, :update, :destroy], controller: 'carts/items'
resources :coupon_codes, only: [:create, :destroy], controller: 'carts/coupon_codes'
- resources :fulfillments, only: [:index, :update], controller: 'carts/fulfillments'
+ resources :fulfillments, only: [:update], controller: 'carts/fulfillments'
resources :payments, only: [:create], controller: 'carts/payments'
resources :payment_sessions, only: [:create, :show, :update], controller: 'carts/payment_sessions' do
member do
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
index 88da753423..805f7f2462 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/carts/fulfillments_controller_spec.rb
@@ -19,41 +19,6 @@ RSpec.describe Spree::Api::V3::Store::Carts::FulfillmentsController, type: :cont
request.headers['Authorization'] = "Bearer #{jwt_token}"
end
- describe 'GET #index' do
- it 'returns a list of fulfillments for the cart' do
- get :index, params: { cart_id: order.prefixed_id }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['data'].size).to eq(order.shipments.count)
- expect(json_response['data'].first['id']).to eq(fulfillment.prefixed_id)
- end
-
- context 'with spree token (guest)' do
- let(:guest_order) do
- create(:order_with_line_items, user: nil, store: store, state: 'delivery').tap do |o|
- o.create_proposed_shipments
- o.reload
- end
- end
-
- before { request.headers['Authorization'] = nil }
-
- it 'returns fulfillments with valid spree token' do
- request.headers['x-spree-token'] = guest_order.token
- get :index, params: { cart_id: guest_order.prefixed_id }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['data']).to be_present
- end
-
- it 'returns forbidden without spree token' do
- get :index, params: { cart_id: guest_order.prefixed_id }
-
- expect(response).to have_http_status(:forbidden)
- end
- end
- end
-
describe 'PATCH #update' do
context 'when selecting a different delivery rate' do
let(:cheaper_shipping_method) { create(:shipping_method, name: 'Cheap Shipping') }
diff --git a/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb b/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
index 73fed10040..0003353d69 100644
--- a/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/fulfillments_spec.rb
@@ -9,37 +9,6 @@ RSpec.describe 'Cart Fulfillments API', type: :request, swagger_doc: 'api-refere
let!(:fulfillment) { order.shipments.first }
let(:cart_id) { order.prefixed_id }
- path '/api/v3/store/carts/{cart_id}/fulfillments' do
- get 'List fulfillments' do
- tags 'Carts'
- produces 'application/json'
- security [api_key: [], bearer_auth: []]
- description 'Returns all fulfillments with delivery rates for the cart.'
-
- sdk_example <<~JS
- const fulfillments = await client.carts.fulfillments.list('cart_abc123', {
- bearerToken: '<token>',
- })
- JS
-
- parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: 'Authorization', in: :header, type: :string, required: false
- parameter name: :cart_id, in: :path, type: :string, required: true, description: 'Cart prefixed ID (e.g., cart_abc123)'
- parameter name: 'x-spree-token', in: :header, type: :string, required: false, description: 'Order token for guest access'
-
- response '200', 'fulfillments found' do
- let(:'x-spree-api-key') { api_key.token }
- let(:'Authorization') { "Bearer #{jwt_token}" }
-
- run_test! do |response|
- data = JSON.parse(response.body)
- expect(data['data']).to be_an(Array)
- expect(data['data'].size).to be >= 1
- end
- end
- end
- end
-
path '/api/v3/store/carts/{cart_id}/fulfillments/{id}' do
patch 'Select delivery rate for fulfillment' do
tags 'Carts'