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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Added gift cards to Storefront API
Damian Legawiecd13c98d2ed3f
diff --git a/docs/api-reference/storefront.yaml b/docs/api-reference/storefront.yamlindex 06b8863664..4dec76b05c 100644--- a/docs/api-reference/storefront.yaml+++ b/docs/api-reference/storefront.yaml@@ -8,15 +8,13 @@ info:version: 2.0.0title: Storefront APIdescription: |-- Storefront API is a modern REST API based on the [JSON API spec](https://jsonapi.org/) which provides you with all the necessary endpoints to build amazing user intefaces either in JavaScript frameworks or native mobile libraries.-- Download [official JavaScript & TypeScript SDK](https://github.com/spree/spree-storefront-api-v2-js-sdk)+ Storefront API is a modern REST API based on the [JSON API spec](https://jsonapi.org/) which provides you with all the necessary endpoints to build amazing user interfaces either in JavaScript frameworks or native mobile libraries.Import to [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml)contact:name: Vendo Connect Inc.- url: 'https://getvendo.com'- email: [email protected]+ url: 'https://spreecommerce.org'+ email: [email protected]license:name: AGPL-3.0-or-laterurl: 'https://github.com/spree/spree/blob/main/LICENSE.md'@@ -584,7 +582,7 @@ paths:- Cart / Other/api/v2/storefront/cart/apply_coupon_code:patch:- description: Applies a coupon code to the current cart.+ description: Applies a coupon code or gift card code to the current cart.operationId: apply-coupon-coderesponses:'200':@@ -607,18 +605,18 @@ paths:coupon_code:type: stringexample: DISCOUNT10- summary: Apply a Coupon Code+ summary: Apply a Coupon Code / Gift Cardtags:- Cart / Coupons'/api/v2/storefront/cart/remove_coupon_code/{coupon_code}':delete:- description: Removes a specified coupon code from the current cart.+ description: Removes a specified coupon code or gift card code from the current cart.operationId: remove-coupon-codeparameters:- name: coupon_codein: pathrequired: true- description: Specify the coupon code for removal.+ description: Specify the coupon code or gift card code for removal.schema:type: stringexample: DISCOUNT10@@ -632,7 +630,7 @@ paths:security:- orderToken: []- bearerAuth: []- summary: Remove a Coupon+ summary: Remove a Coupon / Gift Cardtags:- Cart / Coupons/api/v2/storefront/cart/remove_coupon_code:@@ -4035,7 +4033,7 @@ components:schema:type: stringdescription: 'Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes).'- example: 'line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions'+ example: 'line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions,gift_card'CartCurrencyParam:name: currencyin: querydiff --git a/docs/docs.json b/docs/docs.jsonindex 1da79b55fb..a06c00f2b3 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -246,6 +246,14 @@"api-reference/storefront/cart-line-items/remove-a-line-item"]},+ {+ "group": "Cart / Coupons & Gift Cards",+ "pages": [+ "api-reference/storefront/cart-coupons/apply-a-coupon-code",+ "api-reference/storefront/cart-coupons/remove-a-coupon",+ "api-reference/storefront/cart-coupons/remove-all-coupons"+ ]+ },{"group": "Cart / Other","pages": [@@ -255,14 +263,6 @@"api-reference/storefront/cart-other/change-cart-currency"]},- {- "group": "Cart / Coupons",- "pages": [- "api-reference/storefront/cart-coupons/apply-a-coupon-code",- "api-reference/storefront/cart-coupons/remove-a-coupon",- "api-reference/storefront/cart-coupons/remove-all-coupons"- ]- },{"group": "Checkout","pages": [