spree_api 4.4.1 → 4.5.0

data/docs/v2/storefront/index.yaml

@@ -57,6 +57,12 @@ paths:
                     email:
                       type: string
                       example: john@snow.org
+                    first_name:
+                      type: string
+                      example: John
+                    last_name:
+                      type: string
+                      example: Snow
                     password:
                       type: string
                       example: spree123
@@ -66,7 +72,7 @@ paths:
                     public_metadata:
                       type: object
                       example:
-                        user_segment: 'supplier'
+                        user_segment: supplier
                       description: The public metadata for this User
                     private_metadata:
                       type: object
@@ -98,6 +104,12 @@ paths:
                     email:
                       type: string
                       example: john@snow.org
+                    first_name:
+                      type: string
+                      example: John
+                    last_name:
+                      type: string
+                      example: Snow
                     bill_address_id:
                       type: string
                       example: '1'
@@ -387,10 +399,10 @@ paths:
               properties:
                 public_metadata:
                   type: object
-                  description: 'The public metadata for the cart.'
+                  description: The public metadata for the cart.
                 private_metadata:
                   type: object
-                  description: 'The private metadata for the cart.'
+                  description: The private metadata for the cart.
       summary: Create a Cart
     delete:
       description: |-
@@ -425,6 +437,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/CartIncludeParam'
         - $ref: '#/components/parameters/SparseFieldsCart'
+        - $ref: '#/components/parameters/CartCurrencyParam'
       summary: Retrieve a Cart
   /api/v2/storefront/cart/add_item:
     post:
@@ -461,10 +474,10 @@ paths:
                   type: integer
                 public_metadata:
                   type: object
-                  description: 'The public metadata for the added item.'
+                  description: The public metadata for the added item.
                 private_metadata:
                   type: object
-                  description: 'The private metadata for the added item.'
+                  description: The private metadata for the added item.
                 options:
                   type: object
                   description: 'Additional custom options. Activate these by adding: `Spree::PermittedAttributes.line_item_attributes << :foo` in `config/initializers/spree.rb`'
@@ -936,7 +949,7 @@ paths:
                   description: ID of the selected Shipping Method
                 shipment_id:
                   type: string
-                  description: 'ID of the selected Shipment. If not supplied it will try to set selected shipping method for all shipments'
+                  description: ID of the selected Shipment. If not supplied it will try to set selected shipping method for all shipments
               required:
                 - shipping_method_id
             examples:
@@ -1249,6 +1262,23 @@ paths:
         '404':
           $ref: '#/components/responses/404NotFound'
       summary: Retrieve a Product
+  /api/v2/storefront/store:
+    get:
+      summary: Return the current Store
+      description: 'Returns the current Store. [Read more about Stores](https://dev-docs.spreecommerce.org/internals/stores)'
+      tags:
+        - Stores
+      operationId: show-current-store
+      parameters:
+        - $ref: '#/components/parameters/StoreIncludeParam'
+        - $ref: '#/components/parameters/SparseFieldsStore'
+      responses:
+        '200':
+          $ref: '#/components/responses/Store'
+        '403':
+          $ref: '#/components/responses/403Forbidden'
+      security:
+        - bearerAuth: []
   /api/v2/storefront/taxons:
     get:
       description: 'Returns a list of Taxons. [Read more about Taxons](https://dev-docs.spreecommerce.org/internals/products#taxons-and-taxonomies)'
@@ -2423,14 +2453,14 @@ components:
               type: boolean
               example: true
               description: Defines if this is the default CC for a signed in user
-          relationships:
-            type: object
-            properties:
-              payment_method:
-                type: object
-                properties:
-                  data:
-                    $ref: '#/components/schemas/Relation'
+        relationships:
+          type: object
+          properties:
+            payment_method:
+              type: object
+              properties:
+                data:
+                  $ref: '#/components/schemas/Relation'
       required:
         - id
         - type
@@ -2638,7 +2668,7 @@ components:
               type: object
               example:
                 recommended_by_us: true
