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.

Add CMS Pages to Storefront API docs (#11268)

Matthew Kennedy03041590b38d
diff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yaml
index 2242c4af85..b831894687 100644
--- a/api/docs/v2/storefront/index.yaml
+++ b/api/docs/v2/storefront/index.yaml
@@ -3968,6 +3968,1377 @@ paths:
schema:
$ref: '#/components/schemas/Country'
summary: Get Default Country
+ /api/v2/storefront/cms_pages:
+ get:
+ description: Returns a list of all CMS Pages available in the current store.
+ tags:
+ - CMS Pages
+ operationId: get-cms-pages
+ parameters:
+ - $ref: '#/components/parameters/FilterByType'
+ - $ref: '#/components/parameters/FilterByTitle'
+ - $ref: '#/components/parameters/CmsPageIncludeParam'
+ - $ref: '#/components/parameters/PerPageParam'
+ responses:
+ '200':
+ description: Returns a list of all CMS Pages available for the current store.
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/CmsPagesList'
+ examples:
+ Base Response:
+ value:
+ data:
+ - id: '2'
+ type: cms_page
+ attributes:
+ title: Privacy Policy
+ content: Quaerat ratione perspiciatis molestias illum corporis. Molestiae architecto at molestias aperiam autem enim. Debitis architecto harum alias aut molestiae dolores veniam adipisci. Dolorum porro neque assumenda ab molestias provident magnam nihil. Accusantium earum molestias eius ipsam. Deserunt provident maiores illum expedita mollitia quo ut inventore. Dolores doloremque ab beatae aperiam ipsum cum et in. Quas harum facilis libero impedit. Non suscipit tenetur beatae neque fugit.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: privacy-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '3'
+ type: cms_page
+ attributes:
+ title: Shipping Policy
+ content: Dicta quos culpa autem corrupti debitis impedit labore nam. Architecto minus ipsa laboriosam facilis. Perspiciatis delectus laborum fugiat sed nemo. Eaque minus excepturi ex quod. Delectus cupiditate accusantium consectetur esse blanditiis similique itaque a. Facilis maxime nisi atque distinctio sapiente inventore eaque iste. Fugit voluptate vel doloribus vero dicta temporibus asperiores. Aut ad sunt pariatur atque rerum reprehenderit minima occaecati.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: shipping-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '4'
+ type: cms_page
+ attributes:
+ title: Returns Policy
+ content: Occaecati ipsa recusandae iure illum perferendis sit nisi. Perferendis vel assumenda repudiandae sunt. Incidunt doloribus suscipit culpa at quam consequatur doloremque. Aperiam sint sequi laborum iste. Neque veritatis dignissimos sit asperiores. Ut placeat tempora nisi optio. Culpa voluptatibus soluta distinctio quasi sed ut saepe. Facilis cum iusto illo eos repellendus. Sapiente placeat nobis inventore officia aperiam suscipit quisquam. Ipsa id quae voluptates perspiciatis dicta.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: returns-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '31'
+ type: cms_page
+ attributes:
+ title: Homepage (English)
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: null
+ type: 'Spree::Cms::Pages::Homepage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '7'
+ type: cms_section
+ - id: '19'
+ type: cms_section
+ - id: '31'
+ type: cms_section
+ - id: '43'
+ type: cms_section
+ - id: '55'
+ type: cms_section
+ - id: '67'
+ type: cms_section
+ - id: '1'
+ type: cms_page
+ attributes:
+ title: About Us
+ content: Culpa cupiditate deserunt ipsam distinctio. Hic ipsa nihil minima veritatis assumenda atque aspernatur corrupti. Tempora blanditiis optio hic deleniti labore soluta quis quod. In omnis sit blanditiis repudiandae impedit non sed tenetur. Porro incidunt molestias ipsum quos tenetur similique recusandae vitae. Sunt commodi ipsam quibusdam unde modi. Tempore illo laudantium harum ipsa. Fuga quam magni nemo doloribus.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: about-us
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '25'
+ type: cms_page
+ attributes:
+ title: Feature Page
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: feature-page
+ type: 'Spree::Cms::Pages::FeaturePage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '1'
+ type: cms_section
+ - id: '13'
+ type: cms_section
+ - id: '25'
+ type: cms_section
+ - id: '37'
+ type: cms_section
+ - id: '49'
+ type: cms_section
+ - id: '61'
+ type: cms_section
+ meta:
+ count: 6
+ total_count: 6
+ total_pages: 1
+ links:
+ self: 'http://localhost:3000/api/v2/storefront/cms_pages'
+ next: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
+ prev: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
+ last: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
+ first: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
+ '?include=cms_sections':
+ value:
+ data:
+ - id: '2'
+ type: cms_page
+ attributes:
+ title: Privacy Policy
+ content: Quaerat ratione perspiciatis molestias illum corporis. Molestiae architecto at molestias aperiam autem enim. Debitis architecto harum alias aut molestiae dolores veniam adipisci. Dolorum porro neque assumenda ab molestias provident magnam nihil. Accusantium earum molestias eius ipsam. Deserunt provident maiores illum expedita mollitia quo ut inventore. Dolores doloremque ab beatae aperiam ipsum cum et in. Quas harum facilis libero impedit. Non suscipit tenetur beatae neque fugit.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: privacy-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '3'
+ type: cms_page
+ attributes:
+ title: Shipping Policy
+ content: Dicta quos culpa autem corrupti debitis impedit labore nam. Architecto minus ipsa laboriosam facilis. Perspiciatis delectus laborum fugiat sed nemo. Eaque minus excepturi ex quod. Delectus cupiditate accusantium consectetur esse blanditiis similique itaque a. Facilis maxime nisi atque distinctio sapiente inventore eaque iste. Fugit voluptate vel doloribus vero dicta temporibus asperiores. Aut ad sunt pariatur atque rerum reprehenderit minima occaecati.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: shipping-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '4'
+ type: cms_page
+ attributes:
+ title: Returns Policy
+ content: Occaecati ipsa recusandae iure illum perferendis sit nisi. Perferendis vel assumenda repudiandae sunt. Incidunt doloribus suscipit culpa at quam consequatur doloremque. Aperiam sint sequi laborum iste. Neque veritatis dignissimos sit asperiores. Ut placeat tempora nisi optio. Culpa voluptatibus soluta distinctio quasi sed ut saepe. Facilis cum iusto illo eos repellendus. Sapiente placeat nobis inventore officia aperiam suscipit quisquam. Ipsa id quae voluptates perspiciatis dicta.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: returns-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '31'
+ type: cms_page
+ attributes:
+ title: Homepage (English)
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: null
+ type: 'Spree::Cms::Pages::Homepage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '7'
+ type: cms_section
+ - id: '19'
+ type: cms_section
+ - id: '31'
+ type: cms_section
+ - id: '43'
+ type: cms_section
+ - id: '55'
+ type: cms_section
+ - id: '67'
+ type: cms_section
+ - id: '1'
+ type: cms_page
+ attributes:
+ title: About Us
+ content: Culpa cupiditate deserunt ipsam distinctio. Hic ipsa nihil minima veritatis assumenda atque aspernatur corrupti. Tempora blanditiis optio hic deleniti labore soluta quis quod. In omnis sit blanditiis repudiandae impedit non sed tenetur. Porro incidunt molestias ipsum quos tenetur similique recusandae vitae. Sunt commodi ipsam quibusdam unde modi. Tempore illo laudantium harum ipsa. Fuga quam magni nemo doloribus.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: about-us
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '25'
+ type: cms_page
+ attributes:
+ title: Feature Page
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: feature-page
+ type: 'Spree::Cms::Pages::FeaturePage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '1'
+ type: cms_section
+ - id: '13'
+ type: cms_section
+ - id: '25'
+ type: cms_section
+ - id: '37'
+ type: cms_section
+ - id: '49'
+ type: cms_section
+ - id: '61'
+ type: cms_section
+ included:
+ - id: '7'
+ type: cms_section
+ attributes:
+ name: Hero Image
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/new-collection/summer-2021
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '24'
+ type: taxon
+ - id: '19'
+ type: cms_section
+ attributes:
+ name: Main Taxons
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ link_type_three: 'Spree::Taxon'
+ link_one: categories/men
+ link_two: categories/women
+ link_three: categories/sportswear
+ title_one: Men
+ title_two: Women
+ title_three: Sportswear
+ settings:
+ layout_style: Default
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::ImageGallery'
+ position: 2
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '31'
+ type: cms_section
+ attributes:
+ name: Best Sellers Carousel
+ content: null
+ settings: null
+ link: /t/categories/bestsellers
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 3
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '19'
+ type: taxon
+ - id: '43'
+ type: cms_section
+ attributes:
+ name: Fashion Trends
+ content:
+ title: Summer 2021
+ subtitle: Fashion Trends
+ button_text: Read More
+ rte_content: '<div style="text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.</div>'
+ settings:
+ gutters: No Gutters
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::FeaturedArticle'
+ position: 4
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '55'
+ type: cms_section
+ attributes:
+ name: Trending Carousel
+ content: null
+ settings: null
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 5
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '67'
+ type: cms_section
+ attributes:
+ name: Promotions
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ title_one: New Collection
+ subtitle_one: Street Style
+ link_one: categories/streetstyle
+ title_two: Summer Sale
+ subtitle_two: Up To 30% OFF
+ link_two: categories/special-offers/30-percent-off
+ settings:
+ gutters: Gutters
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::SideBySideImages'
+ position: 6
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '1'
+ type: cms_section
+ attributes:
+ name: Hero Image
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/new-collection/summer-2021
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ img_one_sm: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRZd01IZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--92b360476c0e8d22f5df6c55757810c83e60c146/main_banner.jpg
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFeU1EQjROVEF3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--866962ae8b1b41c71aa857e7a34710c797b8dd55/main_banner.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpJME1EQjRNVEF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--43c8982ec49eb906ac30cd2849eeef756c35d9f9/main_banner.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpRNE1EQjRNakF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--fbf0ebd65ea1bfbb6b7a336d16f72468316a7268/main_banner.jpg
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '24'
+ type: taxon
+ - id: '13'
+ type: cms_section
+ attributes:
+ name: Main Taxons
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ link_type_three: 'Spree::Taxon'
+ link_one: categories/men
+ link_two: categories/women
+ link_three: categories/sportswear
+ title_one: Men
+ title_two: Women
+ title_three: Sportswear
+ settings:
+ layout_style: Default
+ display_labels: Show
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::ImageGallery'
+ position: 2
+ img_one_sm: null
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2e2fea52d03266ca8a46f7514cbb837dc2baaf3/category_banner_upper-.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/category_banner_upper-.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9822104a9af260c8d4c21bc404394a1c8fc81166/category_banner_upper-.jpg
+ img_two_sm: null
+ img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZzBNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--e3678be2a363fb280cc072202d99de407350cac5/big_category_banner.jpg
+ img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZzRNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--a1154d8790a13282cf2c9df685546187765b724c/big_category_banner.jpg
+ img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpFd09EQjRNVFl3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--6ad282583fd31c01e5051b524b6da7a0b116daf7/big_category_banner.jpg
+ img_three_sm: null
+ img_three_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2e2fea52d03266ca8a46f7514cbb837dc2baaf3/category_banner_lower.jpg
+ img_three_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/category_banner_lower.jpg
+ img_three_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9822104a9af260c8d4c21bc404394a1c8fc81166/category_banner_lower.jpg
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '25'
+ type: cms_section
+ attributes:
+ name: Best Sellers Carousel
+ content: null
+ settings: null
+ link: /t/categories/bestsellers
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 3
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '19'
+ type: taxon
+ - id: '37'
+ type: cms_section
+ attributes:
+ name: Fashion Trends
+ content:
+ title: Summer 2021
+ subtitle: Fashion Trends
+ button_text: Read More
+ rte_content: '<div style="text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.</div>'
+ settings:
+ gutters: No Gutters
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::FeaturedArticle'
+ position: 4
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '49'
+ type: cms_section
+ attributes:
+ name: Trending Carousel
+ content: null
+ settings: null
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 5
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '61'
+ type: cms_section
+ attributes:
+ name: Promotions
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ title_one: New Collection
+ subtitle_one: Street Style
+ link_one: categories/streetstyle
+ title_two: Summer Sale
+ subtitle_two: Up To 30% OFF
+ link_two: categories/special-offers/30-percent-off
+ settings:
+ gutters: Gutters
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::SideBySideImages'
+ position: 6
+ img_one_sm: null
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2d3125a8d17dbf5fa8e82623b175796667a83ac/promo_banner_left-third.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/promo_banner_left-third.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9e18a740824becd8c6796a1b7da4ece49a754925/promo_banner_left-third.jpg
+ img_two_sm: null
+ img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2d3125a8d17dbf5fa8e82623b175796667a83ac/promo_banner_right-third-category.jpg
+ img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRjek5IZzBOelkrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--78346a2fa6c60344b83ea2ecc89e453916888411/promo_banner_right-third-category.jpg
+ img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9e18a740824becd8c6796a1b7da4ece49a754925/promo_banner_right-third-category.jpg
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ meta:
+ count: 6
+ total_count: 6
+ total_pages: 1
+ links:
+ self: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections'
+ next: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
+ prev: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
+ last: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
+ first: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
+ '?include=cms_sections.linked_resource':
+ value:
+ data:
+ - id: '2'
+ type: cms_page
+ attributes:
+ title: Privacy Policy
+ content: Quaerat ratione perspiciatis molestias illum corporis. Molestiae architecto at molestias aperiam autem enim. Debitis architecto harum alias aut molestiae dolores veniam adipisci. Dolorum porro neque assumenda ab molestias provident magnam nihil. Accusantium earum molestias eius ipsam. Deserunt provident maiores illum expedita mollitia quo ut inventore. Dolores doloremque ab beatae aperiam ipsum cum et in. Quas harum facilis libero impedit. Non suscipit tenetur beatae neque fugit.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: privacy-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '3'
+ type: cms_page
+ attributes:
+ title: Shipping Policy
+ content: Dicta quos culpa autem corrupti debitis impedit labore nam. Architecto minus ipsa laboriosam facilis. Perspiciatis delectus laborum fugiat sed nemo. Eaque minus excepturi ex quod. Delectus cupiditate accusantium consectetur esse blanditiis similique itaque a. Facilis maxime nisi atque distinctio sapiente inventore eaque iste. Fugit voluptate vel doloribus vero dicta temporibus asperiores. Aut ad sunt pariatur atque rerum reprehenderit minima occaecati.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: shipping-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '4'
+ type: cms_page
+ attributes:
+ title: Returns Policy
+ content: Occaecati ipsa recusandae iure illum perferendis sit nisi. Perferendis vel assumenda repudiandae sunt. Incidunt doloribus suscipit culpa at quam consequatur doloremque. Aperiam sint sequi laborum iste. Neque veritatis dignissimos sit asperiores. Ut placeat tempora nisi optio. Culpa voluptatibus soluta distinctio quasi sed ut saepe. Facilis cum iusto illo eos repellendus. Sapiente placeat nobis inventore officia aperiam suscipit quisquam. Ipsa id quae voluptates perspiciatis dicta.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: returns-policy
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '31'
+ type: cms_page
+ attributes:
+ title: Homepage (English)
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: null
+ type: 'Spree::Cms::Pages::Homepage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '7'
+ type: cms_section
+ - id: '19'
+ type: cms_section
+ - id: '31'
+ type: cms_section
+ - id: '43'
+ type: cms_section
+ - id: '55'
+ type: cms_section
+ - id: '67'
+ type: cms_section
+ - id: '1'
+ type: cms_page
+ attributes:
+ title: About Us
+ content: Culpa cupiditate deserunt ipsam distinctio. Hic ipsa nihil minima veritatis assumenda atque aspernatur corrupti. Tempora blanditiis optio hic deleniti labore soluta quis quod. In omnis sit blanditiis repudiandae impedit non sed tenetur. Porro incidunt molestias ipsum quos tenetur similique recusandae vitae. Sunt commodi ipsam quibusdam unde modi. Tempore illo laudantium harum ipsa. Fuga quam magni nemo doloribus.
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: about-us
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ - id: '25'
+ type: cms_page
+ attributes:
+ title: Feature Page
+ content: null
+ locale: en
+ meta_description: null
+ meta_title: null
+ slug: feature-page
+ type: 'Spree::Cms::Pages::FeaturePage'
+ relationships:
+ cms_sections:
+ data:
+ - id: '1'
+ type: cms_section
+ - id: '13'
+ type: cms_section
+ - id: '25'
+ type: cms_section
+ - id: '37'
+ type: cms_section
+ - id: '49'
+ type: cms_section
+ - id: '61'
+ type: cms_section
+ included:
+ - id: '24'
+ type: taxon
+ attributes:
+ name: Summer 2021
+ pretty_name: Categories -> New Collection -> Summer 2021
+ permalink: categories/new-collection/summer-2021
+ seo_title: Summer 2021
+ description: null
+ meta_title: null
+ meta_description: null
+ meta_keywords: null
+ left: 45
+ right: 46
+ position: 0
+ depth: 2
+ updated_at: '2021-08-05T17:34:24.878Z'
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ parent:
+ data:
+ id: '23'
+ type: taxon
+ taxonomy:
+ data:
+ id: '1'
+ type: taxonomy
+ children:
+ data: []
+ image:
+ data: null
+ - id: '7'
+ type: cms_section
+ attributes:
+ name: Hero Image
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/new-collection/summer-2021
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '24'
+ type: taxon
+ - id: '19'
+ type: cms_section
+ attributes:
+ name: Main Taxons
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ link_type_three: 'Spree::Taxon'
+ link_one: categories/men
+ link_two: categories/women
+ link_three: categories/sportswear
+ title_one: Men
+ title_two: Women
+ title_three: Sportswear
+ settings:
+ layout_style: Default
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::ImageGallery'
+ position: 2
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '19'
+ type: taxon
+ attributes:
+ name: Bestsellers
+ pretty_name: Categories -> Bestsellers
+ permalink: categories/bestsellers
+ seo_title: Bestsellers
+ description: null
+ meta_title: null
+ meta_description: null
+ meta_keywords: null
+ left: 36
+ right: 37
+ position: 0
+ depth: 1
+ updated_at: '2021-08-05T17:35:05.960Z'
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ parent:
+ data:
+ id: '1'
+ type: taxon
+ taxonomy:
+ data:
+ id: '1'
+ type: taxonomy
+ children:
+ data: []
+ image:
+ data: null
+ - id: '31'
+ type: cms_section
+ attributes:
+ name: Best Sellers Carousel
+ content: null
+ settings: null
+ link: /t/categories/bestsellers
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 3
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '19'
+ type: taxon
+ - id: '20'
+ type: taxon
+ attributes:
+ name: Trending
+ pretty_name: Categories -> Trending
+ permalink: categories/trending
+ seo_title: Trending
+ description: null
+ meta_title: null
+ meta_description: null
+ meta_keywords: null
+ left: 38
+ right: 39
+ position: 0
+ depth: 1
+ updated_at: '2021-08-05T17:35:05.865Z'
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ parent:
+ data:
+ id: '1'
+ type: taxon
+ taxonomy:
+ data:
+ id: '1'
+ type: taxonomy
+ children:
+ data: []
+ image:
+ data: null
+ - id: '43'
+ type: cms_section
+ attributes:
+ name: Fashion Trends
+ content:
+ title: Summer 2021
+ subtitle: Fashion Trends
+ button_text: Read More
+ rte_content: '<div style="text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.</div>'
+ settings:
+ gutters: No Gutters
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::FeaturedArticle'
+ position: 4
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '55'
+ type: cms_section
+ attributes:
+ name: Trending Carousel
+ content: null
+ settings: null
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 5
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '67'
+ type: cms_section
+ attributes:
+ name: Promotions
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ title_one: New Collection
+ subtitle_one: Street Style
+ link_one: categories/streetstyle
+ title_two: Summer Sale
+ subtitle_two: Up To 30% OFF
+ link_two: categories/special-offers/30-percent-off
+ settings:
+ gutters: Gutters
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::SideBySideImages'
+ position: 6
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '1'
+ type: cms_section
+ attributes:
+ name: Hero Image
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/new-collection/summer-2021
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ img_one_sm: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRZd01IZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--92b360476c0e8d22f5df6c55757810c83e60c146/main_banner.jpg
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFeU1EQjROVEF3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--866962ae8b1b41c71aa857e7a34710c797b8dd55/main_banner.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpJME1EQjRNVEF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--43c8982ec49eb906ac30cd2849eeef756c35d9f9/main_banner.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBHUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--c76ac244dba53c84c84fbf0cd26ef842cbebc214/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpRNE1EQjRNakF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--fbf0ebd65ea1bfbb6b7a336d16f72468316a7268/main_banner.jpg
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '24'
+ type: taxon
+ - id: '13'
+ type: cms_section
+ attributes:
+ name: Main Taxons
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ link_type_three: 'Spree::Taxon'
+ link_one: categories/men
+ link_two: categories/women
+ link_three: categories/sportswear
+ title_one: Men
+ title_two: Women
+ title_three: Sportswear
+ settings:
+ layout_style: Default
+ display_labels: Show
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::ImageGallery'
+ position: 2
+ img_one_sm: null
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2e2fea52d03266ca8a46f7514cbb837dc2baaf3/category_banner_upper-.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/category_banner_upper-.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--2a2e94d7ccc9fe5f1b441d439a9fd0cdca055575/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9822104a9af260c8d4c21bc404394a1c8fc81166/category_banner_upper-.jpg
+ img_two_sm: null
+ img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZzBNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--e3678be2a363fb280cc072202d99de407350cac5/big_category_banner.jpg
+ img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZzRNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--a1154d8790a13282cf2c9df685546187765b724c/big_category_banner.jpg
+ img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--4562b9d3531f1e3fb9a714036d7f5b9df94b7230/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpFd09EQjRNVFl3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--6ad282583fd31c01e5051b524b6da7a0b116daf7/big_category_banner.jpg
+ img_three_sm: null
+ img_three_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2e2fea52d03266ca8a46f7514cbb837dc2baaf3/category_banner_lower.jpg
+ img_three_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/category_banner_lower.jpg
+ img_three_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBIZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--cafc42d36293797e051ddb1b1a35fa1fa83767c0/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9822104a9af260c8d4c21bc404394a1c8fc81166/category_banner_lower.jpg
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ - id: '25'
+ type: cms_section
+ attributes:
+ name: Best Sellers Carousel
+ content: null
+ settings: null
+ link: /t/categories/bestsellers
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 3
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '19'
+ type: taxon
+ - id: '37'
+ type: cms_section
+ attributes:
+ name: Fashion Trends
+ content:
+ title: Summer 2021
+ subtitle: Fashion Trends
+ button_text: Read More
+ rte_content: '<div style="text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.</div>'
+ settings:
+ gutters: No Gutters
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::FeaturedArticle'
+ position: 4
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '49'
+ type: cms_section
+ attributes:
+ name: Trending Carousel
+ content: null
+ settings: null
+ link: /t/categories/trending
+ fit: Screen
+ type: 'Spree::Cms::Sections::ProductCarousel'
+ position: 5
+ img_one_sm: null
+ img_one_md: null
+ img_one_lg: null
+ img_one_xl: null
+ img_two_sm: null
+ img_two_md: null
+ img_two_lg: null
+ img_two_xl: null
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: true
+ relationships:
+ linked_resource:
+ data:
+ id: '20'
+ type: taxon
+ - id: '61'
+ type: cms_section
+ attributes:
+ name: Promotions
+ content:
+ link_type_one: 'Spree::Taxon'
+ link_type_two: 'Spree::Taxon'
+ title_one: New Collection
+ subtitle_one: Street Style
+ link_one: categories/streetstyle
+ title_two: Summer Sale
+ subtitle_two: Up To 30% OFF
+ link_two: categories/special-offers/30-percent-off
+ settings:
+ gutters: Gutters
+ link: null
+ fit: Container
+ type: 'Spree::Cms::Sections::SideBySideImages'
+ position: 6
+ img_one_sm: null
+ img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2d3125a8d17dbf5fa8e82623b175796667a83ac/promo_banner_left-third.jpg
+ img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--7557ce0ba9a84d082ef5244eda86bc51c04a4193/promo_banner_left-third.jpg
+ img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--632caf08076c85627ba64ac3d373a2be52084313/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9e18a740824becd8c6796a1b7da4ece49a754925/promo_banner_left-third.jpg
+ img_two_sm: null
+ img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b2d3125a8d17dbf5fa8e82623b175796667a83ac/promo_banner_right-third-category.jpg
+ img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRjek5IZzBOelkrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--78346a2fa6c60344b83ea2ecc89e453916888411/promo_banner_right-third-category.jpg
+ img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBKZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--58b807e007e081dcc885829c4db76d4366d4319a/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9e18a740824becd8c6796a1b7da4ece49a754925/promo_banner_right-third-category.jpg
+ img_three_sm: null
+ img_three_md: null
+ img_three_lg: null
+ img_three_xl: null
+ is_fullscreen: false
+ relationships:
+ linked_resource:
+ data: null
+ meta:
+ count: 6
+ total_count: 6
+ total_pages: 1
+ links:
+ self: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections.linked_resource'
+ next: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections.linked_resource&page=1'
+ prev: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections.linked_resource&page=1'
+ last: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections.linked_resource&page=1'
+ first: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections.linked_resource&page=1'
+ '404':
+ $ref: '#/components/responses/404NotFound'
+ summary: List of CMS Pages
+ '/api/v2/storefront/cms_pages/{cms_page_slug}':
+ get:
+ description: |-
+ To return a single CMS Page you can use the CMS Page slug:
+
+ ```
+ GET /api/v2/storefront/cms_pages/about-us
+ ```
+
+ or CMS Page ID:
+
+ ```
+ GET /api/v2/storefront/cms_pages/37
+ ```
+
+ **Note:** API will attempt a Slug lookup before an ID lookup.
+ tags:
+ - CMS Pages
+ operationId: get-cms-page
+ parameters:
+ - $ref: '#/components/parameters/CmsPageSlug'
+ - $ref: '#/components/parameters/CmsPageIncludeParam'
+ responses:
+ '200':
+ description: Returns the requested CMS Page
+ content:
+ application/vnd.api+json:
+ schema:
+ $ref: '#/components/schemas/CmsPage'
+ examples:
+ CMS Standard Page:
+ value:
+ data:
+ id: '1'
+ type: cms_page
+ attributes:
+ title: About US
+ content: <p>This is the rich text for our about us page</p>
+ locale: en
+ meta_description: 'Learn about us, by reading out About Us page.'
+ meta_title: Example Strore Ltd | About Us Page
+ slug: about-us
+ type: 'Spree::Cms::Pages::StandardPage'
+ relationships:
+ cms_sections:
+ data: []
+ included: []
+ 'CMS Homepage ':
+ value:
+ data:
+ id: '2'
+ type: cms_page
+ attributes:
+ title: Baseball Cap Overview
+ content: null
+ locale: en
+ meta_description: Example Store Ltd - Baseball Cap Overview
+ meta_title: Example Store Ltd | The Super Discount Store | Baseball Cap Overview
+ slug: null
+ type: 'Spree::Cms::Pages::Homepage'
+ relationships:
+ cms_sections:
+ data:
+ - id: string
+ type: cms_section
+ included:
+ - id: '1'
+ type: cms_section
+ attributes:
+ name: Main Hero
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/summer-collection
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ image_one_sm: /rails/active_storage/representations/redirect/eyJfc--eldkxjen/main_hero.jpg
+ image_one_md: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/main_hero.jpg
+ image_one_lg: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/main_hero.jpg
+ image_one_xl: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/main_hero.jpg
+ image_two_sm: null
+ image_two_md: null
+ image_two_lg: null
+ image_two_xl: null
+ image_three_sm: null
+ image_three_md: null
+ image_three_lg: null
+ image_three_xl: null
+ is_full_screen: true
+ CMS Feature Page:
+ value:
+ data:
+ id: '3'
+ type: cms_page
+ attributes:
+ title: Baseball Cap Overview
+ content: null
+ locale: en
+ meta_description: Example Store Ltd - Baseball Cap Overview
+ meta_title: Example Store Ltd | The Super Discount Store | Baseball Cap Overview
+ slug: product-overview
+ type: 'Spree::Cms::Pages::FeaturePage'
+ relationships:
+ cms_sections:
+ data:
+ - id: string
+ type: cms_section
+ included:
+ - id: '1'
+ type: cms_section
+ attributes:
+ name: Main Hero
+ content:
+ title: Summer Collection
+ button_text: Shop Now
+ settings:
+ gutters: No Gutters
+ link: /t/categories/summer-collection
+ fit: Screen
+ type: 'Spree::Cms::Sections::HeroImage'
+ position: 1
+ image_one_sm: /rails/active_storage/representations/redirect/eyJfc--eldkxjen/main_hero.jpg
+ image_one_md: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/main_hero.jpg
+ image_one_lg: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/main_hero.jpg
+ image_one_xl: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/main_hero.jpg
+ image_two_sm: null
+ image_two_md: null
+ image_two_lg: null
+ image_two_xl: null
+ image_three_sm: null
+ image_three_md: null
+ image_three_lg: null
+ image_three_xl: null
+ is_full_screen: true
+ '404':
+ $ref: '#/components/responses/404NotFound'
+ summary: Get CMS Page Details
components:
securitySchemes:
bearerAuth:
@@ -3990,420 +5361,879 @@ components:
schemas:
Error:
required:
- - error
+ - error
+ properties:
+ error:
+ type: string
+ ListLinks:
+ properties:
+ self:
+ type: string
+ description: URL to the current page of the listing
+ next:
+ type: string
+ description: URL to the next page of the listing
+ prev:
+ type: string
+ description: URL to the previous page of the listing
+ last:
+ type: string
+ description: URL to the last page of the listing
+ first:
+ type: string
+ description: URL to the first page of the listing
+ ListMeta:
+ properties:
+ count:
+ type: number
+ example: 7
+ description: Number of items on the current listing
+ total_count:
+ type: number
+ example: 145
+ description: Number of all items matching the criteria
+ total_pages:
+ type: number
+ example: 10
+ description: Number of all pages containing items matching the criteria
+ Timestamp:
+ type: string
+ format: date-time
+ example: '2020-02-16T07:14:54.617Z'
+ Address:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: address
+ attributes:
+ type: object
+ properties:
+ firstname:
+ type: string
+ example: John
+ lastname:
+ type: string
+ example: Doe
+ address1:
+ type: string
+ example: 1600 Amphitheatre Pkwy
+ address2:
+ type: string
+ example: Suite 1
+ city:
+ type: string
+ example: Mountain View
+ zipcode:
+ type: string
+ example: '94043'
+ phone:
+ type: string
+ example: (+1) 123 456 789
+ state_name:
+ type: string
+ example: California
+ state_code:
+ type: string
+ example: CA
+ description: State abbrevation
+ country_name:
+ type: string
+ example: United States of America
+ country_iso3:
+ type: string
+ example: USA
+ description: Country ISO3 code
+ company:
+ type: string
+ nullable: true
+ example: Google Inc.
+ AddressList:
+ required:
+ - data
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Address'
+ Cart:
+ properties:
+ data:
+ $ref: '#/components/schemas/CartAttributesWithRelationships'
+ included:
+ type: array
+ items:
+ anyOf:
+ - $ref: '#/components/schemas/Promotion'
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/Address'
+ - $ref: '#/components/schemas/ShipmentAttributesWithoutRelationsips'
+ type: object
+ required:
+ - data
+ - included
+ x-examples: {}
+ type: object
+ description: 'Cart provides a central place around which to collect information about a customer order - including line items, adjustments, payments, addresses, return authorizations, and shipments. [Read more in Spree docs](https://dev-docs.spreecommerce.org/internals/orders)'
+ CartList:
+ required:
+ - data
+ - included
+ properties:
+ data:
+ required:
+ - id
+ - type
+ - attributes
+ - relationships
+ type: array
+ items:
+ $ref: '#/components/schemas/CartAttributesWithRelationships'
+ included:
+ type: array
+ items:
+ type: object
+ anyOf:
+ - $ref: '#/components/schemas/VariantAttributesAndRelationships'
+ - $ref: '#/components/schemas/LineItem'
+ - $ref: '#/components/schemas/Promotion'
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/Address'
+ - $ref: '#/components/schemas/ShipmentAttributesWithoutRelationsips'
+ CartAttributesWithRelationships:
+ description: ''
+ type: object
+ properties:
+ id:
+ type: string
+ example: '1'
+ pattern: ^\d+$
+ type:
+ type: string
+ default: cart
+ example: cart
+ pattern: ^cart$
+ attributes:
+ $ref: '#/components/schemas/CartAttributes'
+ relationships:
+ $ref: '#/components/schemas/CartRelationships'
+ CartRelationships:
+ type: object
+ properties:
+ line_items:
+ type: object
+ description: ''
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ promotions:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ variants:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ user:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ billing_address:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ shipping_address:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ payments:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ shipments:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ CartAttributes:
+ type: object
+ properties:
+ number:
+ type: string
+ example: R123456789
+ pattern: ^R\d+$
+ email:
+ type: string
+ format: email
+ item_total:
+ type: string
+ example: '19.99'
+ display_item_total:
+ type: string
+ example: $19.99
+ total:
+ type: string
+ example: '29.99'
+ display_total:
+ type: string
+ example: $29.99
+ ship_total:
+ type: string
+ example: '0.0'
+ display_ship_total:
+ type: string
+ example: $19.99
+ adjustment_total:
+ type: string
+ example: '10.0'
+ display_adjustment_total:
+ type: string
+ example: $10.00
+ promo_total:
+ type: string
+ example: '-10.0'
+ display_promo_total:
+ type: string
+ example: '-$10.00'
+ created_at:
+ $ref: '#/components/schemas/Timestamp'
+ updated_at:
+ $ref: '#/components/schemas/Timestamp'
+ included_tax_total:
+ type: string
+ example: '5.00'
+ additional_tax_total:
+ type: string
+ example: '5.0'
+ display_additional_tax_total:
+ type: string
+ example: $5.00
+ display_included_tax_total:
+ type: string
+ example: $5.00
+ tax_total:
+ type: string
+ example: '10.0'
+ display_tax_total:
+ type: string
+ example: $10.00
+ pre_tax_item_amount:
+ type: string
+ example: '17.00'
+ display_pre_tax_item_amount:
+ type: string
+ example: $17.00
+ pre_tax_total:
+ type: string
+ example: '20.00'
+ display_pre_tax_total:
+ type: string
+ example: $20.00
+ item_count:
+ type: number
+ description: Total quantity number of all items added to the Cart
+ example: 2
+ minimum: 0
+ special_instructions:
+ type: string
+ nullable: true
+ example: Please wrap it as a gift
+ description: Message added by the Customer
+ currency:
+ type: string
+ example: USD
+ state:
+ type: string
+ example: cart
+ enum:
+ - cart
+ - address
+ - delivery
+ - payment
+ - confirm
+ - complete
+ description: |-
+ State of the Cart in the Checkout flow. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#the-order-state-machine">
+ The Order State machine
+ </a> for a full list with description.
+ payment_state:
+ type: string
+ example: balance_due
+ enum:
+ - balance_due
+ - credit_owed
+ - failed
+ - paid
+ - void
+ description: |-
+ Overall state of the Payments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-payment-states">
+ Order Payments states
+ </a> for a full list with description.
+ shipment_state:
+ type: string
+ example: pending
+ enum:
+ - backorder
+ - canceled
+ - partial
+ - pending
+ - ready
+ - shipped
+ description: |-
+ Overall state of the Shipments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-shipment-states-1">
+ Order Shipments states
+ </a> for a full list with description.
+ token:
+ type: string
+ example: abcdef123456
+ description: |-
+ Used for authorizing any action for an Order within Spree’s API.
+ CreditCardList:
+ required:
+ - included
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/CreditCardAttributesWithRelationships'
+ included:
+ type: array
+ items:
+ type: object
+ anyOf:
+ - $ref: '#/components/schemas/PaymentMethod'
+ CreditCard:
+ required:
+ - data
+ - included
properties:
- error:
- type: string
- ListLinks:
+ data:
+ $ref: '#/components/schemas/CreditCardAttributesWithRelationships'
+ included:
+ type: array
+ items:
+ type: object
+ anyOf:
+ - $ref: '#/components/schemas/PaymentMethod'
+ CreditCardAttributes:
+ type: object
properties:
- self:
+ cc_type:
type: string
- description: URL to the current page of the listing
- next:
+ enum:
+ - visa
+ - mastercard
+ - amex
+ example: visa
+ last_digits:
type: string
- description: URL to the next page of the listing
- prev:
+ example: '1232'
+ description: Last 4 digits of CC number
+ month:
type: string
- description: URL to the previous page of the listing
- last:
+ description: Expiration date month
+ example: '10'
+ year:
type: string
- description: URL to the last page of the listing
- first:
+ example: '2019'
+ description: Expiration date year
+ name:
type: string
- description: URL to the first page of the listing
- ListMeta:
+ example: John Doe
+ description: Card holder name
+ default:
+ type: boolean
+ example: true
+ description: Defines if this is the default CC for a signed in user
+ CreditCardAttributesWithRelationships:
properties:
- count:
- type: number
- example: 7
- description: Number of items on the current listing
- total_count:
- type: number
- example: 145
- description: Number of all items matching the criteria
- total_pages:
- type: number
- example: 10
- description: Number of all pages containing items matching the criteria
- Timestamp:
- type: string
- format: date-time
- example: '2020-02-16T07:14:54.617Z'
- Address:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ example: credit_card
+ attributes:
+ $ref: '#/components/schemas/CreditCardAttributes'
+ relationships:
+ type: object
+ properties:
+ payment_method:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ Image:
+ type: object
+ properties:
+ data:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: image
+ attributes:
+ type: object
+ properties:
+ position:
+ type: integer
+ description: Sort order of images set in the Admin Panel
+ example: 0
+ minimum: 0
+ styles:
+ type: array
+ description: An array of pre-scaled image styles
+ items:
+ $ref: '#/components/schemas/ImageStyle'
+ required:
+ - data
+ ImageStyle:
+ properties:
+ url:
+ type: string
+ example: 'http://localhost:3000/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJbWQyWVhKcFlXNTBjeTltWm1sMmRURlNORFpZWjJaSFpYUkdZMjk2WWsxM1RHWXZNVGs1T1RCak5XVmlNamN4TlRnd1pqVTBabUpqTWpCbFkyVXhZMlZpTTJFd05ERTJZemMzT0dKaE5tSTFNREkyT0dKaFpqa3paV1JtWTJWaE16aGxaQVk2QmtWVSIsImV4cCI6IjIwMTgtMDYtMjRUMTM6NTk6NTguOTY5WiIsInB1ciI6ImJsb2Jfa2V5In19--5e9ff358dc747f73754e332678c5762114ac6f3f/ror_jr_spaghetti.jpeg?content_type=image%2Fjpeg&disposition=inline%3B+filename%3D%22ror_jr_spaghetti.jpeg%22%3B+filename%2A%3DUTF-8%27%27ror_jr_spaghetti.jpeg'
+ description: Absolute URL of the uploaded image in selected style (width/height)
+ width:
+ type: integer
+ example: 1920
+ description: Actual width of image
+ height:
+ type: integer
+ example: 1080
+ description: Actual height of image
+ User:
type: object
+ properties:
+ id:
+ type: string
+ example: "1"
+ type:
+ type: string
+ default: user
+ attributes:
+ type: object
+ properties:
+ email:
+ type: string
+ format: email
+ LineItem:
properties:
id:
type: string
example: '1'
type:
type: string
- default: address
+ default: line_item
attributes:
type: object
properties:
- firstname:
+ name:
type: string
- example: John
- lastname:
+ example: Sample product
+ quantity:
+ type: integer
+ example: 1
+ slug:
type: string
- example: Doe
- address1:
+ example: sample-product
+ options_text:
type: string
- example: 1600 Amphitheatre Pkwy
- address2:
+ example: 'Size: small, Color: red'
+ price:
type: string
- example: Suite 1
- city:
+ example: '125.0'
+ description: Price of Product per quantity
+ currency:
type: string
- example: Mountain View
- zipcode:
+ example: USD
+ display_price:
type: string
- example: '94043'
- phone:
+ example: $125.00
+ description: Price of Product per quantity
+ total:
type: string
- example: (+1) 123 456 789
- state_name:
+ example: '250.0'
+ description: 'Total price of Line Item including adjastments, promotions and taxes'
+ display_total:
type: string
- example: California
- state_code:
+ example: $250.00
+ description: 'Total price of Line Item including adjastments, promotions and taxes'
+ adjustment_total:
type: string
- example: CA
- description: State abbrevation
- country_name:
+ example: '10.0'
+ description: TBD
+ display_adjustment_total:
type: string
- example: United States of America
- country_iso3:
+ example: $10.00
+ description: TBD
+ additional_tax_total:
+ type: string
+ example: '5.0'
+ display_additional_tax_total:
+ type: string
+ example: $5.00
+ discounted_amount:
+ type: string
+ example: '125.0'
+ display_discounted_amount:
+ type: string
+ example: $125.00
+ pre_tax_amount:
+ type: string
+ example: '125.0'
+ display_pre_tax_amount:
+ type: string
+ example: $125.00
+ promo_total:
+ type: string
+ example: '-5.0'
+ display_promo_total:
+ type: string
+ included_tax_total:
+ type: string
+ example: '0.0'
+ description: 'Taxes included in the price, eg. VAT'
+ display_inluded_tax_total:
+ type: string
+ example: $0.00
+ relationships:
+ properties:
+ variant:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ Promotion:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: promotion
+ attributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: 10% Discount
+ description:
type: string
- example: USA
- description: Country ISO3 code
- company:
+ example: Super discount for you
+ amount:
type: string
- nullable: true
- example: Google Inc.
- AddressList:
- required:
- - data
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Address'
- Cart:
- properties:
- data:
- $ref: '#/components/schemas/CartAttributesWithRelationships'
- included:
- type: array
- items:
- anyOf:
- - $ref: '#/components/schemas/Promotion'
- - $ref: '#/components/schemas/User'
- - $ref: '#/components/schemas/Address'
- - $ref: '#/components/schemas/ShipmentAttributesWithoutRelationsips'
- type: object
- required:
- - data
- - included
- x-examples: {}
- type: object
- description: 'Cart provides a central place around which to collect information about a customer order - including line items, adjustments, payments, addresses, return authorizations, and shipments. [Read more in Spree docs](https://dev-docs.spreecommerce.org/internals/orders)'
- CartList:
+ example: '-10.0'
+ display_amount:
+ type: string
+ example: '-$10.00'
+ Product:
required:
- data
- included
properties:
data:
- required:
- - id
- - type
- - attributes
- - relationships
- type: array
- items:
- $ref: '#/components/schemas/CartAttributesWithRelationships'
+ $ref: '#/components/schemas/ProductAttributesAndRelationships'
included:
type: array
items:
- type: object
anyOf:
+ - $ref: '#/components/schemas/OptionType'
+ - $ref: '#/components/schemas/OptionValue'
+ - $ref: '#/components/schemas/ProductProperty'
+ - $ref: '#/components/schemas/Property'
- $ref: '#/components/schemas/VariantAttributesAndRelationships'
- - $ref: '#/components/schemas/LineItem'
- - $ref: '#/components/schemas/Promotion'
- - $ref: '#/components/schemas/User'
- - $ref: '#/components/schemas/Address'
- - $ref: '#/components/schemas/ShipmentAttributesWithoutRelationsips'
- CartAttributesWithRelationships:
- description: ''
- type: object
- properties:
- id:
- type: string
- example: '1'
- pattern: ^\d+$
- type:
- type: string
- default: cart
- example: cart
- pattern: ^cart$
- attributes:
- $ref: '#/components/schemas/CartAttributes'
- relationships:
- $ref: '#/components/schemas/CartRelationships'
- CartRelationships:
- type: object
- properties:
- line_items:
- type: object
- description: ''
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- promotions:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- variants:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- user:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- billing_address:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- shipping_address:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- payments:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- shipments:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- CartAttributes:
- type: object
- properties:
- number:
- type: string
- example: R123456789
- pattern: ^R\d+$
- email:
- type: string
- format: email
- item_total:
- type: string
- example: '19.99'
- display_item_total:
- type: string
- example: $19.99
- total:
- type: string
- example: '29.99'
- display_total:
- type: string
- example: $29.99
- ship_total:
- type: string
- example: '0.0'
- display_ship_total:
- type: string
- example: $19.99
- adjustment_total:
- type: string
- example: '10.0'
- display_adjustment_total:
- type: string
- example: $10.00
- promo_total:
- type: string
- example: '-10.0'
- display_promo_total:
- type: string
- example: '-$10.00'
- created_at:
- $ref: '#/components/schemas/Timestamp'
- updated_at:
- $ref: '#/components/schemas/Timestamp'
- included_tax_total:
- type: string
- example: '5.00'
- additional_tax_total:
- type: string
- example: '5.0'
- display_additional_tax_total:
- type: string
- example: $5.00
- display_included_tax_total:
- type: string
- example: $5.00
- tax_total:
- type: string
- example: '10.0'
- display_tax_total:
- type: string
- example: $10.00
- pre_tax_item_amount:
- type: string
- example: '17.00'
- display_pre_tax_item_amount:
- type: string
- example: $17.00
- pre_tax_total:
- type: string
- example: '20.00'
- display_pre_tax_total:
- type: string
- example: $20.00
- item_count:
- type: number
- description: Total quantity number of all items added to the Cart
- example: 2
- minimum: 0
- special_instructions:
- type: string
- nullable: true
- example: Please wrap it as a gift
- description: Message added by the Customer
- currency:
- type: string
- example: USD
- state:
- type: string
- example: cart
- enum:
- - cart
- - address
- - delivery
- - payment
- - confirm
- - complete
- description: |-
- State of the Cart in the Checkout flow. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#the-order-state-machine">
- The Order State machine
- </a> for a full list with description.
- payment_state:
- type: string
- example: balance_due
- enum:
- - balance_due
- - credit_owed
- - failed
- - paid
- - void
- description: |-
- Overall state of the Payments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-payment-states">
- Order Payments states
- </a> for a full list with description.
- shipment_state:
- type: string
- example: pending
- enum:
- - backorder
- - canceled
- - partial
- - pending
- - ready
- - shipped
- description: |-
- Overall state of the Shipments. Please see <a href="https://dev-docs.spreecommerce.org/internals/orders#order-shipment-states-1">
- Order Shipments states
- </a> for a full list with description.
- token:
- type: string
- example: abcdef123456
- description: |-
- Used for authorizing any action for an Order within Spree’s API.
- CreditCardList:
+ - $ref: '#/components/schemas/Image'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ ProductsList:
required:
+ - links
+ - data
- included
properties:
+ links:
+ $ref: '#/components/schemas/ListLinks'
+ meta:
+ $ref: '#/components/schemas/ListMeta'
data:
type: array
items:
- $ref: '#/components/schemas/CreditCardAttributesWithRelationships'
+ $ref: '#/components/schemas/ProductAttributesAndRelationships'
included:
type: array
items:
- type: object
anyOf:
- - $ref: '#/components/schemas/PaymentMethod'
- CreditCard:
+ - $ref: '#/components/schemas/OptionType'
+ - $ref: '#/components/schemas/OptionValue'
+ - $ref: '#/components/schemas/ProductProperty'
+ - $ref: '#/components/schemas/Property'
+ - $ref: '#/components/schemas/VariantAttributesAndRelationships'
+ - $ref: '#/components/schemas/Image'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ ProductAttributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: Example product
+ description:
+ type: string
+ example: Example description
+ price:
+ type: string
+ example: '15.99'
+ currency:
+ type: string
+ example: USD
+ display_price:
+ type: string
+ example: $15.99
+ available_on:
+ type: string
+ example: '2012-10-17T03:43:57Z'
+ purchasable:
+ type: boolean
+ example: true
+ description: Indicates if any of Variants are in stock or backorderable
+ in_stock:
+ type: boolean
+ example: true
+ description: Indicates if any of Variants are in stock
+ backorderable:
+ type: boolean
+ example: true
+ description: Indicates if any of Variants are backeorderable
+ slug:
+ type: string
+ example: example-product
+ meta_description:
+ type: string
+ example: Example product
+ meta_keywords:
+ type: string
+ example: 'example, product'
+ updated_at:
+ $ref: '#/components/schemas/Timestamp'
+ ProductRelationships:
+ type: object
+ properties:
+ default_variant:
+ type: object
+ description: The default Variant for given product
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ product_properties:
+ type: object
+ description: List of Product Properties
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ option_types:
+ type: object
+ description: List of Product Option Types
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ variants:
+ type: object
+ description: 'List of Product Variants, excluding Master Variant'
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ taxons:
+ type: object
+ description: List of Taxons associated with Product
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ ProductAttributesAndRelationships:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: product
+ attributes:
+ $ref: '#/components/schemas/ProductAttributes'
+ relationships:
+ $ref: '#/components/schemas/ProductRelationships'
+ Relation:
+ required:
+ - id
+ - type
+ properties:
+ id:
+ type: string
+ type:
+ type: string
+ Taxon:
required:
- data
- included
properties:
data:
- $ref: '#/components/schemas/CreditCardAttributesWithRelationships'
+ $ref: '#/components/schemas/TaxonAttributesAndRelationships'
included:
type: array
items:
- type: object
anyOf:
- - $ref: '#/components/schemas/PaymentMethod'
- CreditCardAttributes:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonomyAttributesAndRelationships'
+ - $ref: '#/components/schemas/Image'
+ TaxonAttributes:
type: object
properties:
- cc_type:
+ name:
type: string
- enum:
- - visa
- - mastercard
- - amex
- example: visa
- last_digits:
+ example: T-shirts
+ pretty_name:
type: string
- example: '1232'
- description: Last 4 digits of CC number
- month:
+ example: Clothes > T-shirts
+ permalink:
type: string
- description: Expiration date month
- example: '10'
- year:
+ example: t-shirts
+ seo_title:
type: string
- example: '2019'
- description: Expiration date year
- name:
+ example: Clothes - T-shirts
+ meta_title:
type: string
- example: John Doe
- description: Card holder name
- default:
+ nullable: true
+ example: T-shirts
+ meta_description:
+ type: string
+ nullable: true
+ example: 'A list of cool t-shirts '
+ meta_keywords:
+ type: string
+ nullable: true
+ example: 't-shirts, cool'
+ left:
+ type: integer
+ example: 1
+ right:
+ type: integer
+ example: 2
+ position:
+ type: integer
+ example: 0
+ depth:
+ type: integer
+ nullable: true
+ example: 1
+ is_root:
type: boolean
example: true
- description: Defines if this is the default CC for a signed in user
- CreditCardAttributesWithRelationships:
+ description: Indicates if the Taxon is the root node of this Taxonomy tree
+ is_child:
+ type: boolean
+ example: true
+ description: Returns true is this is a child node of this Taxonomy tree
+ is_leaf:
+ type: boolean
+ example: false
+ description: Returns true if this is the end of a branch of this Taxonomy tree
+ updated_at:
+ type: string
+ example: '2018-06-18T10:57:29.704Z'
+ TaxonRelationships:
+ type: object
+ properties:
+ parent:
+ type: object
+ description: Parent node
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ children:
+ type: object
+ description: List of child nodes
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ taxonomy:
+ type: object
+ description: Taxonomy associated with this Taxon
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ image:
+ type: object
+ description: Image associated with Taxon
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ products:
+ type: object
+ description: List of active and available Products associated with this Taxon
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Relation'
+ TaxonAttributesAndRelationships:
properties:
id:
type: string
example: '1'
type:
type: string
- example: credit_card
+ default: taxon
attributes:
- $ref: '#/components/schemas/CreditCardAttributes'
+ $ref: '#/components/schemas/TaxonAttributes'
relationships:
- type: object
- properties:
- payment_method:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- Image:
- type: object
+ $ref: '#/components/schemas/TaxonRelationships'
+ x-examples: {}
+ TaxonsList:
+ required:
+ - links
+ - data
+ - included
+ properties:
+ links:
+ $ref: '#/components/schemas/ListLinks'
+ meta:
+ $ref: '#/components/schemas/ListMeta'
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ included:
+ type: array
+ items:
+ anyOf:
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonImage'
+ - $ref: '#/components/schemas/TaxonomyAttributesAndRelationships'
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ TaxonImage:
+ required:
+ - data
properties:
data:
type: object
@@ -4413,214 +6243,173 @@ components:
example: '1'
type:
type: string
- default: image
+ default: taxon_image
attributes:
type: object
properties:
position:
type: integer
- description: Sort order of images set in the Admin Panel
example: 0
- minimum: 0
+ description: Sort order of images set in the Admin Panel
styles:
type: array
description: An array of pre-scaled image styles
items:
$ref: '#/components/schemas/ImageStyle'
- required:
- - data
- ImageStyle:
- properties:
- url:
- type: string
- example: 'http://localhost:3000/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJbWQyWVhKcFlXNTBjeTltWm1sMmRURlNORFpZWjJaSFpYUkdZMjk2WWsxM1RHWXZNVGs1T1RCak5XVmlNamN4TlRnd1pqVTBabUpqTWpCbFkyVXhZMlZpTTJFd05ERTJZemMzT0dKaE5tSTFNREkyT0dKaFpqa3paV1JtWTJWaE16aGxaQVk2QmtWVSIsImV4cCI6IjIwMTgtMDYtMjRUMTM6NTk6NTguOTY5WiIsInB1ciI6ImJsb2Jfa2V5In19--5e9ff358dc747f73754e332678c5762114ac6f3f/ror_jr_spaghetti.jpeg?content_type=image%2Fjpeg&disposition=inline%3B+filename%3D%22ror_jr_spaghetti.jpeg%22%3B+filename%2A%3DUTF-8%27%27ror_jr_spaghetti.jpeg'
- description: Absolute URL of the uploaded image in selected style (width/height)
- width:
- type: integer
- example: 1920
- description: Actual width of image
- height:
- type: integer
- example: 1080
- description: Actual height of image
- User:
+ TaxonomyAttributesAndRelationships:
type: object
properties:
id:
type: string
- example: "1"
+ example: '1'
type:
type: string
- default: user
+ default: taxonomy
attributes:
- type: object
- properties:
- email:
- type: string
- format: email
- LineItem:
+ $ref: '#/components/schemas/TaxonomyAttributes'
+ TaxonomyAttributes:
+ type: object
properties:
- id:
- type: string
- example: '1'
- type:
+ name:
type: string
- default: line_item
- attributes:
+ example: Categories
+ position:
+ type: integer
+ example: 0
+ OptionType:
+ required:
+ - data
+ properties:
+ data:
type: object
properties:
- name:
- type: string
- example: Sample product
- quantity:
- type: integer
- example: 1
- slug:
- type: string
- example: sample-product
- options_text:
- type: string
- example: 'Size: small, Color: red'
- price:
- type: string
- example: '125.0'
- description: Price of Product per quantity
- currency:
- type: string
- example: USD
- display_price:
- type: string
- example: $125.00
- description: Price of Product per quantity
- total:
- type: string
- example: '250.0'
- description: 'Total price of Line Item including adjastments, promotions and taxes'
- display_total:
- type: string
- example: $250.00
- description: 'Total price of Line Item including adjastments, promotions and taxes'
- adjustment_total:
- type: string
- example: '10.0'
- description: TBD
- display_adjustment_total:
- type: string
- example: $10.00
- description: TBD
- additional_tax_total:
- type: string
- example: '5.0'
- display_additional_tax_total:
- type: string
- example: $5.00
- discounted_amount:
- type: string
- example: '125.0'
- display_discounted_amount:
- type: string
- example: $125.00
- pre_tax_amount:
- type: string
- example: '125.0'
- display_pre_tax_amount:
- type: string
- example: $125.00
- promo_total:
- type: string
- example: '-5.0'
- display_promo_total:
- type: string
- included_tax_total:
+ id:
type: string
- example: '0.0'
- description: 'Taxes included in the price, eg. VAT'
- display_inluded_tax_total:
+ example: '1'
+ type:
type: string
- example: $0.00
- relationships:
- properties:
- variant:
+ default: option_type
+ attributes:
type: object
properties:
- data:
- $ref: '#/components/schemas/Relation'
- Promotion:
+ name:
+ type: string
+ example: color
+ presentation:
+ type: string
+ example: Color
+ position:
+ type: integer
+ example: 1
+ OptionValue:
+ required:
+ - data
properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: promotion
- attributes:
+ data:
type: object
properties:
- name:
+ id:
type: string
- example: 10% Discount
- description:
+ example: '1'
+ type:
type: string
- example: Super discount for you
- amount:
+ default: option_value
+ attributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: red
+ presentation:
+ type: string
+ example: Red
+ position:
+ type: integer
+ example: 1
+ relationships:
+ type: object
+ properties:
+ option_type:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ Property:
+ required:
+ - data
+ properties:
+ data:
+ type: object
+ properties:
+ id:
type: string
- example: '-10.0'
- display_amount:
+ example: '1'
+ type:
type: string
- example: '-$10.00'
- Product:
+ default: property
+ attributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: material
+ presentation:
+ type: string
+ example: Material
+ ProductProperty:
required:
- data
- - included
properties:
data:
- $ref: '#/components/schemas/ProductAttributesAndRelationships'
- included:
- type: array
- items:
- anyOf:
- - $ref: '#/components/schemas/OptionType'
- - $ref: '#/components/schemas/OptionValue'
- - $ref: '#/components/schemas/ProductProperty'
- - $ref: '#/components/schemas/Property'
- - $ref: '#/components/schemas/VariantAttributesAndRelationships'
- - $ref: '#/components/schemas/Image'
- - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
- ProductsList:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: product_property
+ attributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: silk
+ presentation:
+ type: string
+ example: Silk
+ relationships:
+ type: object
+ properties:
+ property:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Property'
+ Variant:
required:
- - links
- data
- included
properties:
- links:
- $ref: '#/components/schemas/ListLinks'
- meta:
- $ref: '#/components/schemas/ListMeta'
data:
- type: array
- items:
- $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ $ref: '#/components/schemas/VariantAttributesAndRelationships'
included:
type: array
items:
anyOf:
- - $ref: '#/components/schemas/OptionType'
- - $ref: '#/components/schemas/OptionValue'
- - $ref: '#/components/schemas/ProductProperty'
- - $ref: '#/components/schemas/Property'
- - $ref: '#/components/schemas/VariantAttributesAndRelationships'
- $ref: '#/components/schemas/Image'
- - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
- ProductAttributes:
+ - $ref: '#/components/schemas/OptionValue'
+ - $ref: '#/components/schemas/OptionType'
+ description: |-
+ Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.
+
+ Variant records can track some individual properties regarding a variant, such as height, width, depth, and cost price. These properties are unique to each variant, and so are different from Product Properties, which apply to all variants of that product.
+ VariantAttributes:
type: object
properties:
- name:
- type: string
- example: Example product
- description:
+ sku:
type: string
- example: Example description
+ example: SKU-1001
price:
type: string
example: '15.99'
@@ -4630,262 +6419,280 @@ components:
display_price:
type: string
example: $15.99
- available_on:
+ weight:
type: string
- example: '2012-10-17T03:43:57Z'
+ example: '10'
+ height:
+ type: string
+ example: '10'
+ width:
+ type: string
+ example: '10'
+ depth:
+ type: string
+ example: '10'
+ is_master:
+ type: boolean
+ example: false
+ description: Indicates if Variant is the master Variant
+ options_text:
+ type: string
+ example: 'Size: small, Color: red'
purchasable:
type: boolean
example: true
- description: Indicates if any of Variants are in stock or backorderable
+ description: Indicates if Variant is in stock or backorderable
in_stock:
type: boolean
example: true
- description: Indicates if any of Variants are in stock
+ description: Indicates if Variant is in stock
backorderable:
type: boolean
example: true
- description: Indicates if any of Variants are backeorderable
- slug:
- type: string
- example: example-product
- meta_description:
- type: string
- example: Example product
- meta_keywords:
- type: string
- example: 'example, product'
- updated_at:
- $ref: '#/components/schemas/Timestamp'
- ProductRelationships:
+ description: Indicates if Variant is backorderable
+ title: ''
+ description: ''
+ VariantRelationships:
type: object
properties:
- default_variant:
+ product:
type: object
- description: The default Variant for given product
properties:
data:
$ref: '#/components/schemas/Relation'
- product_properties:
- type: object
- description: List of Product Properties
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- option_types:
- type: object
- description: List of Product Option Types
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- variants:
+ images:
type: object
- description: 'List of Product Variants, excluding Master Variant'
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
- taxons:
+ option_values:
type: object
- description: List of Taxons associated with Product
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
- ProductAttributesAndRelationships:
+ VariantAttributesAndRelationships:
properties:
id:
type: string
example: '1'
type:
type: string
- default: product
+ default: variant
attributes:
- $ref: '#/components/schemas/ProductAttributes'
+ $ref: '#/components/schemas/VariantAttributes'
relationships:
- $ref: '#/components/schemas/ProductRelationships'
- Relation:
- required:
- - id
- - type
- properties:
- id:
- type: string
- type:
- type: string
- Taxon:
+ $ref: '#/components/schemas/VariantRelationships'
+ Country:
required:
- data
- included
properties:
data:
- $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ $ref: '#/components/schemas/CountryAttributesAndRelationships'
included:
type: array
items:
anyOf:
- - $ref: '#/components/schemas/ProductAttributesAndRelationships'
- - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
- - $ref: '#/components/schemas/TaxonomyAttributesAndRelationships'
- - $ref: '#/components/schemas/Image'
- TaxonAttributes:
+ - $ref: '#/components/schemas/State'
+ description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://dev-docs.spreecommerce.org/internals/addresses#countries)'
+ CountriesList:
+ required:
+ - data
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/CountryAttributesAndRelationships'
+ title: List of Countries
+ CountryAttributes:
type: object
properties:
- name:
- type: string
- example: T-shirts
- pretty_name:
- type: string
- example: Clothes > T-shirts
- permalink:
- type: string
- example: t-shirts
- seo_title:
+ iso:
type: string
- example: Clothes - T-shirts
- meta_title:
+ example: us
+ iso3:
type: string
- nullable: true
- example: T-shirts
- meta_description:
+ example: usa
+ iso_name:
type: string
- nullable: true
- example: 'A list of cool t-shirts '
- meta_keywords:
+ example: UNITED STATES
+ name:
type: string
- nullable: true
- example: 't-shirts, cool'
- left:
- type: integer
- example: 1
- right:
- type: integer
- example: 2
- position:
- type: integer
- example: 0
- depth:
- type: integer
- nullable: true
- example: 1
- is_root:
+ example: United States
+ states_required:
type: boolean
example: true
- description: Indicates if the Taxon is the root node of this Taxonomy tree
- is_child:
+ zipcode_required:
type: boolean
example: true
- description: Returns true is this is a child node of this Taxonomy tree
- is_leaf:
+ default:
type: boolean
- example: false
- description: Returns true if this is the end of a branch of this Taxonomy tree
- updated_at:
- type: string
- example: '2018-06-18T10:57:29.704Z'
- TaxonRelationships:
+ example: true
+ x-examples: {}
+ CountryRelationships:
type: object
properties:
- parent:
- type: object
- description: Parent node
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- children:
- type: object
- description: List of child nodes
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- taxonomy:
+ states:
type: object
- description: Taxonomy associated with this Taxon
+ description: States associated with this Country
properties:
data:
$ref: '#/components/schemas/Relation'
- image:
+ CountryAttributesAndRelationships:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: country
+ attributes:
+ $ref: '#/components/schemas/CountryAttributes'
+ relationships:
+ $ref: '#/components/schemas/CountryRelationships'
+ State:
+ type: object
+ properties:
+ abbr:
+ type: string
+ example: NY
+ description: State abbrevation
+ name:
+ type: string
+ example: New York
+ description: State name
+ description: 'States within Spree are used to scope address data slightly more than country. States are useful for tax purposes, as different states in a country may impose different tax rates on different products. In addition to this, different states may cause different tax rates and shipping methods to be used for an order, similar to how countries affect it also.'
+ PaymentMethodsList:
+ required:
+ - data
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ PaymentMethod:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ example: payment_method
+ default: payment_method
+ attributes:
type: object
- description: Image associated with Taxon
properties:
- data:
- $ref: '#/components/schemas/Relation'
- products:
+ type:
+ type: string
+ example: 'Spree::Gateway::StripeGateway'
+ name:
+ type: string
+ example: Stripe
+ description:
+ type: string
+ example: Stripe Payments
+ ShipmentAttributesWithoutRelationsips:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: shipment
+ attributes:
+ $ref: '#/components/schemas/ShipmentAttributes'
+ relationships:
type: object
- description: List of active and available Products associated with this Taxon
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- TaxonAttributesAndRelationships:
+ ShipmentAttributesAndRelationsips:
properties:
id:
type: string
example: '1'
type:
type: string
- default: taxon
+ default: shipment
attributes:
- $ref: '#/components/schemas/TaxonAttributes'
+ $ref: '#/components/schemas/ShipmentAttributes'
relationships:
- $ref: '#/components/schemas/TaxonRelationships'
- x-examples: {}
- TaxonsList:
+ properties:
+ stock_location:
+ type: object
+ properties:
+ data:
+ $ref: '#/components/schemas/Relation'
+ shipping_rates:
+ properties:
+ data:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/Relation'
+ ShipmentAttributes:
+ properties:
+ number:
+ type: string
+ example: H121354
+ description: Unique Shipment identifier
+ free:
+ type: boolean
+ example: true
+ description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
+ final_price:
+ type: string
+ example: '10.0'
+ description: Price to be presented for the Customer
+ display_final_price:
+ type: string
+ example: $10.00
+ tracking_url:
+ type: string
+ example: 'https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=4123412434%2C'
+ description: Tracking URL to the service provider website
+ state:
+ type: string
+ example: shipped
+ enum:
+ - pending
+ - ready
+ - shipped
+ - canceled
+ description: |-
+ Status of the Shipment. For a list of all available statuses please refer: <a href="https://dev-docs.spreecommerce.org/internals/shipments" target="_blank" rel="noopener">
+ Shipment section in Spree Guides
+ </a>
+ shipped_at:
+ type: string
+ format: date-time
+ example: '2019-01-02 13:42:12'
+ description: Date when Shipment was being sent from the warehouse
+ ShippingRatesList:
required:
- - links
- data
- included
properties:
- links:
- $ref: '#/components/schemas/ListLinks'
- meta:
- $ref: '#/components/schemas/ListMeta'
data:
type: array
items:
- $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ $ref: '#/components/schemas/ShipmentAttributesAndRelationsips'
included:
type: array
items:
anyOf:
- - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
- - $ref: '#/components/schemas/TaxonImage'
- - $ref: '#/components/schemas/TaxonomyAttributesAndRelationships'
- - $ref: '#/components/schemas/ProductAttributesAndRelationships'
- TaxonImage:
+ - $ref: '#/components/schemas/ShippingRate'
+ - $ref: '#/components/schemas/StockLocation'
+ EstimateShippingRatesList:
required:
- data
properties:
data:
- type: object
- properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: taxon_image
- attributes:
- type: object
- properties:
- position:
- type: integer
- example: 0
- description: Sort order of images set in the Admin Panel
- styles:
- type: array
- description: An array of pre-scaled image styles
- items:
- $ref: '#/components/schemas/ImageStyle'
- TaxonomyAttributesAndRelationships:
+ type: array
+ items:
+ $ref: '#/components/schemas/ShippingRate'
+ ShippingRate:
type: object
properties:
id:
@@ -4893,594 +6700,807 @@ components:
example: '1'
type:
type: string
- default: taxonomy
+ default: shipping_rate
attributes:
- $ref: '#/components/schemas/TaxonomyAttributes'
- TaxonomyAttributes:
- type: object
- properties:
- name:
- type: string
- example: Categories
- position:
- type: integer
- example: 0
- OptionType:
- required:
- - data
- properties:
- data:
type: object
properties:
- id:
+ name:
type: string
- example: '1'
- type:
+ example: USPS Ground
+ selected:
+ type: boolean
+ example: true
+ free:
+ type: boolean
+ example: true
+ description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
+ final_price:
type: string
- default: option_type
- attributes:
- type: object
- properties:
- name:
- type: string
- example: color
- presentation:
- type: string
- example: Color
- position:
- type: integer
- example: 1
- OptionValue:
- required:
- - data
+ example: '10.0'
+ description: Price to be presented for the Customer
+ display_final_price:
+ type: string
+ example: $10.00
+ cost:
+ type: string
+ example: '10.0'
+ description: Price of the service without discounts applied
+ display_cost:
+ type: string
+ example: $10.00
+ tax_amount:
+ type: string
+ example: '0.0'
+ description: Eligible tax for service (if any)
+ display_tax_amount:
+ type: string
+ example: $0.00
+ shipping_method_id:
+ type: integer
+ example: 1
+ description: ID of a Shipping Method. You will need this for the Checkout Update action
+ StockLocation:
properties:
- data:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: stock_location
+ attributes:
type: object
properties:
- id:
- type: string
- example: '1'
- type:
+ name:
type: string
- default: option_value
- attributes:
- type: object
- properties:
- name:
- type: string
- example: red
- presentation:
- type: string
- example: Red
- position:
- type: integer
- example: 1
- relationships:
- type: object
- properties:
- option_type:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- Property:
+ example: Main Warehouse
+ Account:
+ properties:
+ data:
+ $ref: '#/components/schemas/AccountAttributesAndRelationships'
+ included:
+ type: array
+ items:
+ anyOf:
+ - $ref: '#/components/schemas/Address'
required:
- data
+ - included
+ type: object
+ AccountAttributes:
+ type: object
properties:
- data:
+ email:
+ type: string
+ store_credits:
+ type: number
+ example: 150.75
+ completed_orders:
+ type: number
+ example: 3
+ description: Number of placed Orders by this User
+ AccountRelationships:
+ type: object
+ properties:
+ default_billing_address:
type: object
+ description: Default billing address associated with this Account
properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: property
- attributes:
- type: object
- properties:
- name:
- type: string
- example: material
- presentation:
- type: string
- example: Material
- ProductProperty:
- required:
- - data
- properties:
- data:
+ data:
+ $ref: '#/components/schemas/Relation'
+ default_shipping_address:
type: object
+ description: Default shipping address associated with this Account
properties:
- id:
- type: string
- example: '1'
- type:
- type: string
- default: product_property
- attributes:
- type: object
- properties:
- name:
- type: string
- example: silk
- presentation:
- type: string
- example: Silk
- relationships:
- type: object
- properties:
- property:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Property'
- Variant:
+ data:
+ $ref: '#/components/schemas/Relation'
+ AccountAttributesAndRelationships:
+ properties:
+ id:
+ type: string
+ example: '1'
+ type:
+ type: string
+ default: user
+ attributes:
+ $ref: '#/components/schemas/AccountAttributes'
+ relationships:
+ $ref: '#/components/schemas/AccountRelationships'
+ AddressPayload:
+ example:
+ firstname: John
+ lastname: Snow
+ address1: 7735 Old Georgetown Road
+ address2: 2nd Floor
+ city: Bethesda
+ phone: '3014445002'
+ zipcode: '20814'
+ state_name: MD
+ country_iso: US
+ type: object
+ properties:
+ firstname:
+ type: string
+ lastname:
+ type: string
+ address1:
+ type: string
+ description: Street address
+ address2:
+ type: string
+ description: 'Additional address information, floor no etc'
+ city:
+ type: string
+ description: 'City, town'
+ phone:
+ type: string
+ zipcode:
+ type: string
+ description: 'Valid zipcode, will be validated against the selected Country'
+ state_name:
+ type: string
+ description: State/region/province 2 letter abbrevation
+ country_iso:
+ type: string
+ description: 'Country ISO (2-chars) or ISO3 (3-chars) code. [List of all codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)'
+ required:
+ - firstname
+ - lastname
+ - address1
+ - city
+ - phone
+ - zipcode
+ - state_name
+ - country_iso
+ CmsPage:
required:
- data
- included
properties:
data:
- $ref: '#/components/schemas/VariantAttributesAndRelationships'
+ $ref: '#/components/schemas/CmsPageAttributesAndRelationships'
included:
type: array
items:
anyOf:
- - $ref: '#/components/schemas/Image'
- - $ref: '#/components/schemas/OptionValue'
- - $ref: '#/components/schemas/OptionType'
- description: |-
- Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.
-
- Variant records can track some individual properties regarding a variant, such as height, width, depth, and cost price. These properties are unique to each variant, and so are different from Product Properties, which apply to all variants of that product.
- VariantAttributes:
+ - $ref: '#/components/schemas/CmsHeroImageSection'
+ - $ref: '#/components/schemas/CmsFeaturedAtricleSection'
+ - $ref: '#/components/schemas/CmsProductCarouselSection'
+ - $ref: '#/components/schemas/CmsSideBySideImagesSection'
+ - $ref: '#/components/schemas/CmsImageGallerySection'
+ description: CMS Page
+ CmsPagesList:
+ description: CMS Page List
type: object
properties:
- sku:
- type: string
- example: SKU-1001
- price:
- type: string
- example: '15.99'
- currency:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/CmsPageAttributesAndRelationships'
+ included:
+ type: array
+ items:
+ anyOf:
+ - $ref: '#/components/schemas/CmsHeroImageSection'
+ - $ref: '#/components/schemas/CmsFeaturedAtricleSection'
+ - $ref: '#/components/schemas/CmsProductCarouselSection'
+ - $ref: '#/components/schemas/CmsSideBySideImagesSection'
+ - $ref: '#/components/schemas/CmsImageGallerySection'
+ required:
+ - data
+ CmsPageAttributes:
+ type: object
+ properties:
+ title:
type: string
- example: USD
- display_price:
+ content:
type: string
- example: $15.99
- weight:
+ nullable: true
+ locale:
type: string
- example: '10'
- height:
+ meta_description:
+ nullable: true
type: string
- example: '10'
- width:
+ meta_title:
+ nullable: true
type: string
- example: '10'
- depth:
+ slug:
type: string
- example: '10'
- is_master:
- type: boolean
- example: false
- description: Indicates if Variant is the master Variant
- options_text:
+ nullable: true
+ type:
type: string
- example: 'Size: small, Color: red'
- purchasable:
- type: boolean
- example: true
- description: Indicates if Variant is in stock or backorderable
- in_stock:
- type: boolean
- example: true
- description: Indicates if Variant is in stock
- backorderable:
- type: boolean
- example: true
- description: Indicates if Variant is backorderable
- title: ''
- description: ''
- VariantRelationships:
+ CmsPageAttributesAndRelationships:
type: object
properties:
- product:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- images:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- option_values:
+ id:
+ type: string
+ type:
+ type: string
+ attributes:
+ $ref: '#/components/schemas/CmsPageAttributes'
+ relationships:
type: object
properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Relation'
- VariantAttributesAndRelationships:
+ cms_sections:
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/Relation'
+ CmsHeroImageSection:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '1'
+ description: CMS Section ID
+ type:
+ type: string
+ example: cms_section
+ description: CMS Section
+ attributes:
+ $ref: '#/components/schemas/CmsHeroSectionAttributes'
+ included:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ CmsFeaturedAtricleSection:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '2'
+ description: CMS Section ID
+ type:
+ type: string
+ example: cms_section
+ description: CMS Section
+ attributes:
+ $ref: '#/components/schemas/CmsFeaturedAtricleSectionAttributes'
+ included:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ - $ref: '#/components/schemas/CmsPageAttributesAndRelationships'
+ CmsProductCarouselSection:
+ type: object
+ properties:
+ id:
+ type: string
+ example: '3'
+ description: CMS Section ID
+ type:
+ type: string
+ example: cms_section
+ description: CMS Section
+ attributes:
+ $ref: '#/components/schemas/CmsProductCarouselSectionAttributes'
+ included:
+ type: array
+ items:
+ oneOf:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ CmsSideBySideImagesSection:
+ type: object
properties:
id:
type: string
- example: '1'
+ example: '4'
+ description: CMS Section ID
type:
type: string
- default: variant
+ example: cms_section
+ description: CMS Section
attributes:
- $ref: '#/components/schemas/VariantAttributes'
- relationships:
- $ref: '#/components/schemas/VariantRelationships'
- Country:
- required:
- - data
- - included
- properties:
- data:
- $ref: '#/components/schemas/CountryAttributesAndRelationships'
+ $ref: '#/components/schemas/CmsSideBySideImagesSectionAttributes'
included:
type: array
items:
- anyOf:
- - $ref: '#/components/schemas/State'
- description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://dev-docs.spreecommerce.org/internals/addresses#countries)'
- CountriesList:
- required:
- - data
+ oneOf:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ CmsImageGallerySection:
+ type: object
properties:
- data:
+ id:
+ type: string
+ example: '5'
+ description: CMS Section ID
+ type:
+ type: string
+ example: cms_section
+ description: CMS Section
+ attributes:
+ $ref: '#/components/schemas/CmsImageGallerySectionAttributes'
+ included:
type: array
items:
- $ref: '#/components/schemas/CountryAttributesAndRelationships'
- title: List of Countries
- CountryAttributes:
+ oneOf:
+ - $ref: '#/components/schemas/ProductAttributesAndRelationships'
+ - $ref: '#/components/schemas/TaxonAttributesAndRelationships'
+ CmsHeroSectionAttributes:
type: object
properties:
- iso:
+ name:
type: string
- example: us
- iso3:
+ example: Main Hero
+ content:
+ $ref: '#/components/schemas/CmsHeroSectionContent'
+ settings:
+ $ref: '#/components/schemas/CmsHeroSectionSettings'
+ link:
type: string
- example: usa
- iso_name:
+ example: /t/categories/summer-collection
+ fit:
type: string
- example: UNITED STATES
- name:
+ example: Screen
+ type:
type: string
- example: United States
- states_required:
- type: boolean
- example: true
- zipcode_required:
+ example: 'Spree::Cms::Sections::HeroImage'
+ position:
+ type: integer
+ example: 1
+ image_one_sm:
+ type: string
+ example: /rails/active_storage/representations/redirect/eyJfc--eldkxjen/main_hero.jpg
+ image_one_md:
+ type: string
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/main_hero.jpg
+ image_one_lg:
+ type: string
+ example: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/main_hero.jpg
+ image_one_xl:
+ type: string
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/main_hero.jpg
+ image_two_sm:
+ type: string
+ nullable: true
+ example: null
+ image_two_md:
+ type: string
+ nullable: true
+ example: null
+ image_two_lg:
+ type: string
+ nullable: true
+ example: null
+ image_two_xl:
+ type: string
+ nullable: true
+ example: null
+ image_three_sm:
+ type: string
+ nullable: true
+ example: null
+ image_three_md:
+ type: string
+ nullable: true
+ example: null
+ image_three_lg:
+ type: string
+ nullable: true
+ example: null
+ image_three_xl:
+ type: string
+ nullable: true
+ example: null
+ is_full_screen:
type: boolean
example: true
- default:
+ CmsFeaturedAtricleSectionAttributes:
+ type: object
+ properties:
+ name:
+ type: string
+ example: Fashion Trends
+ content:
+ $ref: '#/components/schemas/CmsFeaturedAtricleSectionContent'
+ settings:
+ $ref: '#/components/schemas/CmsFeaturedAtricleSectionSettings'
+ link:
+ type: string
+ example: /t/categories/trending
+ fit:
+ type: string
+ example: Screen
+ type:
+ type: string
+ example: 'Spree::Cms::Sections::FeaturedArticle'
+ position:
+ type: integer
+ example: 2
+ image_one_sm:
+ type: string
+ nullable: true
+ example: null
+ image_one_md:
+ type: string
+ nullable: true
+ example: null
+ image_one_lg:
+ type: string
+ nullable: true
+ example: null
+ image_one_xl:
+ type: string
+ nullable: true
+ example: null
+ image_two_sm:
+ type: string
+ nullable: true
+ example: null
+ image_two_md:
+ type: string
+ nullable: true
+ example: null
+ image_two_lg:
+ type: string
+ nullable: true
+ example: null
+ image_two_xl:
+ type: string
+ nullable: true
+ example: null
+ image_three_sm:
+ type: string
+ nullable: true
+ example: null
+ image_three_md:
+ type: string
+ nullable: true
+ example: null
+ image_three_lg:
+ type: string
+ nullable: true
+ example: null
+ image_three_xl:
+ type: string
+ nullable: true
+ example: null
+ is_full_screen:
type: boolean
example: true
- x-examples: {}
- CountryRelationships:
+ CmsProductCarouselSectionAttributes:
type: object
properties:
- states:
- type: object
- description: States associated with this Country
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- CountryAttributesAndRelationships:
- properties:
- id:
+ name:
type: string
- example: '1'
+ example: Best Sellers Carousel
+ content:
+ type: string
+ nullable: true
+ example: null
+ settings:
+ type: string
+ nullable: true
+ example: null
+ link:
+ type: string
+ example: /t/categories/bestsellers
+ fit:
+ type: string
+ example: Screen
type:
type: string
- default: country
- attributes:
- $ref: '#/components/schemas/CountryAttributes'
- relationships:
- $ref: '#/components/schemas/CountryRelationships'
- State:
+ example: 'Spree::Cms::Sections::ProductCarousel'
+ position:
+ type: integer
+ example: 3
+ image_one_sm:
+ type: string
+ nullable: true
+ example: null
+ image_one_md:
+ type: string
+ nullable: true
+ example: null
+ image_one_lg:
+ type: string
+ nullable: true
+ example: null
+ image_one_xl:
+ type: string
+ nullable: true
+ example: null
+ image_two_sm:
+ type: string
+ nullable: true
+ example: null
+ image_two_md:
+ type: string
+ nullable: true
+ example: null
+ image_two_lg:
+ type: string
+ nullable: true
+ example: null
+ image_two_xl:
+ type: string
+ nullable: true
+ example: null
+ image_three_sm:
+ type: string
+ nullable: true
+ example: null
+ image_three_md:
+ type: string
+ nullable: true
+ example: null
+ image_three_lg:
+ type: string
+ nullable: true
+ example: null
+ image_three_xl:
+ type: string
+ nullable: true
+ example: null
+ is_full_screen:
+ type: boolean
+ example: true
+ CmsSideBySideImagesSectionAttributes:
type: object
properties:
- abbr:
- type: string
- example: NY
- description: State abbrevation
name:
type: string
- example: New York
- description: State name
- description: 'States within Spree are used to scope address data slightly more than country. States are useful for tax purposes, as different states in a country may impose different tax rates on different products. In addition to this, different states may cause different tax rates and shipping methods to be used for an order, similar to how countries affect it also.'
- PaymentMethodsList:
- required:
- - data
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/PaymentMethod'
- PaymentMethod:
- properties:
- id:
+ example: Promotions
+ content:
+ $ref: '#/components/schemas/CmsSideBySideImagesSectionContent'
+ settings:
+ $ref: '#/components/schemas/CmsSideBySideImagesSectionSettings'
+ link:
type: string
- example: '1'
+ example: /t/categories/summer-collection
+ fit:
+ type: string
+ example: Container
type:
type: string
- example: payment_method
- default: payment_method
- attributes:
- type: object
- properties:
- type:
- type: string
- example: 'Spree::Gateway::StripeGateway'
- name:
- type: string
- example: Stripe
- description:
- type: string
- example: Stripe Payments
- ShipmentAttributesWithoutRelationsips:
+ example: 'Spree::Cms::Sections::SideBySideImages'
+ position:
+ type: integer
+ example: 4
+ image_one_sm:
+ type: string
+ nullable: true
+ example: null
+ image_one_md:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/promo_left.jpg
+ image_one_lg:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/promo_left.jpg
+ image_one_xl:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/promo_left.jpg
+ image_two_sm:
+ type: string
+ nullable: true
+ example: null
+ image_two_md:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/promo_right.jpg
+ image_two_lg:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/promo_right.jpg
+ image_two_xl:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/promo_right.jpg
+ image_three_sm:
+ type: string
+ nullable: true
+ example: null
+ image_three_md:
+ type: string
+ nullable: true
+ example: null
+ image_three_lg:
+ type: string
+ nullable: true
+ example: null
+ image_three_xl:
+ type: string
+ nullable: true
+ example: null
+ is_full_screen:
+ type: boolean
+ example: false
+ CmsImageGallerySectionAttributes:
+ type: object
properties:
- id:
+ name:
type: string
- example: '1'
+ example: Main Taxons
+ content:
+ $ref: '#/components/schemas/CmsImageGallerySectionContent'
+ settings:
+ $ref: '#/components/schemas/CmsImageGallerySectionSettings'
+ link:
+ type: string
+ nullable: true
+ example: null
+ fit:
+ type: string
+ example: Container
type:
type: string
- default: shipment
- attributes:
- $ref: '#/components/schemas/ShipmentAttributes'
- relationships:
- type: object
- ShipmentAttributesAndRelationsips:
- properties:
- id:
+ example: 'Spree::Cms::Sections::ImageGallery'
+ position:
+ type: integer
+ example: 5
+ image_one_sm:
+ type: string
+ nullable: true
+ example: null
+ image_one_md:
type: string
- example: '1'
- type:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/top_img.jpg
+ image_one_lg:
type: string
- default: shipment
- attributes:
- $ref: '#/components/schemas/ShipmentAttributes'
- relationships:
- properties:
- stock_location:
- type: object
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- shipping_rates:
- properties:
- data:
- type: array
- items:
- oneOf:
- - $ref: '#/components/schemas/Relation'
- ShipmentAttributes:
- properties:
- number:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/top_img.jpg
+ image_one_xl:
type: string
- example: H121354
- description: Unique Shipment identifier
- free:
- type: boolean
- example: true
- description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
- final_price:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/top_img.jpg
+ image_two_sm:
type: string
- example: '10.0'
- description: Price to be presented for the Customer
- display_final_price:
+ nullable: true
+ example: null
+ image_two_md:
type: string
- example: $10.00
- tracking_url:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/tall_img.jpg
+ image_two_lg:
type: string
- example: 'https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=4123412434%2C'
- description: Tracking URL to the service provider website
- state:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/tall_img.jpg
+ image_two_xl:
type: string
- example: shipped
- enum:
- - pending
- - ready
- - shipped
- - canceled
- description: |-
- Status of the Shipment. For a list of all available statuses please refer: <a href="https://dev-docs.spreecommerce.org/internals/shipments" target="_blank" rel="noopener">
- Shipment section in Spree Guides
- </a>
- shipped_at:
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/tall_img.jpg
+ image_three_sm:
type: string
- format: date-time
- example: '2019-01-02 13:42:12'
- description: Date when Shipment was being sent from the warehouse
- ShippingRatesList:
- required:
- - data
- - included
+ nullable: true
+ example: null
+ image_three_md:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/bottom_img.jpg
+ image_three_lg:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/bottom_img.jpg
+ image_three_xl:
+ type: string
+ nullable: true
+ example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/bottom_img.jpg
+ is_full_screen:
+ type: boolean
+ example: false
+ CmsHeroSectionContent:
+ type: object
properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/ShipmentAttributesAndRelationsips'
- included:
- type: array
- items:
- anyOf:
- - $ref: '#/components/schemas/ShippingRate'
- - $ref: '#/components/schemas/StockLocation'
- EstimateShippingRatesList:
- required:
- - data
+ title:
+ type: string
+ example: Summer Collection
+ button_text:
+ type: string
+ example: Shop Now
+ CmsHeroSectionSettings:
+ type: object
properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/ShippingRate'
- ShippingRate:
+ gutters:
+ type: string
+ example: No Gutters
+ CmsFeaturedAtricleSectionContent:
type: object
properties:
- id:
+ title:
type: string
- example: '1'
- type:
+ example: Summer 2021
+ subtitle:
type: string
- default: shipping_rate
- attributes:
- type: object
- properties:
- name:
- type: string
- example: USPS Ground
- selected:
- type: boolean
- example: true
- free:
- type: boolean
- example: true
- description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
- final_price:
- type: string
- example: '10.0'
- description: Price to be presented for the Customer
- display_final_price:
- type: string
- example: $10.00
- cost:
- type: string
- example: '10.0'
- description: Price of the service without discounts applied
- display_cost:
- type: string
- example: $10.00
- tax_amount:
- type: string
- example: '0.0'
- description: Eligible tax for service (if any)
- display_tax_amount:
- type: string
- example: $0.00
- shipping_method_id:
- type: integer
- example: 1
- description: ID of a Shipping Method. You will need this for the Checkout Update action
- StockLocation:
- properties:
- id:
+ example: Fashion Trends
+ button_text:
type: string
- example: '1'
- type:
+ example: Read More
+ rte_content:
type: string
- default: stock_location
- attributes:
- type: object
- properties:
- name:
- type: string
- example: Main Warehouse
- Account:
- properties:
- data:
- $ref: '#/components/schemas/AccountAttributesAndRelationships'
- included:
- type: array
- items:
- anyOf:
- - $ref: '#/components/schemas/Address'
- required:
- - data
- - included
- type: object
- AccountAttributes:
+ example: '<div style="text-center">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.</div>'
+ CmsFeaturedAtricleSectionSettings:
type: object
properties:
- email:
+ gutters:
type: string
- store_credits:
- type: number
- example: 150.75
- completed_orders:
- type: number
- example: 3
- description: Number of placed Orders by this User
- AccountRelationships:
+ example: No Gutters
+ CmsSideBySideImagesSectionContent:
type: object
properties:
- default_billing_address:
- type: object
- description: Default billing address associated with this Account
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- default_shipping_address:
- type: object
- description: Default shipping address associated with this Account
- properties:
- data:
- $ref: '#/components/schemas/Relation'
- AccountAttributesAndRelationships:
- properties:
- id:
+ link_type_one:
type: string
- example: '1'
- type:
+ example: 'Spree::Taxon'
+ link_type_two:
type: string
- default: user
- attributes:
- $ref: '#/components/schemas/AccountAttributes'
- relationships:
- $ref: '#/components/schemas/AccountRelationships'
- AddressPayload:
- example:
- firstname: John
- lastname: Snow
- address1: 7735 Old Georgetown Road
- address2: 2nd Floor
- city: Bethesda
- phone: '3014445002'
- zipcode: '20814'
- state_name: MD
- country_iso: US
+ example: 'Spree::Taxon'
+ title_one:
+ type: string
+ example: New Collection
+ subtitle_one:
+ type: string
+ example: Street Style
+ link_one:
+ type: string
+ example: categories/streetstyle
+ title_two:
+ type: string
+ example: Summer Sale
+ subtitle_two:
+ type: string
+ example: Up To 30% OFF
+ link_two:
+ type: string
+ example: categories/special-offers/30-percent-off
+ CmsSideBySideImagesSectionSettings:
type: object
properties:
- firstname:
+ gutters:
type: string
- lastname:
+ example: Gutters
+ CmsImageGallerySectionContent:
+ type: object
+ properties:
+ link_type_one:
type: string
- address1:
+ example: 'Spree::Taxon'
+ link_type_two:
type: string
- description: Street address
- address2:
+ example: 'Spree::Taxon'
+ link_type_three:
type: string
- description: 'Additional address information, floor no etc'
- city:
+ example: 'Spree::Taxon'
+ link_one:
type: string
- description: 'City, town'
- phone:
+ example: categories/men
+ link_two:
type: string
- zipcode:
+ example: categories/women
+ link_three:
type: string
- description: 'Valid zipcode, will be validated against the selected Country'
- state_name:
+ example: categories/sportswear
+ title_one:
type: string
- description: State/region/province 2 letter abbrevation
- country_iso:
+ example: Men
+ title_two:
type: string
- description: 'Country ISO (2-chars) or ISO3 (3-chars) code. [List of all codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)'
- required:
- - firstname
- - lastname
- - address1
- - city
- - phone
- - zipcode
- - state_name
- - country_iso
+ example: Women
+ title_three:
+ type: string
+ example: Sportswear
+ CmsImageGallerySectionSettings:
+ type: object
+ properties:
+ layout_style:
+ type: string
+ example: Default
+ display_labels:
+ type: string
+ example: Show
+
+
parameters:
Id:
name: id
@@ -5490,6 +7510,21 @@ components:
schema:
type: string
example: '1'
+ CmsPageSlug:
+ name: cms_page_slug
+ in: path
+ required: true
+ description: CMS Page Slug
+ schema:
+ type: string
+ example: about-us
+ CmsPageIncludeParam:
+ name: include
+ in: query
+ description: 'Pass `cms_sections` as an include value to fetch the CMS Sections associated with each CMS Page. If you need to fetch the CMS Sections Linked Resource, you can pass `cms_sections.linked_resource`.'
+ schema:
+ type: string
+ example: cms_sections.linked_resource
CreditCardIncludeParam:
name: include
in: query
@@ -5628,6 +7663,20 @@ components:
type: string
example: rails
description: 'Find resources with matching name (supports wild-card, partial-word match search)'
+ FilterByTitle:
+ name: 'filter[title]'
+ in: query
+ description: Fetch only resources with correspondingTitle
+ schema:
+ type: string
+ example: About Us
+ FilterByType:
+ name: 'filter[type]'
+ in: query
+ description: Fetch only resources with corresponding Type
+ schema:
+ type: string
+ example: home
SparseFieldsParam:
in: query
name: fields
@@ -5669,6 +7718,7 @@ tags:
- name: Cart
- name: Checkout
- name: Countries
+ - name: CMS Pages
- name: Order Status
- name: Products
- name: Taxons