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 Roles Endpoints to Platform API (#11471)

Aleksandar Petrushev74d3677560f6
diff --git a/api/app/controllers/spree/api/v2/platform/roles_controller.rb b/api/app/controllers/spree/api/v2/platform/roles_controller.rb
new file mode 100644
index 0000000000..379f8170b1
--- /dev/null
+++ b/api/app/controllers/spree/api/v2/platform/roles_controller.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ class RolesController < ResourceController
+ private
+
+ def model_class
+ Spree::Role
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/config/routes.rb b/api/config/routes.rb
index 6a45f09a61..122fa3223d 100644
--- a/api/config/routes.rb
+++ b/api/config/routes.rb
@@ -271,6 +271,8 @@ Spree::Core::Engine.add_routes do
resources :credit_cards
resources :addresses
+ resources :roles
+
# Menu API
resources :menus
resources :menu_items do
diff --git a/api/docs/v2/platform/index.yaml b/api/docs/v2/platform/index.yaml
index fd7a493a5a..bd8cd3b225 100644
--- a/api/docs/v2/platform/index.yaml
+++ b/api/docs/v2/platform/index.yaml
@@ -70,8 +70,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-05T11:29:22.224Z'
- updated_at: '2021-11-05T11:29:22.224Z'
+ created_at: '2021-11-08T11:37:44.795Z'
+ updated_at: '2021-11-08T11:37:44.795Z'
deleted_at:
label:
public_metadata: {}
@@ -100,8 +100,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-05T11:29:22.231Z'
- updated_at: '2021-11-05T11:29:22.231Z'
+ created_at: '2021-11-08T11:37:44.802Z'
+ updated_at: '2021-11-08T11:37:44.802Z'
deleted_at:
label:
public_metadata: {}
@@ -177,8 +177,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-05T11:29:22.581Z'
- updated_at: '2021-11-05T11:29:22.581Z'
+ created_at: '2021-11-08T11:37:45.173Z'
+ updated_at: '2021-11-08T11:37:45.173Z'
deleted_at:
label:
public_metadata: {}
@@ -274,8 +274,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-05T11:29:22.650Z'
- updated_at: '2021-11-05T11:29:22.650Z'
+ created_at: '2021-11-08T11:37:45.271Z'
+ updated_at: '2021-11-08T11:37:45.271Z'
deleted_at:
label:
public_metadata: {}
@@ -356,8 +356,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-11-05T11:29:22.761Z'
- updated_at: '2021-11-05T11:29:22.773Z'
+ created_at: '2021-11-08T11:37:45.415Z'
+ updated_at: '2021-11-08T11:37:45.434Z'
deleted_at:
label:
public_metadata: {}
@@ -503,8 +503,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-05T11:29:23.116Z'
- updated_at: '2021-11-05T11:29:23.116Z'
+ created_at: '2021-11-08T11:37:45.809Z'
+ updated_at: '2021-11-08T11:37:45.809Z'
state: open
included: false
display_amount: "$100.00"
@@ -530,8 +530,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-05T11:29:23.148Z'
- updated_at: '2021-11-05T11:29:23.148Z'
+ created_at: '2021-11-08T11:37:45.847Z'
+ updated_at: '2021-11-08T11:37:45.847Z'
state: open
included: false
display_amount: "$100.00"
@@ -604,8 +604,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-05T11:29:23.554Z'
- updated_at: '2021-11-05T11:29:23.554Z'
+ created_at: '2021-11-08T11:37:46.288Z'
+ updated_at: '2021-11-08T11:37:46.288Z'
state: open
included: false
display_amount: "$100.00"
@@ -687,8 +687,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-11-05T11:29:23.742Z'
- updated_at: '2021-11-05T11:29:23.750Z'
+ created_at: '2021-11-08T11:37:46.471Z'
+ updated_at: '2021-11-08T11:37:46.478Z'
state: open
included: false
display_amount: "$1.00"
@@ -766,8 +766,8 @@ paths:
label: New label
mandatory:
eligible: true
- created_at: '2021-11-05T11:29:24.061Z'
- updated_at: '2021-11-05T11:29:24.079Z'
+ created_at: '2021-11-08T11:37:46.796Z'
+ updated_at: '2021-11-08T11:37:46.817Z'
state: open
included: false
display_amount: "$15.00"
@@ -907,8 +907,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-05T11:29:25.031Z'
- updated_at: '2021-11-05T11:29:25.031Z'
+ created_at: '2021-11-08T11:37:47.844Z'
+ updated_at: '2021-11-08T11:37:47.844Z'
relationships:
product:
data:
@@ -922,8 +922,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-05T11:29:25.152Z'
- updated_at: '2021-11-05T11:29:25.152Z'
+ created_at: '2021-11-08T11:37:47.966Z'
+ updated_at: '2021-11-08T11:37:47.966Z'
relationships:
product:
data:
@@ -984,8 +984,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-05T11:29:25.841Z'
- updated_at: '2021-11-05T11:29:25.841Z'
+ created_at: '2021-11-08T11:37:48.806Z'
+ updated_at: '2021-11-08T11:37:48.806Z'
relationships:
product:
data:
@@ -1052,8 +1052,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-05T11:29:26.130Z'
- updated_at: '2021-11-05T11:29:26.130Z'
+ created_at: '2021-11-08T11:37:49.503Z'
+ updated_at: '2021-11-08T11:37:49.503Z'
relationships:
product:
data:
@@ -1119,8 +1119,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-11-05T11:29:26.786Z'
- updated_at: '2021-11-05T11:29:26.786Z'
+ created_at: '2021-11-08T11:37:50.054Z'
+ updated_at: '2021-11-08T11:37:50.054Z'
relationships:
product:
data:
@@ -1242,8 +1242,8 @@ paths:
type: classification
attributes:
position: 2
- created_at: '2021-11-05T11:29:28.046Z'
- updated_at: '2021-11-05T11:29:28.075Z'
+ created_at: '2021-11-08T11:37:51.543Z'
+ updated_at: '2021-11-08T11:37:51.571Z'
relationships:
product:
data:
@@ -1348,35 +1348,35 @@ paths:
- id: '1'
type: cms_page
attributes:
- title: Quasi magnam eligendi perferendis eos possimus dolor.
+ title: Necessitatibus cupiditate labore vitae vel laudantium.
meta_title:
content:
meta_description:
visible: true
- slug: quasi-magnam-eligendi-perferendis-eos-possimus-dolor
+ slug: necessitatibus-cupiditate-labore-vitae-vel-laudantium
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-05T11:29:28.776Z'
- updated_at: '2021-11-05T11:29:28.776Z'
+ created_at: '2021-11-08T11:37:52.182Z'
+ updated_at: '2021-11-08T11:37:52.182Z'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
- title: Dolorum recusandae dolorem earum magni fugit quisquam
- unde.
+ title: Delectus quibusdam facere tempore corporis dolores
+ dignissimos.
meta_title:
content:
meta_description:
visible: true
- slug: dolorum-recusandae-dolorem-earum-magni-fugit-quisquam-unde
+ slug: delectus-quibusdam-facere-tempore-corporis-dolores-dignissimos
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-05T11:29:28.782Z'
- updated_at: '2021-11-05T11:29:28.782Z'
+ created_at: '2021-11-08T11:37:52.187Z'
+ updated_at: '2021-11-08T11:37:52.187Z'
relationships:
cms_sections:
data: []
@@ -1430,18 +1430,18 @@ paths:
id: '5'
type: cms_page
attributes:
- title: Corporis in earum suscipit ipsum quos possimus perferendis
- molestiae.
+ title: Eius ea rerum officiis possimus expedita velit dolores
+ illo.
meta_title:
content:
meta_description:
visible: true
- slug: corporis-in-earum-suscipit-ipsum-quos-possimus-perferendis-molestiae
+ slug: eius-ea-rerum-officiis-possimus-expedita-velit-dolores-illo
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-05T11:29:28.915Z'
- updated_at: '2021-11-05T11:29:28.915Z'
+ created_at: '2021-11-08T11:37:52.333Z'
+ updated_at: '2021-11-08T11:37:52.333Z'
relationships:
cms_sections:
data: []
@@ -1507,17 +1507,17 @@ paths:
id: '6'
type: cms_page
attributes:
- title: Incidunt laborum aut a harum facilis.
+ title: Reiciendis magni impedit nulla architecto occaecati.
meta_title:
content:
meta_description:
visible: true
- slug: incidunt-laborum-aut-a-harum-facilis
+ slug: reiciendis-magni-impedit-nulla-architecto-occaecati
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-05T11:29:28.997Z'
- updated_at: '2021-11-05T11:29:28.997Z'
+ created_at: '2021-11-08T11:37:52.414Z'
+ updated_at: '2021-11-08T11:37:52.414Z'
relationships:
cms_sections:
data: []
@@ -1581,12 +1581,12 @@ paths:
content:
meta_description:
visible: true
- slug: illo-non-repellendus-molestiae-voluptatum-corrupti-ab
+ slug: libero-fugit-cum-modi-a
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-11-05T11:29:29.104Z'
- updated_at: '2021-11-05T11:29:29.117Z'
+ created_at: '2021-11-08T11:37:52.614Z'
+ updated_at: '2021-11-08T11:37:52.687Z'
relationships:
cms_sections:
data: []
@@ -1715,7 +1715,8 @@ paths:
- id: '1'
type: cms_section
attributes:
- name: Odio hic sint reiciendis iste.
+ name: Corrupti facere mollitia voluptate esse voluptas repellat
+ eligendi.
content: {}
settings:
gutters: No Gutters
@@ -1724,8 +1725,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Taxon
- created_at: '2021-11-05T11:29:29.415Z'
- updated_at: '2021-11-05T11:29:29.415Z'
+ created_at: '2021-11-08T11:37:53.005Z'
+ updated_at: '2021-11-08T11:37:53.005Z'
relationships:
cms_page:
data:
@@ -1736,8 +1737,7 @@ paths:
- id: '2'
type: cms_section
attributes:
- name: Enim pariatur tenetur aperiam facilis minus esse maiores
- expedita.
+ name: Quos adipisci ea explicabo consequatur inventore voluptatem.
content:
link_type_one: Spree::Taxon
link_type_two: Spree::Taxon
@@ -1749,8 +1749,8 @@ paths:
type: Spree::Cms::Sections::ImageGallery
position: 2
linked_resource_type:
- created_at: '2021-11-05T11:29:29.420Z'
- updated_at: '2021-11-05T11:29:29.420Z'
+ created_at: '2021-11-08T11:37:53.011Z'
+ updated_at: '2021-11-08T11:37:53.011Z'
relationships:
cms_page:
data:
@@ -1761,8 +1761,8 @@ paths:
- id: '3'
type: cms_section
attributes:
- name: Optio commodi amet asperiores repellendus impedit eius
- numquam.
+ name: Aspernatur temporibus id placeat necessitatibus cum
+ debitis.
content: {}
settings:
gutters: No Gutters
@@ -1771,8 +1771,8 @@ paths:
type: Spree::Cms::Sections::FeaturedArticle
position: 3
linked_resource_type: Spree::Taxon
- created_at: '2021-11-05T11:29:29.432Z'
- updated_at: '2021-11-05T11:29:29.432Z'
+ created_at: '2021-11-08T11:37:53.023Z'
+ updated_at: '2021-11-08T11:37:53.023Z'
relationships:
cms_page:
data:
@@ -1783,7 +1783,7 @@ paths:
- id: '4'
type: cms_section
attributes:
- name: Quae sequi ipsa quod alias.
+ name: Perferendis ducimus ut temporibus molestias pariatur.
content: {}
settings:
gutters: No Gutters
@@ -1792,8 +1792,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-11-05T11:29:29.448Z'
- updated_at: '2021-11-05T11:29:29.448Z'
+ created_at: '2021-11-08T11:37:53.044Z'
+ updated_at: '2021-11-08T11:37:53.044Z'
relationships:
cms_page:
data:
@@ -1806,7 +1806,7 @@ paths:
- id: '5'
type: cms_section
attributes:
- name: Animi dolorem cupiditate laborum assumenda nulla.
+ name: Ea repellat ex quos corporis aliquam unde eaque.
content: {}
settings:
gutters: No Gutters
@@ -1815,8 +1815,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 5
linked_resource_type: Spree::Product
- created_at: '2021-11-05T11:29:29.460Z'
- updated_at: '2021-11-05T11:29:29.460Z'
+ created_at: '2021-11-08T11:37:53.057Z'
+ updated_at: '2021-11-08T11:37:53.057Z'
relationships:
cms_page:
data:
@@ -1876,7 +1876,8 @@ paths:
id: '13'
type: cms_section
attributes:
- name: Neque maiores ex porro tempore nemo iste atque.
+ name: Accusantium dicta voluptates ipsum quis fugit voluptatem
+ neque.
content: {}
settings:
gutters: No Gutters
@@ -1885,8 +1886,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 3
linked_resource_type: Spree::Product
- created_at: '2021-11-05T11:29:29.736Z'
- updated_at: '2021-11-05T11:29:29.736Z'
+ created_at: '2021-11-08T11:37:53.336Z'
+ updated_at: '2021-11-08T11:37:53.336Z'
relationships:
cms_page:
data:
@@ -1961,8 +1962,8 @@ paths:
id: '19'
type: cms_section
attributes:
- name: Veniam neque dolorum porro aliquam distinctio dolore
- libero quis.
+ name: Explicabo hic architecto ratione in minima aliquam debitis
+ impedit.
content: {}
settings:
gutters: No Gutters
@@ -1971,8 +1972,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-11-05T11:29:30.098Z'
- updated_at: '2021-11-05T11:29:30.098Z'
+ created_at: '2021-11-08T11:37:53.731Z'
+ updated_at: '2021-11-08T11:37:53.731Z'
relationships:
cms_page:
data:
@@ -2046,8 +2047,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Product
- created_at: '2021-11-05T11:29:30.443Z'
- updated_at: '2021-11-05T11:29:30.460Z'
+ created_at: '2021-11-08T11:37:54.078Z'
+ updated_at: '2021-11-08T11:37:54.095Z'
relationships:
cms_page:
data:
@@ -2167,9 +2168,9 @@ paths:
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-11-05T11:29:31.332Z'
+ updated_at: '2021-11-08T11:37:54.826Z'
zipcode_required: true
- created_at: '2021-11-05T11:29:31.332Z'
+ created_at: '2021-11-08T11:37:54.826Z'
relationships:
states:
data: []
@@ -2182,9 +2183,9 @@ paths:
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-11-05T11:29:31.340Z'
+ updated_at: '2021-11-08T11:37:54.834Z'
zipcode_required: true
- created_at: '2021-11-05T11:29:31.340Z'
+ created_at: '2021-11-08T11:37:54.834Z'
relationships:
states:
data: []
@@ -2197,9 +2198,9 @@ paths:
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-11-05T11:29:31.343Z'
+ updated_at: '2021-11-08T11:37:54.837Z'
zipcode_required: true
- created_at: '2021-11-05T11:29:31.343Z'
+ created_at: '2021-11-08T11:37:54.837Z'
relationships:
states:
data: []
@@ -2258,9 +2259,9 @@ paths:
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-11-05T11:29:31.436Z'
+ updated_at: '2021-11-08T11:37:54.931Z'
zipcode_required: true
- created_at: '2021-11-05T11:29:31.436Z'
+ created_at: '2021-11-08T11:37:54.931Z'
relationships:
states:
data: []
@@ -2318,7 +2319,7 @@ paths:
- id: '1'
type: digital_link
attributes:
- token: RNXJau3uSXC6q67dRqsNrbqE
+ token: wHQaLPdPYmN8daVpTWoZvmDm
access_counter: 0
relationships:
digital:
@@ -2332,7 +2333,7 @@ paths:
- id: '2'
type: digital_link
attributes:
- token: pqaxQrriSYYJcb8pR85BYjbi
+ token: Duw7Lw5EYU3XMsz8qnVXJg1p
access_counter: 0
relationships:
digital:
@@ -2386,7 +2387,7 @@ paths:
id: '5'
type: digital_link
attributes:
- token: GePp7kYXQQ2uCKv1odXhvM1L
+ token: vtWonGho2jCEZzsiveZeUvAp
access_counter: 0
relationships:
digital:
@@ -2449,7 +2450,7 @@ paths:
id: '6'
type: digital_link
attributes:
- token: ZH69ydPbdXTz9GASEoS2Rm1p
+ token: 95MtSADWrVfb5z9MwPEkt7Um
access_counter: 0
relationships:
digital:
@@ -2508,7 +2509,7 @@ paths:
id: '8'
type: digital_link
attributes:
- token: DjFYBcUTiASaRX1PpiPyqqfQ
+ token: AL7RAsUpGjwpjfbTeFooEY8s
access_counter: 0
relationships:
digital:
@@ -2623,7 +2624,7 @@ paths:
id: '13'
type: digital_link
attributes:
- token: GNDxhRd8Cor5ChTizu8pY7Qq
+ token: b3ssLHZ8aBfMyekx6AvzDSzo
access_counter: 0
relationships:
digital:
@@ -3040,8 +3041,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-05T11:29:44.174Z'
- updated_at: '2021-11-05T11:29:44.187Z'
+ created_at: '2021-11-08T11:38:08.248Z'
+ updated_at: '2021-11-08T11:38:08.261Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3062,8 +3063,8 @@ paths:
display_final_amount: "$10.00"
display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_promo_total: "$0.00"
display_pre_tax_amount: "$10.00"
relationships:
order:
@@ -3089,8 +3090,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-05T11:29:44.241Z'
- updated_at: '2021-11-05T11:29:44.250Z'
+ created_at: '2021-11-08T11:38:08.315Z'
+ updated_at: '2021-11-08T11:38:08.324Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3111,8 +3112,8 @@ paths:
display_final_amount: "$10.00"
display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_promo_total: "$0.00"
display_pre_tax_amount: "$10.00"
relationships:
order:
@@ -3185,8 +3186,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-05T11:29:44.609Z'
- updated_at: '2021-11-05T11:29:44.653Z'
+ created_at: '2021-11-08T11:38:08.732Z'
+ updated_at: '2021-11-08T11:38:08.781Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3207,8 +3208,8 @@ paths:
display_final_amount: "$10.00"
display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_promo_total: "$0.00"
display_pre_tax_amount: "$10.00"
relationships:
order:
@@ -3290,8 +3291,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-11-05T11:29:44.884Z'
- updated_at: '2021-11-05T11:29:44.895Z'
+ created_at: '2021-11-08T11:38:09.022Z'
+ updated_at: '2021-11-08T11:38:09.033Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3312,8 +3313,8 @@ paths:
display_final_amount: "$10.00"
display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_promo_total: "$0.00"
display_pre_tax_amount: "$10.00"
relationships:
order:
@@ -3391,8 +3392,8 @@ paths:
attributes:
quantity: 4
price: '10.0'
- created_at: '2021-11-05T11:29:45.267Z'
- updated_at: '2021-11-05T11:29:45.330Z'
+ created_at: '2021-11-08T11:38:09.458Z'
+ updated_at: '2021-11-08T11:38:09.522Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3413,8 +3414,8 @@ paths:
display_final_amount: "$40.00"
display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
display_included_tax_total: "$0.00"
+ display_promo_total: "$0.00"
display_pre_tax_amount: "$40.00"
relationships:
order:
@@ -3444,10 +3445,10 @@ paths:
examples:
Example:
value:
- error: 'Quantity selected of "Product #130 - 3667" is not available.'
+ error: 'Quantity selected of "Product #130 - 2124" is not available.'
errors:
quantity:
- - 'selected of "Product #130 - 3667" is not available.'
+ - 'selected of "Product #130 - 2124" is not available.'
schema:
"$ref": "#/components/schemas/validation_errors"
'404':
@@ -3567,8 +3568,8 @@ paths:
lft: 2
rgt: 3
depth: 1
- created_at: '2021-11-05T11:29:46.261Z'
- updated_at: '2021-11-05T11:29:46.283Z'
+ created_at: '2021-11-08T11:38:10.562Z'
+ updated_at: '2021-11-08T11:38:10.568Z'
link:
is_container: false
is_root: false
@@ -3604,8 +3605,8 @@ paths:
lft: 4
rgt: 5
depth: 1
- created_at: '2021-11-05T11:29:46.373Z'
- updated_at: '2021-11-05T11:29:46.380Z'
+ created_at: '2021-11-08T11:38:10.655Z'
+ updated_at: '2021-11-08T11:38:10.662Z'
link:
is_container: false
is_root: false
@@ -3641,8 +3642,8 @@ paths:
lft: 6
rgt: 7
depth: 1
- created_at: '2021-11-05T11:29:46.468Z'
- updated_at: '2021-11-05T11:29:46.475Z'
+ created_at: '2021-11-08T11:38:10.768Z'
+ updated_at: '2021-11-08T11:38:10.776Z'
link:
is_container: false
is_root: false
@@ -3678,8 +3679,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-05T11:29:46.560Z'
- updated_at: '2021-11-05T11:29:46.567Z'
+ created_at: '2021-11-08T11:38:10.868Z'
+ updated_at: '2021-11-08T11:38:10.875Z'
link:
is_container: false
is_root: false
@@ -3715,8 +3716,8 @@ paths:
lft: 10
rgt: 11
depth: 1
- created_at: '2021-11-05T11:29:46.651Z'
- updated_at: '2021-11-05T11:29:46.657Z'
+ created_at: '2021-11-08T11:38:10.966Z'
+ updated_at: '2021-11-08T11:38:10.972Z'
link:
is_container: false
is_root: false
@@ -3752,8 +3753,8 @@ paths:
lft: 12
rgt: 13
depth: 1
- created_at: '2021-11-05T11:29:46.742Z'
- updated_at: '2021-11-05T11:29:46.749Z'
+ created_at: '2021-11-08T11:38:11.067Z'
+ updated_at: '2021-11-08T11:38:11.074Z'
link:
is_container: false
is_root: false
@@ -3789,8 +3790,8 @@ paths:
lft: 14
rgt: 15
depth: 1
- created_at: '2021-11-05T11:29:46.836Z'
- updated_at: '2021-11-05T11:29:46.842Z'
+ created_at: '2021-11-08T11:38:11.160Z'
+ updated_at: '2021-11-08T11:38:11.169Z'
link:
is_container: false
is_root: false
@@ -3816,7 +3817,8 @@ paths:
- id: '1'
type: menu_item
attributes:
- name: Eius maiores aspernatur fugit at deleniti.
+ name: Quia in maiores asperiores tempora earum quas facilis
+ accusamus.
subtitle:
destination:
new_window: false
@@ -3826,8 +3828,8 @@ paths:
lft: 1
rgt: 16
depth: 0
- created_at: '2021-11-05T11:29:46.174Z'
- updated_at: '2021-11-05T11:29:46.855Z'
+ created_at: '2021-11-08T11:38:10.470Z'
+ updated_at: '2021-11-08T11:38:11.184Z'
link:
is_container: true
is_root: true
@@ -3920,8 +3922,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-05T11:29:47.964Z'
- updated_at: '2021-11-05T11:29:47.970Z'
+ created_at: '2021-11-08T11:38:12.401Z'
+ updated_at: '2021-11-08T11:38:12.408Z'
link:
is_container: false
is_root: false
@@ -4011,8 +4013,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-05T11:29:48.736Z'
- updated_at: '2021-11-05T11:29:48.743Z'
+ created_at: '2021-11-08T11:38:13.222Z'
+ updated_at: '2021-11-08T11:38:13.228Z'
link:
is_container: false
is_root: false
@@ -4100,8 +4102,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-11-05T11:29:49.939Z'
- updated_at: '2021-11-05T11:29:49.976Z'
+ created_at: '2021-11-08T11:38:14.585Z'
+ updated_at: '2021-11-08T11:38:14.624Z'
link:
is_container: false
is_root: false
@@ -4238,8 +4240,8 @@ paths:
lft: 5
rgt: 6
depth: 2
- created_at: '2021-11-05T11:29:52.752Z'
- updated_at: '2021-11-05T11:29:52.789Z'
+ created_at: '2021-11-08T11:38:17.550Z'
+ updated_at: '2021-11-08T11:38:17.606Z'
link:
is_container: false
is_root: false
@@ -4343,8 +4345,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-05T11:29:53.580Z'
- updated_at: '2021-11-05T11:29:53.780Z'
+ created_at: '2021-11-08T11:38:18.434Z'
+ updated_at: '2021-11-08T11:38:18.649Z'
relationships:
menu_items:
data:
@@ -4360,8 +4362,8 @@ paths:
name: Footer Menu
location: footer
locale: en
- created_at: '2021-11-05T11:29:53.593Z'
- updated_at: '2021-11-05T11:29:53.965Z'
+ created_at: '2021-11-08T11:38:18.452Z'
+ updated_at: '2021-11-08T11:38:18.847Z'
relationships:
menu_items:
data:
@@ -4424,8 +4426,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-05T11:29:54.481Z'
- updated_at: '2021-11-05T11:29:54.489Z'
+ created_at: '2021-11-08T11:38:19.474Z'
+ updated_at: '2021-11-08T11:38:19.483Z'
relationships:
menu_items:
data:
@@ -4493,8 +4495,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-05T11:29:54.580Z'
- updated_at: '2021-11-05T11:29:54.589Z'
+ created_at: '2021-11-08T11:38:19.562Z'
+ updated_at: '2021-11-08T11:38:19.572Z'
relationships:
menu_items:
data:
@@ -4558,8 +4560,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-11-05T11:29:54.719Z'
- updated_at: '2021-11-05T11:29:54.728Z'
+ created_at: '2021-11-08T11:38:19.710Z'
+ updated_at: '2021-11-08T11:38:19.719Z'
relationships:
menu_items:
data:
@@ -4694,8 +4696,8 @@ paths:
name: foo-size-68
presentation: Size
position: 1
- created_at: '2021-11-05T11:29:55.028Z'
- updated_at: '2021-11-05T11:29:55.028Z'
+ created_at: '2021-11-08T11:38:20.045Z'
+ updated_at: '2021-11-08T11:38:20.045Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4708,8 +4710,8 @@ paths:
name: foo-size-69
presentation: Size
position: 2
- created_at: '2021-11-05T11:29:55.030Z'
- updated_at: '2021-11-05T11:29:55.030Z'
+ created_at: '2021-11-08T11:38:20.048Z'
+ updated_at: '2021-11-08T11:38:20.048Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4762,8 +4764,8 @@ paths:
name: foo-size-72
presentation: Size
position: 1
- created_at: '2021-11-05T11:29:55.124Z'
- updated_at: '2021-11-05T11:29:55.124Z'
+ created_at: '2021-11-08T11:38:20.148Z'
+ updated_at: '2021-11-08T11:38:20.148Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4822,8 +4824,8 @@ paths:
name: foo-size-73
presentation: Size
position: 1
- created_at: '2021-11-05T11:29:55.193Z'
- updated_at: '2021-11-05T11:29:55.193Z'
+ created_at: '2021-11-08T11:38:20.215Z'
+ updated_at: '2021-11-08T11:38:20.215Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -4881,8 +4883,8 @@ paths:
name: Size-X
presentation: Size
position: 1
- created_at: '2021-11-05T11:29:55.296Z'
- updated_at: '2021-11-05T11:29:55.308Z'
+ created_at: '2021-11-08T11:38:20.321Z'
+ updated_at: '2021-11-08T11:38:20.331Z'
filterable: true
public_metadata: {}
private_metadata: {}
@@ -5020,8 +5022,8 @@ paths:
position: 1
name: Size-68
presentation: S
- created_at: '2021-11-05T11:29:55.546Z'
- updated_at: '2021-11-05T11:29:55.546Z'
+ created_at: '2021-11-08T11:38:20.574Z'
+ updated_at: '2021-11-08T11:38:20.574Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5035,8 +5037,8 @@ paths:
position: 1
name: Size-69
presentation: S
- created_at: '2021-11-05T11:29:55.553Z'
- updated_at: '2021-11-05T11:29:55.553Z'
+ created_at: '2021-11-08T11:38:20.583Z'
+ updated_at: '2021-11-08T11:38:20.583Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5097,8 +5099,8 @@ paths:
position: 1
name: Size-72
presentation: S
- created_at: '2021-11-05T11:29:55.653Z'
- updated_at: '2021-11-05T11:29:55.653Z'
+ created_at: '2021-11-08T11:38:20.695Z'
+ updated_at: '2021-11-08T11:38:20.695Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5163,8 +5165,8 @@ paths:
position: 1
name: Size-73
presentation: S
- created_at: '2021-11-05T11:29:55.717Z'
- updated_at: '2021-11-05T11:29:55.717Z'
+ created_at: '2021-11-08T11:38:20.773Z'
+ updated_at: '2021-11-08T11:38:20.773Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5230,8 +5232,8 @@ paths:
position: 1
name: M
presentation: S
- created_at: '2021-11-05T11:29:55.830Z'
- updated_at: '2021-11-05T11:29:55.842Z'
+ created_at: '2021-11-08T11:38:20.887Z'
+ updated_at: '2021-11-08T11:38:20.900Z'
public_metadata: {}
private_metadata: {}
relationships:
@@ -5361,7 +5363,7 @@ paths:
- id: '40'
type: order
attributes:
- number: R380038600
+ number: R812080497
item_total: '0.0'
total: '0.0'
state: cart
@@ -5370,10 +5372,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:56.104Z'
- updated_at: '2021-11-05T11:29:56.104Z'
+ created_at: '2021-11-08T11:38:21.182Z'
+ updated_at: '2021-11-08T11:38:21.182Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5447,7 +5449,7 @@ paths:
- id: '41'
type: order
attributes:
- number: R955484449
+ number: R730654822
item_total: '0.0'
total: '0.0'
state: cart
@@ -5456,10 +5458,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:56.119Z'
- updated_at: '2021-11-05T11:29:56.119Z'
+ created_at: '2021-11-08T11:38:21.198Z'
+ updated_at: '2021-11-08T11:38:21.198Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5580,7 +5582,7 @@ paths:
id: '44'
type: order
attributes:
- number: R622405309
+ number: R900860461
item_total: '0.0'
total: '0.0'
state: cart
@@ -5591,8 +5593,8 @@ paths:
payment_state:
email:
special_instructions:
- created_at: '2021-11-05T11:29:56.535Z'
- updated_at: '2021-11-05T11:29:56.555Z'
+ created_at: '2021-11-08T11:38:21.663Z'
+ updated_at: '2021-11-08T11:38:21.684Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5708,7 +5710,7 @@ paths:
id: '45'
type: order
attributes:
- number: R163331113
+ number: R331539389
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5717,10 +5719,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:56.634Z'
- updated_at: '2021-11-05T11:29:56.842Z'
+ created_at: '2021-11-08T11:38:21.760Z'
+ updated_at: '2021-11-08T11:38:21.955Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5852,7 +5854,7 @@ paths:
id: '47'
type: order
attributes:
- number: R057214802
+ number: R592841388
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5863,8 +5865,8 @@ paths:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:57.145Z'
- updated_at: '2021-11-05T11:29:57.285Z'
+ created_at: '2021-11-08T11:38:22.308Z'
+ updated_at: '2021-11-08T11:38:22.461Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6052,7 +6054,7 @@ paths:
id: '52'
type: order
attributes:
- number: R322989713
+ number: R637598955
item_total: '10.0'
total: '110.0'
state: payment
@@ -6061,10 +6063,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:58.211Z'
- updated_at: '2021-11-05T11:29:58.407Z'
+ created_at: '2021-11-08T11:38:23.438Z'
+ updated_at: '2021-11-08T11:38:23.654Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6199,7 +6201,7 @@ paths:
id: '54'
type: order
attributes:
- number: R504473077
+ number: R930292425
item_total: '10.0'
total: '110.0'
state: payment
@@ -6208,10 +6210,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:29:58.708Z'
- updated_at: '2021-11-05T11:29:58.892Z'
+ created_at: '2021-11-08T11:38:23.982Z'
+ updated_at: '2021-11-08T11:38:24.424Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6346,19 +6348,19 @@ paths:
id: '56'
type: order
attributes:
- number: R129781155
+ number: R989439017
item_total: '10.0'
total: '110.0'
state: complete
adjustment_total: '0.0'
- completed_at: '2021-11-05T11:29:59.618Z'
+ completed_at: '2021-11-08T11:38:25.061Z'
payment_total: '0.0'
shipment_state: pending
payment_state: balance_due
special_instructions:
- created_at: '2021-11-05T11:29:59.316Z'
- updated_at: '2021-11-05T11:29:59.618Z'
+ created_at: '2021-11-08T11:38:24.718Z'
+ updated_at: '2021-11-08T11:38:25.061Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6504,7 +6506,7 @@ paths:
id: '59'
type: order
attributes:
- number: R933032985
+ number: R101290975
item_total: '0.0'
total: '0.0'
state: cart
@@ -6513,10 +6515,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:30:00.139Z'
- updated_at: '2021-11-05T11:30:00.296Z'
+ created_at: '2021-11-08T11:38:25.633Z'
+ updated_at: '2021-11-08T11:38:25.804Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -6646,7 +6648,7 @@ paths:
id: '61'
type: order
attributes:
- number: R748115898
+ number: R239945982
item_total: '10.0'
total: '110.0'
state: delivery
@@ -6655,10 +6657,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-11-05T11:30:00.577Z'
- updated_at: '2021-11-05T11:30:00.703Z'
+ created_at: '2021-11-08T11:38:26.099Z'
+ updated_at: '2021-11-08T11:38:26.226Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6961,8 +6963,8 @@ paths:
display_on: both
auto_capture:
position: 1
- created_at: '2021-11-05T11:30:03.089Z'
- updated_at: '2021-11-05T11:30:03.089Z'
+ created_at: '2021-11-08T11:38:29.158Z'
+ updated_at: '2021-11-08T11:38:29.158Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -6982,8 +6984,8 @@ paths:
display_on: both
auto_capture:
position: 2
- created_at: '2021-11-05T11:30:03.099Z'
- updated_at: '2021-11-05T11:30:03.099Z'
+ created_at: '2021-11-08T11:38:29.170Z'
+ updated_at: '2021-11-08T11:38:29.170Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7003,8 +7005,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-05T11:30:03.104Z'
- updated_at: '2021-11-05T11:30:03.104Z'
+ created_at: '2021-11-08T11:38:29.176Z'
+ updated_at: '2021-11-08T11:38:29.176Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7024,8 +7026,8 @@ paths:
display_on: both
auto_capture:
position: 4
- created_at: '2021-11-05T11:30:03.110Z'
- updated_at: '2021-11-05T11:30:03.110Z'
+ created_at: '2021-11-08T11:38:29.183Z'
+ updated_at: '2021-11-08T11:38:29.183Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7048,8 +7050,8 @@ paths:
display_on: both
auto_capture:
position: 5
- created_at: '2021-11-05T11:30:03.116Z'
- updated_at: '2021-11-05T11:30:03.116Z'
+ created_at: '2021-11-08T11:38:29.192Z'
+ updated_at: '2021-11-08T11:38:29.192Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7119,8 +7121,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-05T11:30:03.301Z'
- updated_at: '2021-11-05T11:30:03.301Z'
+ created_at: '2021-11-08T11:38:29.387Z'
+ updated_at: '2021-11-08T11:38:29.387Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7196,8 +7198,8 @@ paths:
display_on: both
auto_capture:
position: 4
- created_at: '2021-11-05T11:30:03.448Z'
- updated_at: '2021-11-05T11:30:03.448Z'
+ created_at: '2021-11-08T11:38:29.546Z'
+ updated_at: '2021-11-08T11:38:29.546Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7272,8 +7274,8 @@ paths:
display_on: both
auto_capture:
position: 3
- created_at: '2021-11-05T11:30:03.653Z'
- updated_at: '2021-11-05T11:30:03.669Z'
+ created_at: '2021-11-08T11:38:29.766Z'
+ updated_at: '2021-11-08T11:38:29.787Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -7421,9 +7423,9 @@ paths:
state: invalid
response_code: '12345'
avs_response:
- created_at: '2021-11-05T11:30:04.125Z'
- updated_at: '2021-11-05T11:30:04.155Z'
- number: PJF02RSC
+ created_at: '2021-11-08T11:38:30.304Z'
+ updated_at: '2021-11-08T11:38:30.336Z'
+ number: P4T6FY2M
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7460,9 +7462,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-11-05T11:30:04.150Z'
- updated_at: '2021-11-05T11:30:04.150Z'
- number: P7YVWPLW
+ created_at: '2021-11-08T11:38:30.331Z'
+ updated_at: '2021-11-08T11:38:30.331Z'
+ number: P3KFYT1Q
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7550,9 +7552,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-11-05T11:30:04.401Z'
- updated_at: '2021-11-05T11:30:04.401Z'
- number: P3SSQUW4
+ created_at: '2021-11-08T11:38:30.615Z'
+ updated_at: '2021-11-08T11:38:30.615Z'
+ number: PBN8RS27
cvv_response_code:
cvv_response_message:
public_metadata: {}
@@ -7690,8 +7692,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-05T11:30:04.757Z'
- updated_at: '2021-11-05T11:30:04.757Z'
+ created_at: '2021-11-08T11:38:30.998Z'
+ updated_at: '2021-11-08T11:38:30.998Z'
code: POP123
relationships:
promotions:
@@ -7700,8 +7702,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-05T11:30:04.758Z'
- updated_at: '2021-11-05T11:30:04.758Z'
+ created_at: '2021-11-08T11:38:31.000Z'
+ updated_at: '2021-11-08T11:38:31.000Z'
code: POP123
relationships:
promotions:
@@ -7757,8 +7759,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-05T11:30:04.845Z'
- updated_at: '2021-11-05T11:30:04.845Z'
+ created_at: '2021-11-08T11:38:31.089Z'
+ updated_at: '2021-11-08T11:38:31.089Z'
code: 2021-BFM
relationships:
promotions:
@@ -7818,8 +7820,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-11-05T11:30:04.908Z'
- updated_at: '2021-11-05T11:30:04.908Z'
+ created_at: '2021-11-08T11:38:31.152Z'
+ updated_at: '2021-11-08T11:38:31.152Z'
code: MJO
relationships:
promotions:
@@ -7880,8 +7882,8 @@ paths:
type: promotion_category
attributes:
name: 2021 Promotions
- created_at: '2021-11-05T11:30:05.023Z'
- updated_at: '2021-11-05T11:30:05.031Z'
+ created_at: '2021-11-08T11:38:31.268Z'
+ updated_at: '2021-11-08T11:38:31.278Z'
code: 2021-Promos
relationships:
promotions:
@@ -7963,6 +7965,277 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
+ "/api/v2/platform/roles":
+ get:
+ summary: Return a list of Roles
+ tags:
+ - Roles
+ security:
+ - bearer_auth: []
+ description: Returns a list of Roles
+ operationId: roles-list
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ - name: filter[name_eq]
+ in: query
+ description: ''
+ example: admin
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: role
+ attributes:
+ name: 'Role #1'
+ created_at: '2021-11-08T11:38:31.523Z'
+ updated_at: '2021-11-08T11:38:31.523Z'
+ - id: '2'
+ type: role
+ attributes:
+ name: 'Role #2'
+ created_at: '2021-11-08T11:38:31.525Z'
+ updated_at: '2021-11-08T11:38:31.525Z'
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/roles?page=1&per_page=&filter[name_eq]=
+ next: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ post:
+ summary: Create a Role
+ tags:
+ - Roles
+ security:
+ - bearer_auth: []
+ description: Creates a Role
+ operationId: create-role
+ parameters: []
+ responses:
+ '201':
+ description: Record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '5'
+ type: role
+ attributes:
+ name: 'Role #5'
+ created_at: '2021-11-08T11:38:31.624Z'
+ updated_at: '2021-11-08T11:38:31.624Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/create_role_params"
+ "/api/v2/platform/roles/{id}":
+ get:
+ summary: Return a Role
+ tags:
+ - Roles
+ security:
+ - bearer_auth: []
+ description: Returns a Role
+ operationId: show-role
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '6'
+ type: role
+ attributes:
+ name: 'Role #6'
+ created_at: '2021-11-08T11:38:31.689Z'
+ updated_at: '2021-11-08T11:38:31.689Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ patch:
+ summary: Update a Role
+ tags:
+ - Roles
+ security:
+ - bearer_auth: []
+ description: Updates a Role
+ operationId: update-role
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '8'
+ type: role
+ attributes:
+ name: administrator
+ created_at: '2021-11-08T11:38:31.789Z'
+ updated_at: '2021-11-08T11:38:31.799Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/update_role_params"
+ delete:
+ summary: Delete a Role
+ tags:
+ - Roles
+ security:
+ - bearer_auth: []
+ description: Deletes a Role
+ operationId: delete-role
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments":
get:
summary: Return a list of Shipments
@@ -8009,12 +8282,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H29326421302
+ number: H78997837551
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-05T11:30:05.252Z'
- updated_at: '2021-11-05T11:30:05.256Z'
+ created_at: '2021-11-08T11:38:32.056Z'
+ updated_at: '2021-11-08T11:38:32.062Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8058,12 +8331,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H21611995524
+ number: H46523481682
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-05T11:30:05.302Z'
- updated_at: '2021-11-05T11:30:05.307Z'
+ created_at: '2021-11-08T11:38:32.113Z'
+ updated_at: '2021-11-08T11:38:32.118Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8160,12 +8433,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H60035200587
+ number: H21237280739
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-05T11:30:05.769Z'
- updated_at: '2021-11-05T11:30:05.798Z'
+ created_at: '2021-11-08T11:38:32.688Z'
+ updated_at: '2021-11-08T11:38:32.720Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8301,12 +8574,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H78624579901
+ number: H48427496107
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-11-05T11:30:07.146Z'
- updated_at: '2021-11-05T11:30:07.192Z'
+ created_at: '2021-11-08T11:38:34.334Z'
+ updated_at: '2021-11-08T11:38:34.388Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8407,12 +8680,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H36706825202
+ number: H51918225930
cost: '100.0'
- shipped_at: '2021-11-05T11:30:08.120Z'
+ shipped_at: '2021-11-08T11:38:35.156Z'
state: shipped
- created_at: '2021-11-05T11:30:08.060Z'
- updated_at: '2021-11-05T11:30:08.120Z'
+ created_at: '2021-11-08T11:38:35.097Z'
+ updated_at: '2021-11-08T11:38:35.156Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8513,12 +8786,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H52646027720
+ number: H21269247050
cost: '100.0'
shipped_at:
state: canceled
- created_at: '2021-11-05T11:30:08.965Z'
- updated_at: '2021-11-05T11:30:09.010Z'
+ created_at: '2021-11-08T11:38:35.873Z'
+ updated_at: '2021-11-08T11:38:35.916Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8619,12 +8892,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H12073028234
+ number: H83992271967
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-11-05T11:30:09.705Z'
- updated_at: '2021-11-05T11:30:09.754Z'
+ created_at: '2021-11-08T11:38:36.655Z'
+ updated_at: '2021-11-08T11:38:36.703Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8725,12 +8998,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H80261464874
+ number: H75920559018
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-11-05T11:30:10.417Z'
- updated_at: '2021-11-05T11:30:10.474Z'
+ created_at: '2021-11-08T11:38:37.424Z'
+ updated_at: '2021-11-08T11:38:37.474Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8835,14 +9108,14 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #116'
- created_at: '2021-11-05T11:30:10.944Z'
- updated_at: '2021-11-05T11:30:10.944Z'
+ created_at: '2021-11-08T11:38:37.897Z'
+ updated_at: '2021-11-08T11:38:37.897Z'
- id: '117'
type: shipping_category
attributes:
name: 'ShippingCategory #117'
- created_at: '2021-11-05T11:30:10.945Z'
- updated_at: '2021-11-05T11:30:10.945Z'
+ created_at: '2021-11-08T11:38:37.899Z'
+ updated_at: '2021-11-08T11:38:37.899Z'
meta:
count: 2
total_count: 2
@@ -8887,8 +9160,8 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #120'
- created_at: '2021-11-05T11:30:11.035Z'
- updated_at: '2021-11-05T11:30:11.035Z'
+ created_at: '2021-11-08T11:38:38.024Z'
+ updated_at: '2021-11-08T11:38:38.024Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -8937,8 +9210,8 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #121'
- created_at: '2021-11-05T11:30:11.104Z'
- updated_at: '2021-11-05T11:30:11.104Z'
+ created_at: '2021-11-08T11:38:38.093Z'
+ updated_at: '2021-11-08T11:38:38.093Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -8988,8 +9261,8 @@ paths:
type: shipping_category
attributes:
name: Default
- created_at: '2021-11-05T11:30:11.217Z'
- updated_at: '2021-11-05T11:30:11.226Z'
+ created_at: '2021-11-08T11:38:38.198Z'
+ updated_at: '2021-11-08T11:38:38.208Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -9123,8 +9396,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-11-05T11:30:11.453Z'
- updated_at: '2021-11-05T11:30:11.453Z'
+ created_at: '2021-11-08T11:38:38.438Z'
+ updated_at: '2021-11-08T11:38:38.438Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -9149,8 +9422,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-11-05T11:30:11.473Z'
- updated_at: '2021-11-05T11:30:11.473Z'
+ created_at: '2021-11-08T11:38:38.455Z'
+ updated_at: '2021-11-08T11:38:38.455Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -9222,8 +9495,8 @@ paths:
admin_name: DHL Express- Zone A
display_on: both
tracking_url:
- created_at: '2021-11-05T11:30:11.617Z'
- updated_at: '2021-11-05T11:30:11.617Z'
+ created_at: '2021-11-08T11:38:38.614Z'
+ updated_at: '2021-11-08T11:38:38.614Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -9309,8 +9582,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-11-05T11:30:11.741Z'
- updated_at: '2021-11-05T11:30:11.741Z'
+ created_at: '2021-11-08T11:38:38.695Z'
+ updated_at: '2021-11-08T11:38:38.695Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -9387,8 +9660,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-11-05T11:30:11.905Z'
- updated_at: '2021-11-05T11:30:11.928Z'
+ created_at: '2021-11-08T11:38:38.874Z'
+ updated_at: '2021-11-08T11:38:38.896Z'
deleted_at:
public_metadata: {}
private_metadata: {}
@@ -9539,8 +9812,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-11-05T11:30:12.349Z'
- updated_at: '2021-11-05T11:30:12.355Z'
+ created_at: '2021-11-08T11:38:39.320Z'
+ updated_at: '2021-11-08T11:38:39.326Z'
meta_title:
meta_description:
meta_keywords:
@@ -9576,8 +9849,8 @@ paths:
lft: 4
rgt: 5
description:
- created_at: '2021-11-05T11:30:12.461Z'
- updated_at: '2021-11-05T11:30:12.466Z'
+ created_at: '2021-11-08T11:38:39.415Z'
+ updated_at: '2021-11-08T11:38:39.420Z'
meta_title:
meta_description:
meta_keywords:
@@ -9613,8 +9886,8 @@ paths:
lft: 1
rgt: 6
description:
- created_at: '2021-11-05T11:30:12.252Z'
- updated_at: '2021-11-05T11:30:12.480Z'
+ created_at: '2021-11-08T11:38:39.222Z'
+ updated_at: '2021-11-08T11:38:39.433Z'
meta_title:
meta_description:
meta_keywords:
@@ -9697,8 +9970,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-11-05T11:30:12.848Z'
- updated_at: '2021-11-05T11:30:12.854Z'
+ created_at: '2021-11-08T11:38:39.846Z'
+ updated_at: '2021-11-08T11:38:39.852Z'
meta_title:
meta_description:
meta_keywords:
@@ -9785,8 +10058,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-11-05T11:30:13.058Z'
- updated_at: '2021-11-05T11:30:13.064Z'
+ created_at: '2021-11-08T11:38:40.060Z'
+ updated_at: '2021-11-08T11:38:40.065Z'
meta_title:
meta_description:
meta_keywords:
@@ -9876,8 +10149,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-11-05T11:30:13.406Z'
- updated_at: '2021-11-05T11:30:13.442Z'
+ created_at: '2021-11-08T11:38:40.454Z'
+ updated_at: '2021-11-08T11:38:40.497Z'
meta_title:
meta_description:
meta_keywords:
@@ -10033,9 +10306,9 @@ paths:
- id: '97'
type: user
attributes:
- created_at: '2021-11-05T11:30:14.228Z'
- updated_at: '2021-11-05T11:30:14.228Z'
+ created_at: '2021-11-08T11:38:41.281Z'
+ updated_at: '2021-11-08T11:38:41.281Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10049,9 +10322,9 @@ paths:
- id: '98'
type: user
attributes:
- created_at: '2021-11-05T11:30:14.238Z'
- updated_at: '2021-11-05T11:30:14.238Z'
+ created_at: '2021-11-08T11:38:41.291Z'
+ updated_at: '2021-11-08T11:38:41.291Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10065,9 +10338,9 @@ paths:
- id: '99'
type: user
attributes:
- created_at: '2021-11-05T11:30:14.240Z'
- updated_at: '2021-11-05T11:30:14.240Z'
+ created_at: '2021-11-08T11:38:41.293Z'
+ updated_at: '2021-11-08T11:38:41.293Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10128,9 +10401,9 @@ paths:
id: '104'
type: user
attributes:
- created_at: '2021-11-05T11:30:14.421Z'
- updated_at: '2021-11-05T11:30:14.421Z'
+ created_at: '2021-11-08T11:38:41.423Z'
+ updated_at: '2021-11-08T11:38:41.423Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10195,9 +10468,9 @@ paths:
id: '107'
type: user
attributes:
- created_at: '2021-11-05T11:30:14.529Z'
- updated_at: '2021-11-05T11:30:14.529Z'
+ created_at: '2021-11-08T11:38:41.556Z'
+ updated_at: '2021-11-08T11:38:41.556Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10264,8 +10537,8 @@ paths:
type: user
attributes:
- created_at: '2021-11-05T11:30:14.657Z'
- updated_at: '2021-11-05T11:30:14.670Z'
+ created_at: '2021-11-08T11:38:41.690Z'
+ updated_at: '2021-11-08T11:38:41.704Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -10414,14 +10687,14 @@ paths:
position: 1
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-05T11:30:15.051Z'
+ updated_at: '2021-11-08T11:38:42.065Z'
discontinue_on:
- created_at: '2021-11-05T11:30:15.042Z'
+ created_at: '2021-11-08T11:38:42.054Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #181 - 533'
+ name: 'Product #181 - 1509'
options_text: ''
total_on_hand: 0
purchasable: true
@@ -10456,23 +10729,23 @@ paths:
type: variant
attributes:
sku: SKU-249
- weight: '95.18'
- height: '88.5'
- depth: '90.78'
+ weight: '131.93'
+ height: '173.98'
+ depth: '177.43'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-05T11:30:15.099Z'
+ updated_at: '2021-11-08T11:38:42.108Z'
discontinue_on:
- created_at: '2021-11-05T11:30:15.088Z'
+ created_at: '2021-11-08T11:38:42.098Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #181 - 533'
+ name: 'Product #181 - 1509'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -10509,23 +10782,23 @@ paths:
type: variant
attributes:
sku: SKU-250
- weight: '75.74'
- height: '42.46'
- depth: '155.79'
+ weight: '92.2'
+ height: '77.84'
+ depth: '36.57'
deleted_at:
is_master: false
cost_price: '17.0'
position: 3
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-05T11:30:15.135Z'
+ updated_at: '2021-11-08T11:38:42.139Z'
discontinue_on:
- created_at: '2021-11-05T11:30:15.125Z'
+ created_at: '2021-11-08T11:38:42.130Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #181 - 533'
+ name: 'Product #181 - 1509'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -10615,23 +10888,23 @@ paths:
type: variant
attributes:
sku: SKU-255
- weight: '43.7'
- height: '197.47'
- depth: '98.48'
+ weight: '199.37'
+ height: '182.47'
+ depth: '152.29'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-11-05T11:30:15.505Z'
+ updated_at: '2021-11-08T11:38:42.519Z'
discontinue_on:
- created_at: '2021-11-05T11:30:15.495Z'
+ created_at: '2021-11-08T11:38:42.509Z'
public_metadata: {}
private_metadata: {}
display_compare_at_price:
display_price: "$19.99"
- name: 'Product #183 - 2431'
+ name: 'Product #183 - 9023'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -10792,14 +11065,14 @@ paths:
- id: '1'
type: event
attributes:
- execution_time: 97071
+ execution_time: 90217
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url1.com/
- created_at: '2021-11-05T11:30:16.244Z'
- updated_at: '2021-11-05T11:30:16.244Z'
+ created_at: '2021-11-08T11:38:43.123Z'
+ updated_at: '2021-11-08T11:38:43.123Z'
relationships:
subscriber:
data:
@@ -10808,14 +11081,14 @@ paths:
- id: '2'
type: event
attributes:
- execution_time: 92841
+ execution_time: 84282
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url2.com/
- created_at: '2021-11-05T11:30:16.247Z'
- updated_at: '2021-11-05T11:30:16.247Z'
+ created_at: '2021-11-08T11:38:43.126Z'
+ updated_at: '2021-11-08T11:38:43.126Z'
relationships:
subscriber:
data:
@@ -10891,8 +11164,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-05T11:30:16.341Z'
- updated_at: '2021-11-05T11:30:16.341Z'
+ created_at: '2021-11-08T11:38:43.223Z'
+ updated_at: '2021-11-08T11:38:43.223Z'
- id: '6'
type: subscriber
attributes:
@@ -10900,8 +11173,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-05T11:30:16.343Z'
- updated_at: '2021-11-05T11:30:16.343Z'
+ created_at: '2021-11-08T11:38:43.225Z'
+ updated_at: '2021-11-08T11:38:43.225Z'
meta:
count: 2
total_count: 2
@@ -10949,8 +11222,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-05T11:30:16.439Z'
- updated_at: '2021-11-05T11:30:16.439Z'
+ created_at: '2021-11-08T11:38:43.310Z'
+ updated_at: '2021-11-08T11:38:43.310Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11005,8 +11278,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-05T11:30:16.501Z'
- updated_at: '2021-11-05T11:30:16.501Z'
+ created_at: '2021-11-08T11:38:43.399Z'
+ updated_at: '2021-11-08T11:38:43.399Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -11059,8 +11332,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-11-05T11:30:16.597Z'
- updated_at: '2021-11-05T11:30:16.597Z'
+ created_at: '2021-11-08T11:38:43.500Z'
+ updated_at: '2021-11-08T11:38:43.500Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -11181,8 +11454,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:17.049Z'
- updated_at: '2021-11-05T11:30:17.049Z'
+ created_at: '2021-11-08T11:38:43.930Z'
+ updated_at: '2021-11-08T11:38:43.930Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11196,8 +11469,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:17.134Z'
- updated_at: '2021-11-05T11:30:17.134Z'
+ created_at: '2021-11-08T11:38:44.028Z'
+ updated_at: '2021-11-08T11:38:44.028Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11211,8 +11484,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:17.222Z'
- updated_at: '2021-11-05T11:30:17.222Z'
+ created_at: '2021-11-08T11:38:44.103Z'
+ updated_at: '2021-11-08T11:38:44.103Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11226,8 +11499,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:17.301Z'
- updated_at: '2021-11-05T11:30:17.301Z'
+ created_at: '2021-11-08T11:38:44.180Z'
+ updated_at: '2021-11-08T11:38:44.180Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11288,8 +11561,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:17.962Z'
- updated_at: '2021-11-05T11:30:17.962Z'
+ created_at: '2021-11-08T11:38:45.044Z'
+ updated_at: '2021-11-08T11:38:45.044Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11359,8 +11632,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-11-05T11:30:18.321Z'
- updated_at: '2021-11-05T11:30:18.321Z'
+ created_at: '2021-11-08T11:38:45.426Z'
+ updated_at: '2021-11-08T11:38:45.426Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -11426,8 +11699,8 @@ paths:
type: wished_item
attributes:
quantity: 3
- created_at: '2021-11-05T11:30:18.883Z'
- updated_at: '2021-11-05T11:30:18.894Z'
+ created_at: '2021-11-08T11:38:46.033Z'
+ updated_at: '2021-11-08T11:38:46.048Z'
display_price: "$19.99"
display_total: "$59.97"
price: '19.99'
@@ -11562,9 +11835,9 @@ paths:
name: Black Friday
is_private: true
is_default: false
- created_at: '2021-11-05T11:30:20.078Z'
- updated_at: '2021-11-05T11:30:20.078Z'
- token: oRf3ZN4KjxvbPodajVe7aeNd
+ created_at: '2021-11-08T11:38:47.294Z'
+ updated_at: '2021-11-08T11:38:47.294Z'
+ token: JWgdanBbBQx87PwWqNqjbPWU
variant_included: false
relationships:
wished_items:
@@ -11579,9 +11852,9 @@ paths:
name: Birthday
is_private: true
is_default: false
- created_at: '2021-11-05T11:30:20.080Z'
- updated_at: '2021-11-05T11:30:20.080Z'
- token: uByr8ZCMRhHpJY6TB8gcLDb1
+ created_at: '2021-11-08T11:38:47.296Z'
+ updated_at: '2021-11-08T11:38:47.296Z'
+ token: wUEDu7aiv1jpy2yEeY3PaGr3
variant_included: false
relationships:
wished_items:
@@ -11643,9 +11916,9 @@ paths:
name: Wishlist_26
is_private: true
is_default: false
- created_at: '2021-11-05T11:30:20.843Z'
- updated_at: '2021-11-05T11:30:20.843Z'
- token: 6Ld93JKaLHrRU2vd9u6ozvNy
+ created_at: '2021-11-08T11:38:48.155Z'
+ updated_at: '2021-11-08T11:38:48.155Z'
+ token: c4Dvoy5mMQuDWEqwaC2r4cq5
variant_included: false
relationships:
wished_items:
@@ -11709,9 +11982,9 @@ paths:
name: My Wishlist
is_private: true
is_default: false
- created_at: '2021-11-05T11:30:20.916Z'
- updated_at: '2021-11-05T11:30:20.916Z'
- token: xNuTT9BxGvZaT2Ug99Kr5CGQ
+ created_at: '2021-11-08T11:38:48.231Z'
+ updated_at: '2021-11-08T11:38:48.231Z'
+ token: n5tynhFbeK9HGRquH4oKNsJw
variant_included: false
relationships:
wished_items:
@@ -11774,9 +12047,9 @@ paths:
name: My Super Wishlist
is_private: true
is_default: false
- created_at: '2021-11-05T11:30:21.051Z'
- updated_at: '2021-11-05T11:30:21.062Z'
- token: rhHufUQzDv1sELtPf8kBdtUh
+ created_at: '2021-11-08T11:38:48.363Z'
+ updated_at: '2021-11-08T11:38:48.376Z'
+ token: PJ8xtYgbqJqnn4D3WgfQdKm4
variant_included: false
relationships:
wished_items:
@@ -11858,31 +12131,369 @@ paths:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
-servers:
-- url: https://{defaultHost}
- variables:
- defaultHost:
- default: localhost:3000
-tags:
-- name: Addresses
-- name: Adjustments
-- name: Classifications
-- name: Countries
-- name: CMS Pages
-- name: CMS Sections
-- name: Digital Assets
-- name: Digital Links
-- name: Line Items
-- name: Menus
-- name: Menu Items
-- name: Option Types
-- name: Option Values
-- name: Orders
-- name: Payments
-- name: Payment Methods
-- name: Promotion Categories
-- name: Shipments
-- name: Shipping Categories
+ "/api/v2/platform/zones":
+ get:
+ summary: Return a list of Zones
+ tags:
+ - Zones
+ security:
+ - bearer_auth: []
+ description: Returns a list of Zones
+ operationId: zones-list
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: zone_members
+ schema:
+ type: string
+ - name: filter[description_eq]
+ in: query
+ description: ''
+ example: The zone containing all EU countries
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '82'
+ type: zone
+ attributes:
+ name: Officia quod quam corrupti necessitatibus.
+ description: Assumenda blanditiis rem nihil cupiditate.
+ default_tax: false
+ zone_members_count: 0
+ created_at: '2021-11-08T11:38:48.652Z'
+ updated_at: '2021-11-08T11:38:48.652Z'
+ kind: state
+ relationships:
+ zone_members:
+ data: []
+ - id: '83'
+ type: zone
+ attributes:
+ name: Alias distinctio cupiditate adipisci ipsa.
+ description: Consectetur culpa nihil similique illo suscipit
+ animi maxime eligendi.
+ default_tax: false
+ zone_members_count: 0
+ created_at: '2021-11-08T11:38:48.655Z'
+ updated_at: '2021-11-08T11:38:48.655Z'
+ kind: state
+ relationships:
+ zone_members:
+ data: []
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/zones?page=1&per_page=&include=&filter[description_eq]=
+ next: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ post:
+ summary: Create a Zone
+ tags:
+ - Zones
+ security:
+ - bearer_auth: []
+ description: Creates a Zone
+ operationId: create-zone
+ parameters:
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: zone_members
+ schema:
+ type: string
+ responses:
+ '201':
+ description: Record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '86'
+ type: zone
+ attributes:
+ name: Dolore iste asperiores possimus culpa velit vitae suscipit
+ maiores.
+ description: Sequi soluta beatae harum aspernatur.
+ default_tax: false
+ zone_members_count: 0
+ created_at: '2021-11-08T11:38:48.760Z'
+ updated_at: '2021-11-08T11:38:48.760Z'
+ kind: state
+ relationships:
+ zone_members:
+ data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/create_zone_params"
+ "/api/v2/platform/zones/{id}":
+ get:
+ summary: Return a Zone
+ tags:
+ - Zones
+ security:
+ - bearer_auth: []
+ description: Returns a Zone
+ operationId: show-zone
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: zone_members
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '87'
+ type: zone
+ attributes:
+ name: Vitae aperiam cupiditate quam et omnis consequuntur
+ consequatur qui.
+ description: Distinctio quo voluptatem at non doloribus minus.
+ default_tax: false
+ zone_members_count: 0
+ created_at: '2021-11-08T11:38:48.828Z'
+ updated_at: '2021-11-08T11:38:48.828Z'
+ kind: state
+ relationships:
+ zone_members:
+ data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ patch:
+ summary: Update a Zone
+ tags:
+ - Zones
+ security:
+ - bearer_auth: []
+ description: Updates a Zone
+ operationId: update-zone
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: zone_members
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '89'
+ type: zone
+ attributes:
+ name: EU
+ description: The zone containing all EU countries
+ default_tax: false
+ zone_members_count: 0
+ created_at: '2021-11-08T11:38:48.943Z'
+ updated_at: '2021-11-08T11:38:48.952Z'
+ kind: state
+ relationships:
+ zone_members:
+ data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/update_zone_params"
+ delete:
+ summary: Delete a Zone
+ tags:
+ - Zones
+ security:
+ - bearer_auth: []
+ description: Deletes a Zone
+ operationId: delete-zone
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+servers:
+- url: https://{defaultHost}
+ variables:
+ defaultHost:
+ default: localhost:3000
+tags:
+- name: Addresses
+- name: Adjustments
+- name: Classifications
+- name: Countries
+- name: CMS Pages
+- name: CMS Sections
+- name: Digital Assets
+- name: Digital Links
+- name: Line Items
+- name: Menus
+- name: Menu Items
+- name: Option Types
+- name: Option Values
+- name: Orders
+- name: Payments
+- name: Payment Methods
+- name: Promotion Categories
+- name: Roles
+- name: Shipments
+- name: Shipping Categories
- name: Shipping Methods
- name: Taxons
- name: Users
@@ -11891,6 +12502,7 @@ tags:
- name: Wishlists
- name: Wished Items
- name: Variants
+- name: Zones
components:
securitySchemes:
bearer_auth:
@@ -13775,7 +14387,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-11-05 11:29:21 UTC
+ example: 2021-11-08 11:37:43 UTC
bill_address_id:
type: string
example: '1'
@@ -13843,7 +14455,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-11-05 11:29:21 UTC
+ example: 2021-11-08 11:37:43 UTC
confirmation_delivered:
type: boolean
example: true
@@ -13914,7 +14526,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-11-05 11:29:21 UTC
+ example: 2021-11-08 11:37:43 UTC
bill_address_id:
type: string
example: '1'
@@ -13982,7 +14594,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-11-05 11:29:21 UTC
+ example: 2021-11-08 11:37:43 UTC
confirmation_delivered:
type: boolean
example: true
@@ -14282,6 +14894,32 @@ components:
required:
- promotion_category
x-internal: true
+ create_role_params:
+ type: object
+ properties:
+ role:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: vendor
+ required:
+ - zone
+ x-internal: true
+ update_role_params:
+ type: object
+ properties:
+ role:
+ type: object
+ properties:
+ name:
+ type: string
+ example: vendor
+ required:
+ - zone
+ x-internal: true
create_shipping_category_params:
type: object
properties:
@@ -14646,6 +15284,54 @@ components:
required:
- wished_item
x-internal: true
+ create_zone_params:
+ type: object
+ properties:
+ zone:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: EU
+ description:
+ type: string
+ example: All countries in the EU
+ default_tax:
+ type: boolean
+ kind:
+ type: string
+ example: state
+ enum:
+ - state
+ - country
+ required:
+ - zone
+ x-internal: true
+ update_zone_params:
+ type: object
+ properties:
+ address:
+ type: object
+ properties:
+ name:
+ type: string
+ example: EU
+ description:
+ type: string
+ example: All countries in the EU
+ default_tax:
+ type: boolean
+ kind:
+ type: string
+ example: state
+ enum:
+ - state
+ - country
+ required:
+ - zone
+ x-internal: true
amount_param:
type: object
properties:
diff --git a/api/spec/integration/api/v2/platform/roles_spec.rb b/api/spec/integration/api/v2/platform/roles_spec.rb
new file mode 100644
index 0000000000..939a086a15
--- /dev/null
+++ b/api/spec/integration/api/v2/platform/roles_spec.rb
@@ -0,0 +1,26 @@
+require 'swagger_helper'
+
+describe 'Roles API', swagger: true do
+ include_context 'Platform API v2'
+
+ resource_name = 'Role'
+ options = {
+ filter_examples: [{ name: 'filter[name_eq]', example: 'admin' }]
+ }
+
+ let(:id) { create(:role).id }
+ let(:records_list) { create_list(:role, 2) }
+ let(:valid_create_param_value) { build(:role).attributes }
+ let(:valid_update_param_value) do
+ {
+ name: 'administrator'
+ }
+ end
+ let(:invalid_param_value) do
+ {
+ name: ''
+ }
+ end
+
+ include_examples 'CRUD examples', resource_name, options
+end
diff --git a/api/spec/swagger_helper.rb b/api/spec/swagger_helper.rb
index b29b26af1d..0b21893a7c 100644
--- a/api/spec/swagger_helper.rb
+++ b/api/spec/swagger_helper.rb
@@ -57,6 +57,7 @@ RSpec.configure do |config|
{ name: 'Payments' },
{ name: 'Payment Methods' },
{ name: 'Promotion Categories' },
+ { name: 'Roles' },
{ name: 'Shipments' },
{ name: 'Shipping Categories' },
{ name: 'Shipping Methods' },
@@ -1184,6 +1185,35 @@ RSpec.configure do |config|
'x-internal': true
},
+ # Role
+ create_role_params: {
+ type: :object,
+ properties: {
+ role: {
+ type: :object,
+ required: %w[name],
+ properties: {
+ name: { type: :string, example: 'vendor' }
+ }
+ }
+ },
+ required: %w[zone],
+ 'x-internal': true
+ },
+ update_role_params: {
+ type: :object,
+ properties: {
+ role: {
+ type: :object,
+ properties: {
+ name: { type: :string, example: 'vendor' },
+ }
+ }
+ },
+ required: %w[zone],
+ 'x-internal': true
+ },
+
# Shipping Category
create_shipping_category_params: {
type: :object,