-              description: 'The public metadata for the Line Item.'
+              description: The public metadata for the Line Item.
         relationships:
           type: object
           properties:
@@ -3055,6 +3085,13 @@ components:
         - $ref: '#/components/schemas/Variant'
         - $ref: '#/components/schemas/Image'
         - $ref: '#/components/schemas/Taxon'
+    StoreIncludes:
+      x-internal: true
+      title: Store Includes
+      anyOf:
+        - $ref: '#/components/schemas/Country'
+        - $ref: '#/components/schemas/Menu'
+        - $ref: '#/components/schemas/CmsPage'
     ProductProperty:
       title: Product Property
       type: object
@@ -3145,6 +3182,122 @@ components:
           example: New York
           description: State name
       x-internal: true
+    Store:
+      type: object
+      description: Stores are the center of the Spree ecosystem. Each Spree installation can have multiple Stores. Each Store operates on a different domain or subdomain.
+      title: Store
+      x-internal: true
+      properties:
+        id:
+          type: string
+          example: '1'
+        type:
+          type: string
+          default: store
+        attributes:
+          type: object
+          properties:
+            name:
+              type: string
+              example: Spree Demo
+              description: Name of the Store
+            url:
+              type: string
+              example: spree-demo.com
+              description: Store Url
+            meta_description:
+              type: string
+              example: Luxury clothing store for men and women.
+              description: Meta description for SEO
+            meta_keywords:
+              type: string
+              example: luxury clothing men women
+              description: Meta keywords for SEO
+            seo_title:
+              type: string
+              example: Buy Luxury Clothing With Ease
+              description: The title for SEO
+            default_currency:
+              type: string
+              example: EUR
+              description: Default currency of the store
+            default:
+              type: boolean
+              example: true
+              description: Indicates if the Store is the default one
+            supported_currencies:
+              type: string
+              example: 'EUR,USD,GBP'
+              description: All currencies supported by store
+            facebook:
+              type: string
+              example: 'https://www.facebook.com/mystorename'
+              description: URL of Facebook page
+            twitter:
+              type: string
+              example: 'https://twitter.com/mystorename'
+              description: URL of Twitter page
+            instagram:
+              type: string
+              example: 'https://instagram.com/mystorename'
+              description: URL of Instagram page
+            default_locale:
+              type: string
+              example: en
+              description: Default locale of the Store
+            supported_locales:
+              type: string
+              example: 'en,es,de'
+              description: Supported locales of the Store
+            customer_support_email:
+              type: string
+              example: support@mystore.com
+              description: This email is visible to your Store visitors in the Footer section
+            description:
+              type: string
+              example: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
+              description: Description of the Store which is visible in the Footer
+            address:
+              type: string
+              example: '813 Howard Street, Oswego NY 13126, USA'
+              description: Address of the Store which is visible in the Footer
+            contact_phone:
+              type: string
+              example: '+123456789'
+              description: Contact phone number of the Store which is visible in the Footer
+            favicon_path:
+              type: string
+              example: /assets/favicon.ico
+        relationships:
+          type: object
+          properties:
+            menus:
+              type: object
+              description: Menus
+              properties:
+                data:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/Relation'
+            cms_pages:
+              type: object
+              description: CMS Pages
+              properties:
+                data:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/Relation'
+            default_country:
+              type: object
+              description: Default Country of the Store
+              properties:
+                data:
+                  $ref: '#/components/schemas/Relation'
+      required:
+        - id
+        - type
+        - attributes
+        - relationships
     Shipment:
       type: object
       title: Shipment
@@ -3491,6 +3644,12 @@ components:
             email:
               type: string
               example: spree@example.com
+            first_name:
+              type: string
+              example: John
+            last_name:
+              type: string
+              example: Doe
             store_credits:
               type: number
               example: 150.75
@@ -3501,7 +3660,7 @@ components:
             public_metadata:
               type: object
               example:
-                user_segment: 'supplier'
+                user_segment: supplier
               description: The public metadata for this User
         relationships:
           type: object
@@ -3820,6 +3979,13 @@ components:
         type: string
       description: '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'
+    CartCurrencyParam:
+      name: currency
+      in: query
+      schema:
+        type: string
+      description: 'Must be specified when is different than current store default currency.'
+      example: 'USD'
     ProductIncludeParam:
       name: include
       in: query
@@ -3834,6 +4000,20 @@ components:
 
         [More information](https://jsonapi.org/format/#fetching-includes)
       example: 'default_variant,variants,option_types,product_properties,taxons,images,primary_variant'
+    StoreIncludeParam:
+      name: include
+      in: query
+      schema:
+        type: string
+      description: |-
+        Specify what related resources (relationships) you would like to receive in the response body. Eg.
+
+        ```
+        default_country,menus,cms_pages
+        ```
+
+        [More information](https://jsonapi.org/format/#fetching-includes)
+      example: 'default_country,menus,cms_pages'
     ProductImageTransformationSizeParam:
       in: query
       name: 'image_transformation[size]'
@@ -3975,6 +4155,13 @@ components:
       schema:
         type: string
       example: 'price,description,name'
+    SparseFieldsStore:
+      name: 'fields[store]'
+      in: query
+      description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
+      schema:
+        type: string
+      example: 'name,url,supported_locales'
     SparseFieldsShippingRate:
       in: query
       name: 'fields[shipping_rate]'
@@ -4920,10 +5107,12 @@ components:
                   type: user
                   attributes:
                     email: spree@example.com
+                    first_name: John
+                    last_name: Snow
                     store_credits: 0
                     completed_orders: 0
                     public_metadata:
-                      user_segment: 'supplier'
+                      user_segment: supplier
                   relationships:
                     default_billing_address:
                       data:
@@ -6043,11 +6232,11 @@ components:
                     year: 2026
                     name: John Doe
                     default: true
-                    relationships:
-                      payment_method:
-                        data:
-                          id: '1'
-                          type: payment_method
+                  relationships:
+                    payment_method:
+                      data:
+                        id: '1'
+                        type: payment_method
                 included:
                   - id: '1'
                     type: payment_method
@@ -6092,11 +6281,11 @@ components:
                       year: 2026
                       name: John Doe
                       default: true
-                      relationships:
-                        payment_method:
-                          data:
-                            id: string
-                            type: string
+                    relationships:
+                      payment_method:
+                        data:
+                          id: string
+                          type: string
                   - id: '2'
                     type: credit_card
                     attributes:
@@ -6106,11 +6295,11 @@ components:
                       year: 2030
                       name: John Doe
                       default: false
-                      relationships:
-                        payment_method:
-                          data:
-                            id: string
-                            type: string
+                    relationships:
+                      payment_method:
+                        data:
+                          id: string
+                          type: string
                 included:
                   - id: '1'
                     type: payment_method
@@ -8362,6 +8551,140 @@ components:
                   prev: 'http://localhost:3000/api/v2/storefront/products?page=1'
                   last: 'http://localhost:3000/api/v2/storefront/products?page=5'
                   first: 'http://localhost:3000/api/v2/storefront/products?page=1'
+    Store:
+      description: 200 Success - Returns the `store` object.
+      content:
+        application/vnd.api+json:
+          schema:
+            type: object
+            properties:
+              data:
+                $ref: '#/components/schemas/Store'
+              included:
+                type: array
+                items:
+                  $ref: '#/components/schemas/StoreIncludes'
+            required:
+              - data
+          examples:
+            Store without includes:
+              value:
+                data:
+                  id: '3'
+                  type: store
+                  attributes:
+                    name: Mystore
+                    url: spree-demo.com
+                    meta_description: Luxury clothing store for men and women.
+                    meta_keywords: luxury clothing men women
+                    seo_title: ''
+                    default_currency: USD
+                    default: true
+                    supported_currencies: 'EUR,GBP,USD'
+                    facebook: 'https://www.facebook.com/mystorename'
+                    twitter: 'https://twitter.com/mystorename'
+                    instagram: 'https://instagram.com/mystorename'
+                    default_locale: en
+                    customer_support_email: support@mystore.com
+                    description: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
+                    address: '813 Howard Street, Oswego NY 13126, USA'
+                    contact_phone: '+123456789'
+                    supported_locales: en
+                    favicon_path: /assets/favicon.ico
+                  relationships:
+                    menus:
+                      data:
+                        - id: '10'
+                          type: menu
+                        - id: '11'
+                          type: menu
+                    cms_pages:
+                      data:
+                        - id: '5'
+                          type: cms_page
+                    default_country:
+                      data:
+                        id: '2'
+                        type: country
+            Store with Includes:
+              value:
+                data:
+                  id: '3'
+                  type: store
+                  attributes:
+                    name: Mystore
+                    url: spree-demo.com
+                    meta_description: Luxury clothing store for men and women.
+                    meta_keywords: luxury clothing men women
+                    seo_title: ''
+                    default_currency: USD
+                    default: true
+                    supported_currencies: 'EUR,GBP,USD'
+                    facebook: 'https://www.facebook.com/mystorename'
+                    twitter: 'https://twitter.com/mystorename'
+                    instagram: 'https://instagram.com/mystorename'
+                    default_locale: en
+                    customer_support_email: support@mystore.com
+                    description: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
+                    address: '813 Howard Street, Oswego NY 13126, USA'
+                    contact_phone: '+123456789'
+                    supported_locales: en
+                    favicon_path: /assets/favicon.ico
+                  relationships:
+                    menus:
+                      data:
+                        - id: '10'
+                          type: menu
+                        - id: '11'
+                          type: menu
+                    cms_pages:
+                      data:
+                        - id: '5'
+                          type: cms_page
+                    default_country:
+                      data:
+                        id: '2'
+                        type: country
+                included:
+                  - id: '2'
+                    type: country
+                    attributes:
+                      iso: US
+                      iso3: USA
+                      iso_name: UNITED STATES
+                      name: United States
+                      states_required: true
+                      zipcode_required: true
+                      default: true
+                    relationships:
+                      checkout_zone_applicable_states:
+                        data: []
+                  - id: '10'
+                    type: cms_page
+                    attributes:
+                      title: Returns Policy
+                      content: null
+                      locale: en
+                      meta_description: ''
+                      meta_title: ''
+                      slug: returns-policy
+                      type: 'Spree::Cms::Pages::StandardPage'
+                    relationships:
+                      cms_sections:
+                        data: []
+                  - id: '12'
+                    type: menu
+                    attributes:
+                      name: Company
+                      location: header
+                      locale: en
+                    relationships:
+                      menu_items:
+                        data:
+                          - id: '1'
+                            type: menu_item
+                          - id: '2'
+                            type: menu_item
     Taxon:
       description: 200 Success - Returns the `taxon` object.
       content:
@@ -14895,7 +15218,7 @@ components:
                   last: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
                   first: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
     Shipment:
-      description: '200 Success - Returns an array containing sevral `shipment` objects, along with the included array containing all available `shipping_rate` and `stock_location` objects. '
+      description: '200 Success - Returns an array containing several `shipment` objects, along with the included array containing all available `shipping_rate` and `stock_location` objects. '
       content:
         application/vnd.api+json:
           schema:
@@ -16175,6 +16498,7 @@ tags:
   - name: Menus
   - name: Order Status
   - name: Products
+  - name: Stores
   - name: Taxons
   - name: Wishlists
   - name: Wishlists / Wished Items

data/lib/spree/api/configuration.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    class Configuration < Preferences::Configuration
+      preference :api_v2_serializers_cache_ttl, :integer, default: 3600 # 1 hour in seconds
+      preference :api_v2_collection_cache_ttl, :integer, default: 3600 # 1 hour in seconds
+      preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'
+      preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
+      preference :api_v2_per_page_limit, :integer, default: 500
+    end
+  end
+end