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.

use " it_behaves_like 'record updated' " where possible for response example schema

Matthew Kennedybc0ca20d48bf
diff --git a/api/docs/v2/platform/index.yaml b/api/docs/v2/platform/index.yaml
index 8455c7b9ff..dc11103ba4 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-10-29T16:23:12.782Z'
- updated_at: '2021-10-29T16:23:12.782Z'
+ created_at: '2021-10-29T22:37:16.250Z'
+ updated_at: '2021-10-29T22:37:16.250Z'
deleted_at:
label:
relationships:
@@ -98,8 +98,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T16:23:12.786Z'
- updated_at: '2021-10-29T16:23:12.786Z'
+ created_at: '2021-10-29T22:37:16.254Z'
+ updated_at: '2021-10-29T22:37:16.254Z'
deleted_at:
label:
relationships:
@@ -123,6 +123,8 @@ paths:
prev: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -131,6 +133,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create an Address
tags:
@@ -169,8 +173,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T16:23:13.002Z'
- updated_at: '2021-10-29T16:23:13.002Z'
+ created_at: '2021-10-29T22:37:16.455Z'
+ updated_at: '2021-10-29T22:37:16.455Z'
deleted_at:
label:
relationships:
@@ -186,6 +190,8 @@ paths:
data:
id: '1'
type: user
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -211,6 +217,8 @@ paths:
- can't be blank
phone:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -260,8 +268,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T16:23:13.036Z'
- updated_at: '2021-10-29T16:23:13.036Z'
+ created_at: '2021-10-29T22:37:16.485Z'
+ updated_at: '2021-10-29T22:37:16.485Z'
deleted_at:
label:
relationships:
@@ -275,6 +283,8 @@ paths:
type: state
user:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -283,6 +293,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -291,6 +303,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an Address
tags:
@@ -334,8 +348,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T16:23:13.085Z'
- updated_at: '2021-10-29T16:23:13.093Z'
+ created_at: '2021-10-29T22:37:16.532Z'
+ updated_at: '2021-10-29T22:37:16.539Z'
deleted_at:
label:
relationships:
@@ -349,6 +363,8 @@ paths:
type: state
user:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -362,6 +378,8 @@ paths:
- can't be blank
lastname:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -370,6 +388,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -378,6 +398,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -408,6 +430,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -416,6 +440,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/adjustments":
get:
summary: Return a list of Adjustments
@@ -467,8 +493,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T16:23:13.321Z'
- updated_at: '2021-10-29T16:23:13.321Z'
+ created_at: '2021-10-29T22:37:16.747Z'
+ updated_at: '2021-10-29T22:37:16.747Z'
state: open
included: false
display_amount: "$100.00"
@@ -494,8 +520,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T16:23:13.361Z'
- updated_at: '2021-10-29T16:23:13.361Z'
+ created_at: '2021-10-29T22:37:16.764Z'
+ updated_at: '2021-10-29T22:37:16.764Z'
state: open
included: false
display_amount: "$100.00"
@@ -522,6 +548,8 @@ paths:
prev: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/adjustments?filter%5Border_id%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -530,6 +558,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create an Adjustment
tags:
@@ -564,8 +594,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T16:23:13.667Z'
- updated_at: '2021-10-29T16:23:13.667Z'
+ created_at: '2021-10-29T22:37:17.031Z'
+ updated_at: '2021-10-29T22:37:17.031Z'
state: open
included: false
display_amount: "$100.00"
@@ -580,6 +610,8 @@ paths:
type: line_item
source:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -598,6 +630,8 @@ paths:
- can't be blank
amount:
- is not a number
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -643,8 +677,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T16:23:13.782Z'
- updated_at: '2021-10-29T16:23:13.787Z'
+ created_at: '2021-10-29T22:37:17.127Z'
+ updated_at: '2021-10-29T22:37:17.131Z'
state: open
included: false
display_amount: "$1.00"
@@ -661,6 +695,8 @@ paths:
data:
id: '5'
type: tax_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -669,6 +705,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -677,6 +715,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an Adjustment
tags:
@@ -716,8 +756,8 @@ paths:
label: New label
mandatory:
eligible: true
- created_at: '2021-10-29T16:23:14.007Z'
- updated_at: '2021-10-29T16:23:14.017Z'
+ created_at: '2021-10-29T22:37:17.308Z'
+ updated_at: '2021-10-29T22:37:17.322Z'
state: open
included: false
display_amount: "$15.00"
@@ -734,6 +774,8 @@ paths:
data:
id: '7'
type: tax_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -745,6 +787,8 @@ paths:
errors:
label:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -753,6 +797,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -761,6 +807,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -791,6 +839,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -799,6 +849,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/classifications":
get:
summary: Return a list of Classifications
@@ -845,8 +897,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T16:23:14.517Z'
- updated_at: '2021-10-29T16:23:14.517Z'
+ created_at: '2021-10-29T22:37:17.822Z'
+ updated_at: '2021-10-29T22:37:17.822Z'
relationships:
product:
data:
@@ -860,8 +912,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T16:23:14.586Z'
- updated_at: '2021-10-29T16:23:14.586Z'
+ created_at: '2021-10-29T22:37:17.889Z'
+ updated_at: '2021-10-29T22:37:17.889Z'
relationships:
product:
data:
@@ -881,6 +933,8 @@ paths:
prev: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/classifications?filter%5Btaxon_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -889,6 +943,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Classification
tags:
@@ -918,8 +974,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T16:23:15.081Z'
- updated_at: '2021-10-29T16:23:15.081Z'
+ created_at: '2021-10-29T22:37:18.396Z'
+ updated_at: '2021-10-29T22:37:18.396Z'
relationships:
product:
data:
@@ -929,6 +985,8 @@ paths:
data:
id: '10'
type: taxon
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -942,6 +1000,8 @@ paths:
- can't be blank
product:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -982,8 +1042,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T16:23:15.244Z'
- updated_at: '2021-10-29T16:23:15.244Z'
+ created_at: '2021-10-29T22:37:18.525Z'
+ updated_at: '2021-10-29T22:37:18.525Z'
relationships:
product:
data:
@@ -993,6 +1053,8 @@ paths:
data:
id: '12'
type: taxon
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -1001,6 +1063,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1009,6 +1073,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Classification
tags:
@@ -1043,8 +1109,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T16:23:15.583Z'
- updated_at: '2021-10-29T16:23:15.583Z'
+ created_at: '2021-10-29T22:37:18.809Z'
+ updated_at: '2021-10-29T22:37:18.809Z'
relationships:
product:
data:
@@ -1054,6 +1120,8 @@ paths:
data:
id: '16'
type: taxon
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1065,6 +1133,8 @@ paths:
errors:
product:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -1073,6 +1143,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1081,6 +1153,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -1111,6 +1185,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1119,6 +1195,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/classifications/{id}/reposition":
patch:
summary: Reposition a Classification
@@ -1154,8 +1232,8 @@ paths:
type: classification
attributes:
position: 2
- created_at: '2021-10-29T16:23:16.232Z'
- updated_at: '2021-10-29T16:23:16.250Z'
+ created_at: '2021-10-29T22:37:19.506Z'
+ updated_at: '2021-10-29T22:37:19.526Z'
relationships:
product:
data:
@@ -1165,6 +1243,8 @@ paths:
data:
id: '26'
type: taxon
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1174,6 +1254,8 @@ paths:
value:
error: is not a number
errors: {}
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -1182,6 +1264,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1190,6 +1274,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -1246,36 +1332,34 @@ paths:
- id: '1'
type: cms_page
attributes:
- title: Veniam expedita pariatur alias quia repudiandae placeat
- veritatis.
+ title: Eaque culpa occaecati temporibus cumque harum.
meta_title:
content:
meta_description:
visible: true
- slug: veniam-expedita-pariatur-alias-quia-repudiandae-placeat-veritatis
+ slug: eaque-culpa-occaecati-temporibus-cumque-harum
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T16:23:16.648Z'
- updated_at: '2021-10-29T16:23:16.648Z'
+ created_at: '2021-10-29T22:37:19.848Z'
+ updated_at: '2021-10-29T22:37:19.848Z'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
- title: Mollitia assumenda enim voluptate dicta nisi accusantium
- nesciunt.
+ title: Vel dolore dicta temporibus consectetur nisi eius labore.
meta_title:
content:
meta_description:
visible: true
- slug: mollitia-assumenda-enim-voluptate-dicta-nisi-accusantium-nesciunt
+ slug: vel-dolore-dicta-temporibus-consectetur-nisi-eius-labore
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T16:23:16.653Z'
- updated_at: '2021-10-29T16:23:16.653Z'
+ created_at: '2021-10-29T22:37:19.852Z'
+ updated_at: '2021-10-29T22:37:19.852Z'
relationships:
cms_sections:
data: []
@@ -1289,6 +1373,8 @@ paths:
prev: http://www.example.com/api/v2/platform/cms_pages?filter%5Btitle_cont%5D=&filter%5Btype%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/cms_pages?filter%5Btitle_cont%5D=&filter%5Btype%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/cms_pages?filter%5Btitle_cont%5D=&filter%5Btype%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -1297,6 +1383,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a CMS Page
tags:
@@ -1325,21 +1413,22 @@ paths:
id: '5'
type: cms_page
attributes:
- title: Praesentium sapiente nemo provident accusamus alias
- reprehenderit quae.
+ title: Eaque tempore incidunt at et dicta tenetur quasi.
meta_title:
content:
meta_description:
visible: true
- slug: praesentium-sapiente-nemo-provident-accusamus-alias-reprehenderit-quae
+ slug: eaque-tempore-incidunt-at-et-dicta-tenetur-quasi
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T16:23:16.727Z'
- updated_at: '2021-10-29T16:23:16.727Z'
+ created_at: '2021-10-29T22:37:19.920Z'
+ updated_at: '2021-10-29T22:37:19.920Z'
relationships:
cms_sections:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1353,6 +1442,8 @@ paths:
- can't be blank
locale:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -1392,21 +1483,22 @@ paths:
id: '6'
type: cms_page
attributes:
- title: Quibusdam ad ea consequatur rerum placeat quaerat natus
- nam.
+ title: Ratione quas ea in soluta.
meta_title:
content:
meta_description:
visible: true
- slug: quibusdam-ad-ea-consequatur-rerum-placeat-quaerat-natus-nam
+ slug: ratione-quas-ea-in-soluta
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T16:23:16.761Z'
- updated_at: '2021-10-29T16:23:16.761Z'
+ created_at: '2021-10-29T22:37:19.952Z'
+ updated_at: '2021-10-29T22:37:19.952Z'
relationships:
cms_sections:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -1415,6 +1507,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1423,6 +1517,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a CMS Page
tags:
@@ -1461,15 +1557,17 @@ paths:
content:
meta_description:
visible: true
- slug: voluptatibus-ea-cum-modi-quia-rem-eveniet-voluptatum-excepturi
+ slug: incidunt-beatae-quod-perspiciatis-adipisci-necessitatibus
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T16:23:16.820Z'
- updated_at: '2021-10-29T16:23:16.828Z'
+ created_at: '2021-10-29T22:37:20.011Z'
+ updated_at: '2021-10-29T22:37:20.020Z'
relationships:
cms_sections:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1481,6 +1579,8 @@ paths:
errors:
title:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -1489,6 +1589,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1497,6 +1599,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -1527,6 +1631,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1535,6 +1641,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/cms_sections":
get:
summary: Return a list of CMS Sections
@@ -1580,7 +1688,7 @@ paths:
- id: '1'
type: cms_section
attributes:
- name: Unde deserunt fugit rem veniam qui.
+ name: Sapiente in esse nostrum tenetur.
content: {}
settings:
gutters: No Gutters
@@ -1589,8 +1697,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Taxon
- created_at: '2021-10-29T16:23:16.984Z'
- updated_at: '2021-10-29T16:23:16.984Z'
+ created_at: '2021-10-29T22:37:20.251Z'
+ updated_at: '2021-10-29T22:37:20.251Z'
relationships:
cms_page:
data:
@@ -1601,8 +1709,8 @@ paths:
- id: '2'
type: cms_section
attributes:
- name: Nemo labore animi voluptas veritatis reiciendis ullam
- fugit soluta.
+ name: Fuga necessitatibus veritatis qui ea sapiente ipsam
+ deleniti earum.
content:
link_type_one: Spree::Taxon
link_type_two: Spree::Taxon
@@ -1614,8 +1722,8 @@ paths:
type: Spree::Cms::Sections::ImageGallery
position: 2
linked_resource_type:
- created_at: '2021-10-29T16:23:16.988Z'
- updated_at: '2021-10-29T16:23:16.988Z'
+ created_at: '2021-10-29T22:37:20.254Z'
+ updated_at: '2021-10-29T22:37:20.254Z'
relationships:
cms_page:
data:
@@ -1626,7 +1734,7 @@ paths:
- id: '3'
type: cms_section
attributes:
- name: Minima explicabo aut accusantium dolorum.
+ name: Est recusandae aperiam suscipit beatae.
content: {}
settings:
gutters: No Gutters
@@ -1635,8 +1743,8 @@ paths:
type: Spree::Cms::Sections::FeaturedArticle
position: 3
linked_resource_type: Spree::Taxon
- created_at: '2021-10-29T16:23:16.997Z'
- updated_at: '2021-10-29T16:23:16.997Z'
+ created_at: '2021-10-29T22:37:20.262Z'
+ updated_at: '2021-10-29T22:37:20.262Z'
relationships:
cms_page:
data:
@@ -1647,7 +1755,8 @@ paths:
- id: '4'
type: cms_section
attributes:
- name: Qui aspernatur sunt ab dolore assumenda.
+ name: Non cumque quisquam eligendi ipsam laudantium fugit
+ illo eveniet.
content: {}
settings:
gutters: No Gutters
@@ -1656,8 +1765,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:17.004Z'
- updated_at: '2021-10-29T16:23:17.004Z'
+ created_at: '2021-10-29T22:37:20.269Z'
+ updated_at: '2021-10-29T22:37:20.269Z'
relationships:
cms_page:
data:
@@ -1670,7 +1779,8 @@ paths:
- id: '5'
type: cms_section
attributes:
- name: Debitis molestias minima iusto a.
+ name: Numquam quidem iste iure in architecto dolorum minus
+ nesciunt.
content: {}
settings:
gutters: No Gutters
@@ -1679,8 +1789,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 5
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:17.011Z'
- updated_at: '2021-10-29T16:23:17.011Z'
+ created_at: '2021-10-29T22:37:20.276Z'
+ updated_at: '2021-10-29T22:37:20.276Z'
relationships:
cms_page:
data:
@@ -1700,6 +1810,8 @@ paths:
prev: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -1708,6 +1820,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a CMS Section
tags:
@@ -1736,7 +1850,7 @@ paths:
id: '14'
type: cms_section
attributes:
- name: Voluptatibus adipisci animi assumenda corporis.
+ name: Eaque deleniti sunt libero et in hic fugit dolor.
content: {}
settings:
gutters: No Gutters
@@ -1745,8 +1859,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:17.175Z'
- updated_at: '2021-10-29T16:23:17.175Z'
+ created_at: '2021-10-29T22:37:20.433Z'
+ updated_at: '2021-10-29T22:37:20.433Z'
relationships:
cms_page:
data:
@@ -1756,6 +1870,8 @@ paths:
data:
id: '26'
type: product
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1769,6 +1885,8 @@ paths:
- can't be blank
cms_page:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -1808,7 +1926,7 @@ paths:
id: '21'
type: cms_section
attributes:
- name: Reiciendis sunt soluta a dicta.
+ name: Iusto cum pariatur aut omnis sit.
content: {}
settings:
gutters: No Gutters
@@ -1817,8 +1935,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:17.308Z'
- updated_at: '2021-10-29T16:23:17.308Z'
+ created_at: '2021-10-29T22:37:20.562Z'
+ updated_at: '2021-10-29T22:37:20.562Z'
relationships:
cms_page:
data:
@@ -1828,6 +1946,8 @@ paths:
data:
id: '28'
type: product
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -1836,6 +1956,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1844,6 +1966,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a CMS Section
tags:
@@ -1886,8 +2010,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:17.578Z'
- updated_at: '2021-10-29T16:23:17.590Z'
+ created_at: '2021-10-29T22:37:20.763Z'
+ updated_at: '2021-10-29T22:37:20.774Z'
relationships:
cms_page:
data:
@@ -1897,6 +2021,8 @@ paths:
data:
id: '31'
type: product
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -1908,6 +2034,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -1916,6 +2044,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1924,6 +2054,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -1954,6 +2086,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -1962,6 +2096,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/cms_sections/{id}/reposition":
patch:
summary: Reposition a CMS Section
@@ -1989,7 +2125,7 @@ paths:
id: '58'
type: cms_section
attributes:
- name: Sint sunt quo iure eius facilis.
+ name: Impedit non consequatur ut cumque unde minus placeat.
content: {}
settings:
gutters: No Gutters
@@ -1998,8 +2134,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 3
linked_resource_type: Spree::Product
- created_at: '2021-10-29T16:23:18.085Z'
- updated_at: '2021-10-29T16:23:18.096Z'
+ created_at: '2021-10-29T22:37:21.332Z'
+ updated_at: '2021-10-29T22:37:21.343Z'
relationships:
cms_page:
data:
@@ -2009,6 +2145,8 @@ paths:
data:
id: '38'
type: product
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -2017,6 +2155,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2025,6 +2165,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -2057,9 +2199,9 @@ paths:
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-10-29T16:23:18.245Z'
+ updated_at: '2021-10-29T22:37:21.485Z'
zipcode_required: true
- created_at: '2021-10-29T16:23:18.245Z'
+ created_at: '2021-10-29T22:37:21.485Z'
relationships:
states:
data: []
@@ -2072,9 +2214,9 @@ paths:
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-10-29T16:23:18.251Z'
+ updated_at: '2021-10-29T22:37:21.490Z'
zipcode_required: true
- created_at: '2021-10-29T16:23:18.251Z'
+ created_at: '2021-10-29T22:37:21.490Z'
relationships:
states:
data: []
@@ -2087,9 +2229,9 @@ paths:
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-10-29T16:23:18.253Z'
+ updated_at: '2021-10-29T22:37:21.496Z'
zipcode_required: true
- created_at: '2021-10-29T16:23:18.253Z'
+ created_at: '2021-10-29T22:37:21.496Z'
relationships:
states:
data: []
@@ -2103,6 +2245,8 @@ paths:
prev: http://www.example.com/api/v2/platform/countries?page=1
last: http://www.example.com/api/v2/platform/countries?page=1
first: http://www.example.com/api/v2/platform/countries?page=1
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -2111,6 +2255,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/countries/{id}":
get:
summary: Returns a Country
@@ -2144,12 +2290,14 @@ paths:
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-10-29T16:23:18.297Z'
+ updated_at: '2021-10-29T22:37:21.540Z'
zipcode_required: true
- created_at: '2021-10-29T16:23:18.297Z'
+ created_at: '2021-10-29T22:37:21.540Z'
relationships:
states:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -2158,6 +2306,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2166,6 +2316,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/digital_links":
get:
summary: Return a list of Digital Links
@@ -2198,7 +2350,7 @@ paths:
- id: '1'
type: digital_link
attributes:
- token: PEWTTNV2EFPSRMBfj1XhqVE4
+ token: 7rfNAgnWtCwXkQRDxa177eWN
access_counter: 0
relationships:
digital:
@@ -2212,7 +2364,7 @@ paths:
- id: '2'
type: digital_link
attributes:
- token: y1h64XkrA8YYv4rwc1poo3wG
+ token: f4RAdiKEQwZDjM32W5TV5Gbh
access_counter: 0
relationships:
digital:
@@ -2233,6 +2385,8 @@ paths:
prev: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
last: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
first: http://www.example.com/api/v2/platform/digital_links?page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -2241,6 +2395,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Digital Link
tags:
@@ -2262,7 +2418,7 @@ paths:
id: '5'
type: digital_link
attributes:
- token: EtKe4Ymqk9uMpFj9656dayyW
+ token: wfYP5fr2TFoSAiKaxV4ahBMM
access_counter: 0
relationships:
digital:
@@ -2273,6 +2429,8 @@ paths:
data:
id: '13'
type: line_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -2289,6 +2447,8 @@ paths:
- can't be blank
access_counter:
- is not a number
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -2321,7 +2481,7 @@ paths:
id: '6'
type: digital_link
attributes:
- token: q9Ad7Ls1DnrohDeK8DupB5D5
+ token: xtWzdmfYGhYCnsJDmLjcUpAR
access_counter: 0
relationships:
digital:
@@ -2332,6 +2492,8 @@ paths:
data:
id: '14'
type: line_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -2340,6 +2502,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2348,6 +2512,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Digital Link
tags:
@@ -2374,7 +2540,7 @@ paths:
id: '8'
type: digital_link
attributes:
- token: d9gpcVBvLuwuAhyoMRJphMEJ
+ token: quyJoYRNXDASXS3R7ki7G4EM
access_counter: 0
relationships:
digital:
@@ -2385,6 +2551,8 @@ paths:
data:
id: '16'
type: line_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -2396,6 +2564,8 @@ paths:
errors:
access_counter:
- is not a number
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -2404,6 +2574,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2412,6 +2584,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -2442,6 +2616,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2450,6 +2626,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/digital_links/{id}/reset":
patch:
summary: Reset a Digital Link
@@ -2477,7 +2655,7 @@ paths:
id: '13'
type: digital_link
attributes:
- token: 7hC2vWpkPHanSY4oXST4YVEJ
+ token: UFEvUZxWWzZRwQdA4AiqLCAA
access_counter: 0
relationships:
digital:
@@ -2488,6 +2666,8 @@ paths:
data:
id: '21'
type: line_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -2496,6 +2676,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2504,6 +2686,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/digitals":
get:
summary: Return a list of Digital Assets
@@ -2586,6 +2770,8 @@ paths:
prev: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/digitals?include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -2594,6 +2780,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Digital Asset
tags:
@@ -2631,6 +2819,8 @@ paths:
data:
id: '100'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -2644,6 +2834,8 @@ paths:
- can't be blank
variant:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
multipart/form-data:
@@ -2692,6 +2884,8 @@ paths:
data:
id: '118'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -2700,6 +2894,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2708,6 +2904,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Digital Asset
tags:
@@ -2750,6 +2948,8 @@ paths:
data:
id: '140'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -2761,6 +2961,8 @@ paths:
errors:
variant:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -2769,6 +2971,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2777,6 +2981,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
multipart/form-data:
@@ -2807,6 +3013,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -2815,6 +3023,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/line_items":
get:
summary: Return a list of Line Items
@@ -2862,8 +3072,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T16:23:25.272Z'
- updated_at: '2021-10-29T16:23:25.288Z'
+ created_at: '2021-10-29T22:37:28.532Z'
+ updated_at: '2021-10-29T22:37:28.541Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -2909,8 +3119,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T16:23:25.320Z'
- updated_at: '2021-10-29T16:23:25.326Z'
+ created_at: '2021-10-29T22:37:28.569Z'
+ updated_at: '2021-10-29T22:37:28.574Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -2961,6 +3171,8 @@ paths:
prev: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/line_items?filter%5Border_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -2969,6 +3181,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Line Item
tags:
@@ -2999,8 +3213,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T16:23:25.532Z'
- updated_at: '2021-10-29T16:23:25.565Z'
+ created_at: '2021-10-29T22:37:28.772Z'
+ updated_at: '2021-10-29T22:37:28.806Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3041,6 +3255,8 @@ paths:
data: []
digital_links:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -3057,6 +3273,8 @@ paths:
- is not a number
currency:
- Must match order currency
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -3098,8 +3316,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T16:23:25.710Z'
- updated_at: '2021-10-29T16:23:25.718Z'
+ created_at: '2021-10-29T22:37:28.941Z'
+ updated_at: '2021-10-29T22:37:28.950Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3140,6 +3358,8 @@ paths:
data: []
digital_links:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -3148,6 +3368,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3156,6 +3378,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Line Item
tags:
@@ -3191,8 +3415,8 @@ paths:
attributes:
quantity: 4
price: '10.0'
- created_at: '2021-10-29T16:23:25.952Z'
- updated_at: '2021-10-29T16:23:25.991Z'
+ created_at: '2021-10-29T22:37:29.153Z'
+ updated_at: '2021-10-29T22:37:29.191Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3233,6 +3457,8 @@ paths:
data: []
digital_links:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -3240,10 +3466,12 @@ paths:
examples:
Example:
value:
- error: 'Quantity selected of "Product #133 - 6039" is not available.'
+ error: 'Quantity selected of "Product #133 - 9680" is not available.'
errors:
quantity:
- - 'selected of "Product #133 - 6039" is not available.'
+ - 'selected of "Product #133 - 9680" is not available.'
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -3252,6 +3480,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3260,6 +3490,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -3290,6 +3522,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3298,6 +3532,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/menu_items":
get:
summary: Return a list of Menu Items
@@ -3353,8 +3589,8 @@ paths:
lft: 2
rgt: 3
depth: 1
- created_at: '2021-10-29T16:23:26.672Z'
- updated_at: '2021-10-29T16:23:26.677Z'
+ created_at: '2021-10-29T22:37:29.887Z'
+ updated_at: '2021-10-29T22:37:29.893Z'
link:
is_container: false
is_root: false
@@ -3390,8 +3626,8 @@ paths:
lft: 4
rgt: 5
depth: 1
- created_at: '2021-10-29T16:23:26.724Z'
- updated_at: '2021-10-29T16:23:26.729Z'
+ created_at: '2021-10-29T22:37:29.941Z'
+ updated_at: '2021-10-29T22:37:29.945Z'
link:
is_container: false
is_root: false
@@ -3427,8 +3663,8 @@ paths:
lft: 6
rgt: 7
depth: 1
- created_at: '2021-10-29T16:23:26.775Z'
- updated_at: '2021-10-29T16:23:26.779Z'
+ created_at: '2021-10-29T22:37:29.992Z'
+ updated_at: '2021-10-29T22:37:29.996Z'
link:
is_container: false
is_root: false
@@ -3464,8 +3700,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T16:23:26.825Z'
- updated_at: '2021-10-29T16:23:26.829Z'
+ created_at: '2021-10-29T22:37:30.044Z'
+ updated_at: '2021-10-29T22:37:30.049Z'
link:
is_container: false
is_root: false
@@ -3501,8 +3737,8 @@ paths:
lft: 10
rgt: 11
depth: 1
- created_at: '2021-10-29T16:23:26.877Z'
- updated_at: '2021-10-29T16:23:26.881Z'
+ created_at: '2021-10-29T22:37:30.098Z'
+ updated_at: '2021-10-29T22:37:30.102Z'
link:
is_container: false
is_root: false
@@ -3538,8 +3774,8 @@ paths:
lft: 12
rgt: 13
depth: 1
- created_at: '2021-10-29T16:23:26.929Z'
- updated_at: '2021-10-29T16:23:26.934Z'
+ created_at: '2021-10-29T22:37:30.150Z'
+ updated_at: '2021-10-29T22:37:30.154Z'
link:
is_container: false
is_root: false
@@ -3575,8 +3811,8 @@ paths:
lft: 14
rgt: 15
depth: 1
- created_at: '2021-10-29T16:23:26.986Z'
- updated_at: '2021-10-29T16:23:26.999Z'
+ created_at: '2021-10-29T22:37:30.201Z'
+ updated_at: '2021-10-29T22:37:30.206Z'
link:
is_container: false
is_root: false
@@ -3602,7 +3838,7 @@ paths:
- id: '1'
type: menu_item
attributes:
- name: Vero esse ipsam itaque inventore.
+ name: Eos suscipit recusandae dolorum consequuntur cum voluptatem.
subtitle:
destination:
new_window: false
@@ -3612,8 +3848,8 @@ paths:
lft: 1
rgt: 16
depth: 0
- created_at: '2021-10-29T16:23:26.613Z'
- updated_at: '2021-10-29T16:23:27.010Z'
+ created_at: '2021-10-29T22:37:29.830Z'
+ updated_at: '2021-10-29T22:37:30.215Z'
link:
is_container: true
is_root: true
@@ -3656,6 +3892,8 @@ paths:
prev: http://www.example.com/api/v2/platform/menu_items?filter%5Bmenu_item_name_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/menu_items?filter%5Bmenu_item_name_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/menu_items?filter%5Bmenu_item_name_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -3664,6 +3902,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Menu Item
tags:
@@ -3702,8 +3942,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T16:23:27.621Z'
- updated_at: '2021-10-29T16:23:27.624Z'
+ created_at: '2021-10-29T22:37:30.823Z'
+ updated_at: '2021-10-29T22:37:30.827Z'
link:
is_container: false
is_root: false
@@ -3724,6 +3964,8 @@ paths:
data:
children:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -3740,6 +3982,8 @@ paths:
- can't be blank
item_type:
- is not included in the list
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -3789,8 +4033,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T16:23:28.026Z'
- updated_at: '2021-10-29T16:23:28.030Z'
+ created_at: '2021-10-29T22:37:31.248Z'
+ updated_at: '2021-10-29T22:37:31.253Z'
link:
is_container: false
is_root: false
@@ -3813,6 +4057,8 @@ paths:
data:
children:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -3821,6 +4067,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3829,6 +4077,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Menu Item
tags:
@@ -3872,8 +4122,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T16:23:28.684Z'
- updated_at: '2021-10-29T16:23:28.707Z'
+ created_at: '2021-10-29T22:37:31.934Z'
+ updated_at: '2021-10-29T22:37:31.957Z'
link:
is_container: false
is_root: false
@@ -3896,6 +4146,8 @@ paths:
data:
children:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -3907,6 +4159,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -3915,6 +4169,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3923,6 +4179,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -3953,6 +4211,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -3961,6 +4221,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/menu_items/{id}/reposition":
patch:
summary: Reposition a Menu Item
@@ -3998,8 +4260,8 @@ paths:
lft: 5
rgt: 6
depth: 2
- created_at: '2021-10-29T16:23:30.230Z'
- updated_at: '2021-10-29T16:23:30.254Z'
+ created_at: '2021-10-29T22:37:33.499Z'
+ updated_at: '2021-10-29T22:37:33.523Z'
link:
is_container: false
is_root: false
@@ -4022,6 +4284,8 @@ paths:
data:
children:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -4030,6 +4294,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4038,6 +4304,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -4091,8 +4359,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T16:23:30.697Z'
- updated_at: '2021-10-29T16:23:30.816Z'
+ created_at: '2021-10-29T22:37:34.000Z'
+ updated_at: '2021-10-29T22:37:34.112Z'
relationships:
menu_items:
data:
@@ -4108,8 +4376,8 @@ paths:
name: Footer Menu
location: footer
locale: en
- created_at: '2021-10-29T16:23:30.705Z'
- updated_at: '2021-10-29T16:23:30.916Z'
+ created_at: '2021-10-29T22:37:34.008Z'
+ updated_at: '2021-10-29T22:37:34.246Z'
relationships:
menu_items:
data:
@@ -4129,6 +4397,8 @@ paths:
prev: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -4137,6 +4407,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Menu
tags:
@@ -4168,13 +4440,15 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T16:23:31.199Z'
- updated_at: '2021-10-29T16:23:31.205Z'
+ created_at: '2021-10-29T22:37:34.548Z'
+ updated_at: '2021-10-29T22:37:34.554Z'
relationships:
menu_items:
data:
- id: '99'
type: menu_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4191,6 +4465,8 @@ paths:
- can't be blank
location:
- is not included in the list
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -4233,13 +4509,15 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T16:23:31.242Z'
- updated_at: '2021-10-29T16:23:31.249Z'
+ created_at: '2021-10-29T22:37:34.587Z'
+ updated_at: '2021-10-29T22:37:34.593Z'
relationships:
menu_items:
data:
- id: '100'
type: menu_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -4248,6 +4526,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4256,6 +4536,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Menu
tags:
@@ -4292,13 +4574,15 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T16:23:31.312Z'
- updated_at: '2021-10-29T16:23:31.318Z'
+ created_at: '2021-10-29T22:37:34.670Z'
+ updated_at: '2021-10-29T22:37:34.676Z'
relationships:
menu_items:
data:
- id: '102'
type: menu_item
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4315,6 +4599,8 @@ paths:
- can't be blank
location:
- is not included in the list
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -4323,6 +4609,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4331,6 +4619,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -4361,6 +4651,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4369,6 +4661,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/option_types":
get:
summary: Return a list of Option Types
@@ -4416,8 +4710,8 @@ paths:
name: foo-size-68
presentation: Size
position: 1
- created_at: '2021-10-29T16:23:31.491Z'
- updated_at: '2021-10-29T16:23:31.491Z'
+ created_at: '2021-10-29T22:37:34.850Z'
+ updated_at: '2021-10-29T22:37:34.850Z'
filterable: true
relationships:
option_values:
@@ -4428,8 +4722,8 @@ paths:
name: foo-size-69
presentation: Size
position: 2
- created_at: '2021-10-29T16:23:31.493Z'
- updated_at: '2021-10-29T16:23:31.493Z'
+ created_at: '2021-10-29T22:37:34.852Z'
+ updated_at: '2021-10-29T22:37:34.852Z'
filterable: true
relationships:
option_values:
@@ -4444,6 +4738,8 @@ paths:
prev: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
last: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
first: http://www.example.com/api/v2/platform/option_types?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -4452,6 +4748,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create an Option Type
tags:
@@ -4476,12 +4774,14 @@ paths:
name: foo-size-72
presentation: Size
position: 1
- created_at: '2021-10-29T16:23:31.541Z'
- updated_at: '2021-10-29T16:23:31.541Z'
+ created_at: '2021-10-29T22:37:34.901Z'
+ updated_at: '2021-10-29T22:37:34.901Z'
filterable: true
relationships:
option_values:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4495,6 +4795,8 @@ paths:
- can't be blank
presentation:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -4530,12 +4832,14 @@ paths:
name: foo-size-73
presentation: Size
position: 1
- created_at: '2021-10-29T16:23:31.572Z'
- updated_at: '2021-10-29T16:23:31.572Z'
+ created_at: '2021-10-29T22:37:34.931Z'
+ updated_at: '2021-10-29T22:37:34.931Z'
filterable: true
relationships:
option_values:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -4544,6 +4848,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4552,6 +4858,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an Option Type
tags:
@@ -4581,12 +4889,14 @@ paths:
name: Size-X
presentation: Size
position: 1
- created_at: '2021-10-29T16:23:31.620Z'
- updated_at: '2021-10-29T16:23:31.627Z'
+ created_at: '2021-10-29T22:37:34.977Z'
+ updated_at: '2021-10-29T22:37:34.984Z'
filterable: true
relationships:
option_values:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4598,6 +4908,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -4606,6 +4918,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4614,6 +4928,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -4644,6 +4960,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4652,6 +4970,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/option_values":
get:
summary: Return a list of Option Values
@@ -4706,8 +5026,8 @@ paths:
position: 1
name: Size-68
presentation: S
- created_at: '2021-10-29T16:23:31.747Z'
- updated_at: '2021-10-29T16:23:31.747Z'
+ created_at: '2021-10-29T22:37:35.102Z'
+ updated_at: '2021-10-29T22:37:35.102Z'
relationships:
option_type:
data:
@@ -4719,8 +5039,8 @@ paths:
position: 1
name: Size-69
presentation: S
- created_at: '2021-10-29T16:23:31.753Z'
- updated_at: '2021-10-29T16:23:31.753Z'
+ created_at: '2021-10-29T22:37:35.109Z'
+ updated_at: '2021-10-29T22:37:35.109Z'
relationships:
option_type:
data:
@@ -4736,6 +5056,8 @@ paths:
prev: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/option_values?filter%5Bname_cont%5D=&filter%5Boption_type_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -4744,6 +5066,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create an Option Value
tags:
@@ -4775,11 +5099,13 @@ paths:
position: 1
name: Size-72
presentation: S
- created_at: '2021-10-29T16:23:31.811Z'
- updated_at: '2021-10-29T16:23:31.811Z'
+ created_at: '2021-10-29T22:37:35.164Z'
+ updated_at: '2021-10-29T22:37:35.164Z'
relationships:
option_type:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4793,6 +5119,8 @@ paths:
- can't be blank
presentation:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -4835,13 +5163,15 @@ paths:
position: 1
name: Size-73
presentation: S
- created_at: '2021-10-29T16:23:31.847Z'
- updated_at: '2021-10-29T16:23:31.847Z'
+ created_at: '2021-10-29T22:37:35.194Z'
+ updated_at: '2021-10-29T22:37:35.194Z'
relationships:
option_type:
data:
id: '84'
type: option_type
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -4850,6 +5180,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4858,6 +5190,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an Option Value
tags:
@@ -4894,13 +5228,15 @@ paths:
position: 1
name: M
presentation: S
- created_at: '2021-10-29T16:23:31.905Z'
- updated_at: '2021-10-29T16:23:31.914Z'
+ created_at: '2021-10-29T22:37:35.248Z'
+ updated_at: '2021-10-29T22:37:35.256Z'
relationships:
option_type:
data:
id: '86'
type: option_type
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -4912,6 +5248,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -4920,6 +5258,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4928,6 +5268,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -4958,6 +5300,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -4966,6 +5310,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders":
get:
summary: Return a list of Orders
@@ -5011,7 +5357,7 @@ paths:
- id: '40'
type: order
attributes:
- number: R891919897
+ number: R711934114
item_total: '0.0'
total: '0.0'
state: cart
@@ -5020,10 +5366,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:32.061Z'
- updated_at: '2021-10-29T16:23:32.061Z'
+ created_at: '2021-10-29T22:37:35.400Z'
+ updated_at: '2021-10-29T22:37:35.400Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5095,7 +5441,7 @@ paths:
- id: '41'
type: order
attributes:
- number: R332839021
+ number: R813613111
item_total: '0.0'
total: '0.0'
state: cart
@@ -5104,10 +5450,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:32.070Z'
- updated_at: '2021-10-29T16:23:32.070Z'
+ created_at: '2021-10-29T22:37:35.408Z'
+ updated_at: '2021-10-29T22:37:35.408Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5186,6 +5532,8 @@ paths:
prev: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/orders?filter%5Bstate_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -5194,6 +5542,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Creates an Order
tags:
@@ -5222,7 +5572,7 @@ paths:
id: '44'
type: order
attributes:
- number: R023732783
+ number: R598507074
item_total: '0.0'
total: '0.0'
state: cart
@@ -5233,8 +5583,8 @@ paths:
payment_state:
email:
special_instructions:
- created_at: '2021-10-29T16:23:32.360Z'
- updated_at: '2021-10-29T16:23:32.378Z'
+ created_at: '2021-10-29T22:37:35.688Z'
+ updated_at: '2021-10-29T22:37:35.701Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5307,6 +5657,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
requestBody:
content:
application/json:
@@ -5346,7 +5698,7 @@ paths:
id: '45'
type: order
attributes:
- number: R926925912
+ number: R275840570
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5355,10 +5707,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:32.421Z'
- updated_at: '2021-10-29T16:23:32.562Z'
+ created_at: '2021-10-29T22:37:35.737Z'
+ updated_at: '2021-10-29T22:37:35.884Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5433,6 +5785,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -5441,6 +5795,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -5449,6 +5805,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an Order
tags:
@@ -5482,7 +5840,7 @@ paths:
id: '47'
type: order
attributes:
- number: R907006341
+ number: R612896884
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5493,8 +5851,8 @@ paths:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:32.750Z'
- updated_at: '2021-10-29T16:23:32.846Z'
+ created_at: '2021-10-29T22:37:36.048Z'
+ updated_at: '2021-10-29T22:37:36.140Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5569,6 +5927,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -5580,6 +5940,8 @@ paths:
errors:
email:
- is invalid
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -5588,6 +5950,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -5596,6 +5960,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -5626,6 +5992,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -5634,6 +6002,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/advance":
patch:
summary: Advances an Order
@@ -5668,7 +6038,7 @@ paths:
id: '52'
type: order
attributes:
- number: R176647168
+ number: R086394308
item_total: '10.0'
total: '110.0'
state: payment
@@ -5677,10 +6047,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:33.409Z'
- updated_at: '2021-10-29T16:23:33.544Z'
+ created_at: '2021-10-29T22:37:36.681Z'
+ updated_at: '2021-10-29T22:37:36.812Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5757,6 +6127,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -5765,6 +6137,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -5773,6 +6147,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/next":
patch:
summary: Next an Order
@@ -5807,7 +6183,7 @@ paths:
id: '54'
type: order
attributes:
- number: R231839436
+ number: R650614089
item_total: '10.0'
total: '110.0'
state: payment
@@ -5816,10 +6192,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:33.734Z'
- updated_at: '2021-10-29T16:23:33.871Z'
+ created_at: '2021-10-29T22:37:36.992Z'
+ updated_at: '2021-10-29T22:37:37.125Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5896,6 +6272,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -5904,6 +6282,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -5912,6 +6292,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/complete":
patch:
summary: Completes an Order
@@ -5946,19 +6328,19 @@ paths:
id: '56'
type: order
attributes:
- number: R635421047
+ number: R732790132
item_total: '10.0'
total: '110.0'
state: complete
adjustment_total: '0.0'
- completed_at: '2021-10-29T16:23:34.267Z'
+ completed_at: '2021-10-29T22:37:37.507Z'
payment_total: '0.0'
shipment_state: pending
payment_state: balance_due
special_instructions:
- created_at: '2021-10-29T16:23:34.031Z'
- updated_at: '2021-10-29T16:23:34.267Z'
+ created_at: '2021-10-29T22:37:37.312Z'
+ updated_at: '2021-10-29T22:37:37.507Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6045,6 +6427,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -6053,6 +6437,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -6061,6 +6447,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/empty":
patch:
summary: Empties an Order
@@ -6096,7 +6484,7 @@ paths:
id: '59'
type: order
attributes:
- number: R958019652
+ number: R891868374
item_total: '0.0'
total: '0.0'
state: cart
@@ -6105,10 +6493,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:34.570Z'
- updated_at: '2021-10-29T16:23:34.683Z'
+ created_at: '2021-10-29T22:37:37.804Z'
+ updated_at: '2021-10-29T22:37:37.913Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -6179,6 +6567,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -6187,6 +6577,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -6195,6 +6587,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/approve":
patch:
summary: Approves an Order
@@ -6220,7 +6614,7 @@ paths:
type: string
responses:
'200':
- description: record approved
+ description: record updated
content:
application/vnd.api+json:
examples:
@@ -6230,7 +6624,7 @@ paths:
id: '61'
type: order
attributes:
- number: R693685425
+ number: R233772120
item_total: '10.0'
total: '110.0'
state: delivery
@@ -6239,10 +6633,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T16:23:34.838Z'
- updated_at: '2021-10-29T16:23:34.921Z'
+ created_at: '2021-10-29T22:37:38.064Z'
+ updated_at: '2021-10-29T22:37:38.147Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6317,6 +6711,8 @@ paths:
data: []
order_promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -6325,6 +6721,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -6333,6 +6731,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/cancel":
patch:
summary: Cancels an Order
@@ -6359,119 +6759,8 @@ paths:
responses:
'200':
description: record canceled
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- data:
- id: '63'
- type: order
- attributes:
- number: R427194240
- item_total: '10.0'
- total: '10.0'
- state: canceled
- adjustment_total: '0.0'
- completed_at: '2021-10-29T16:23:35.242Z'
- payment_total: '0.0'
- shipment_state: canceled
- payment_state: void
- special_instructions:
- created_at: '2021-10-29T16:23:35.128Z'
- updated_at: '2021-10-29T16:23:35.301Z'
- currency: USD
- last_ip_address:
- shipment_total: '0.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- channel: spree
- included_tax_total: '0.0'
- item_count: 1
- approved_at:
- confirmation_delivered: false
- canceled_at:
- state_lock_version: 0
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- store_owner_notification_delivered:
- display_pre_tax_total: "$10.00"
- display_ship_total: "$0.00"
- display_shipment_total: "$0.00"
- display_total: "$10.00"
- display_outstanding_balance: "$0.00"
- display_item_total: "$10.00"
- display_tax_total: "$0.00"
- display_cart_promo_total: "$0.00"
- display_pre_tax_item_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_total_applicable_store_credit: "$0.00"
- display_total_applied_store_credit: "$0.00"
- display_order_total_after_store_credit: "$10.00"
- display_total_available_store_credit: "$0.00"
- display_store_credit_remaining_after_capture: "$0.00"
- relationships:
- user:
- data:
- id: '63'
- type: user
- created_by:
- data:
- approver:
- data:
- canceler:
- data:
- bill_address:
- data:
- id: '93'
- type: address
- ship_address:
- data:
- id: '94'
- type: address
- line_items:
- data:
- - id: '54'
- type: line_item
- payments:
- data: []
- shipments:
- data:
- - id: '19'
- type: shipment
- state_changes:
- data:
- - id: '11'
- type: state_change
- - id: '13'
- type: state_change
- - id: '14'
- type: state_change
- return_authorizations:
- data: []
- reimbursements:
- data: []
- adjustments:
- data: []
- all_adjustments:
- data: []
- order_promotions:
- data: []
'422':
description: cannot be canceled
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: State cannot transition via "cancel"
- errors:
- state:
- - cannot transition via "cancel"
'404':
description: Record not found
content:
@@ -6480,6 +6769,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -6488,6 +6779,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/orders/{id}/use_store_credit":
patch:
summary: Use Store Credit for an Order
@@ -6513,113 +6806,8 @@ paths:
responses:
'200':
description: store credit payment created
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- data:
- id: '66'
- type: order
- attributes:
- number: R657295390
- item_total: '10.0'
- total: '110.0'
- state: delivery
- adjustment_total: '0.0'
- completed_at:
- payment_total: '0.0'
- shipment_state:
- payment_state:
- special_instructions:
- created_at: '2021-10-29T16:23:35.591Z'
- updated_at: '2021-10-29T16:23:35.743Z'
- currency: USD
- last_ip_address:
- shipment_total: '100.0'
- additional_tax_total: '0.0'
- promo_total: '0.0'
- channel: spree
- included_tax_total: '0.0'
- item_count: 1
- approved_at:
- confirmation_delivered: false
- canceled_at:
- state_lock_version: 0
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- store_owner_notification_delivered:
- display_pre_tax_total: "$10.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$110.00"
- display_outstanding_balance: "$110.00"
- display_item_total: "$10.00"
- display_tax_total: "$0.00"
- display_cart_promo_total: "$0.00"
- display_pre_tax_item_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_total_applicable_store_credit: "-$15.00"
- display_total_applied_store_credit: "-$15.00"
- display_order_total_after_store_credit: "$95.00"
- display_total_available_store_credit: "$15.00"
- display_store_credit_remaining_after_capture: "$0.00"
- relationships:
- user:
- data:
- id: '66'
- type: user
- created_by:
- data:
- approver:
- data:
- canceler:
- data:
- bill_address:
- data:
- id: '99'
- type: address
- ship_address:
- data:
- id: '100'
- type: address
- line_items:
- data:
- - id: '57'
- type: line_item
- payments:
- data:
- - id: '5'
- type: payment
- shipments:
- data:
- - id: '22'
- type: shipment
- state_changes:
- data: []
- return_authorizations:
- data: []
- reimbursements:
- data: []
- adjustments:
- data: []
- all_adjustments:
- data: []
- order_promotions:
- data: []
'422':
description: user does not have store credit available
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: User does not have any Store Credits available
- errors: {}
'404':
description: Record not found
content:
@@ -6628,6 +6816,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -6636,6 +6826,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -6666,194 +6858,92 @@ paths:
responses:
'200':
description: coupon code applied
+ '422':
+ description: coupon code couldn't be applied
+ '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/coupon_code_param"
+ "/api/v2/platform/payments":
+ get:
+ summary: Return a list of Payments
+ tags:
+ - Payments
+ security:
+ - bearer_auth: []
+ description: Returns a list of Payments
+ operationId: payments-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: payment_method,order,source
+ schema:
+ type: string
+ - name: filter[payment_method_id_eq]
+ in: query
+ description: ''
+ example: '1'
+ schema:
+ type: string
+ - name: filter[amount_gteq]
+ in: query
+ description: ''
+ example: '99.90'
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
content:
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '69'
- type: order
- attributes:
- number: R047726312
- item_total: '10.0'
- total: '10.0'
- state: delivery
- adjustment_total: "-100.0"
- completed_at:
- payment_total: '0.0'
- shipment_state:
- payment_state:
- special_instructions:
- created_at: '2021-10-29T16:23:36.088Z'
- updated_at: '2021-10-29T16:23:36.227Z'
- currency: USD
- last_ip_address:
- shipment_total: '100.0'
- additional_tax_total: '0.0'
- promo_total: "-100.0"
- channel: spree
- included_tax_total: '0.0'
- item_count: 1
- approved_at:
- confirmation_delivered: false
- canceled_at:
- state_lock_version: 0
- taxable_adjustment_total: '0.0'
- non_taxable_adjustment_total: '0.0'
- store_owner_notification_delivered:
- display_pre_tax_total: "$10.00"
- display_ship_total: "$100.00"
- display_shipment_total: "$100.00"
- display_total: "$10.00"
- display_outstanding_balance: "$10.00"
- display_item_total: "$10.00"
- display_tax_total: "$0.00"
- display_cart_promo_total: "$0.00"
- display_pre_tax_item_amount: "$10.00"
- display_adjustment_total: "-$100.00"
- display_additional_tax_total: "$0.00"
- display_promo_total: "-$100.00"
- display_included_tax_total: "$0.00"
- display_total_applicable_store_credit: "$0.00"
- display_total_applied_store_credit: "$0.00"
- display_order_total_after_store_credit: "$10.00"
- display_total_available_store_credit: "$0.00"
- display_store_credit_remaining_after_capture: "$0.00"
- relationships:
- user:
- data:
- id: '70'
- type: user
- created_by:
- data:
- approver:
- data:
- canceler:
- data:
- bill_address:
- data:
- id: '105'
- type: address
- ship_address:
- data:
- id: '106'
- type: address
- line_items:
- data:
- - id: '60'
- type: line_item
- payments:
- data: []
- shipments:
- data:
- - id: '25'
- type: shipment
- state_changes:
- data: []
- return_authorizations:
- data: []
- reimbursements:
- data: []
- adjustments:
- data: []
- all_adjustments:
- data:
- - id: '13'
- type: adjustment
- order_promotions:
- data:
- - id: '1'
- type: order_promotion
- '422':
- description: coupon code couldn't be applied
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The coupon code you entered doesn't exist. Please try again.
- '404':
- description: Record not found
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The resource you were looking for could not be found.
- '401':
- description: Authentication Failed
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- error: The access token is invalid
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/coupon_code_param"
- "/api/v2/platform/payments":
- get:
- summary: Return a list of Payments
- tags:
- - Payments
- security:
- - bearer_auth: []
- description: Returns a list of Payments
- operationId: payments-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: payment_method,order,source
- schema:
- type: string
- - name: filter[payment_method_id_eq]
- in: query
- description: ''
- example: '1'
- schema:
- type: string
- - name: filter[amount_gteq]
- in: query
- description: ''
- example: '99.90'
- schema:
- type: string
- responses:
- '200':
- description: Records returned
- content:
- application/vnd.api+json:
- examples:
- Example:
- value:
- data:
- - id: '6'
- type: payment
+ - id: '6'
+ type: payment
attributes:
amount: '45.75'
source_type: Spree::CreditCard
state: invalid
response_code: '12345'
avs_response:
- created_at: '2021-10-29T16:23:36.561Z'
- updated_at: '2021-10-29T16:23:36.581Z'
- number: PPYSW32E
+ created_at: '2021-10-29T22:37:39.689Z'
+ updated_at: '2021-10-29T22:37:39.707Z'
+ number: PQAJTV43
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -6888,9 +6978,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-10-29T16:23:36.578Z'
- updated_at: '2021-10-29T16:23:36.578Z'
- number: P9558W5L
+ created_at: '2021-10-29T22:37:39.704Z'
+ updated_at: '2021-10-29T22:37:39.704Z'
+ number: PXUZXZ7D
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -6925,6 +7015,8 @@ paths:
prev: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -6933,6 +7025,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/payments/{id}":
get:
summary: Return a Payment
@@ -6972,9 +7066,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-10-29T16:23:36.740Z'
- updated_at: '2021-10-29T16:23:36.740Z'
- number: P4CP34YC
+ created_at: '2021-10-29T22:37:39.857Z'
+ updated_at: '2021-10-29T22:37:39.857Z'
+ number: P0IYIUQF
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -6999,6 +7093,8 @@ paths:
data: []
refunds:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7007,6 +7103,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7015,6 +7113,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
delete:
summary: Delete a Payment
tags:
@@ -7040,6 +7140,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7048,6 +7150,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/promotion_categories":
get:
summary: Return a list of Promotion Categories
@@ -7100,8 +7204,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T16:23:36.961Z'
- updated_at: '2021-10-29T16:23:36.961Z'
+ created_at: '2021-10-29T22:37:40.061Z'
+ updated_at: '2021-10-29T22:37:40.061Z'
code: POP123
relationships:
promotions:
@@ -7110,8 +7214,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T16:23:36.963Z'
- updated_at: '2021-10-29T16:23:36.963Z'
+ created_at: '2021-10-29T22:37:40.063Z'
+ updated_at: '2021-10-29T22:37:40.063Z'
code: POP123
relationships:
promotions:
@@ -7126,6 +7230,8 @@ paths:
prev: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode%5D=&filter%5Bname%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode%5D=&filter%5Bname%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode%5D=&filter%5Bname%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -7134,6 +7240,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Promotion Category
tags:
@@ -7163,12 +7271,14 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T16:23:37.009Z'
- updated_at: '2021-10-29T16:23:37.009Z'
+ created_at: '2021-10-29T22:37:40.105Z'
+ updated_at: '2021-10-29T22:37:40.105Z'
code: 2021-BFM
relationships:
promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -7180,6 +7290,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -7220,12 +7332,14 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T16:23:37.037Z'
- updated_at: '2021-10-29T16:23:37.037Z'
+ created_at: '2021-10-29T22:37:40.139Z'
+ updated_at: '2021-10-29T22:37:40.139Z'
code: MJO
relationships:
promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7234,6 +7348,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7242,6 +7358,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Promotion Category
tags:
@@ -7276,12 +7394,14 @@ paths:
type: promotion_category
attributes:
name: 2021 Promotions
- created_at: '2021-10-29T16:23:37.083Z'
- updated_at: '2021-10-29T16:23:37.088Z'
+ created_at: '2021-10-29T22:37:40.188Z'
+ updated_at: '2021-10-29T22:37:40.194Z'
code: 2021-Promos
relationships:
promotions:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -7293,6 +7413,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -7301,6 +7423,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7309,6 +7433,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -7339,6 +7465,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7347,6 +7475,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments":
get:
summary: Return a list of Shipments
@@ -7393,12 +7523,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H31756127386
+ number: H03043946098
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T16:23:37.212Z'
- updated_at: '2021-10-29T16:23:37.216Z'
+ created_at: '2021-10-29T22:37:40.314Z'
+ updated_at: '2021-10-29T22:37:40.317Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7440,12 +7570,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H51033942613
+ number: H31813446413
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T16:23:37.244Z'
- updated_at: '2021-10-29T16:23:37.247Z'
+ created_at: '2021-10-29T22:37:40.344Z'
+ updated_at: '2021-10-29T22:37:40.348Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7493,6 +7623,8 @@ paths:
prev: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -7501,6 +7633,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}":
get:
summary: Return a Shipment
@@ -7536,12 +7670,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H63166306042
+ number: H31811256833
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T16:23:37.547Z'
- updated_at: '2021-10-29T16:23:37.566Z'
+ created_at: '2021-10-29T22:37:40.643Z'
+ updated_at: '2021-10-29T22:37:40.661Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7581,6 +7715,8 @@ paths:
data:
id: '37'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7589,6 +7725,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7597,6 +7735,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
delete:
summary: Delete a Shipment
tags:
@@ -7622,6 +7762,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7630,6 +7772,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}/ready":
patch:
summary: Mark Shipment as ready to be shipped
@@ -7665,12 +7809,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H01487520328
+ number: H88928102789
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-10-29T16:23:38.406Z'
- updated_at: '2021-10-29T16:23:38.436Z'
+ created_at: '2021-10-29T22:37:41.437Z'
+ updated_at: '2021-10-29T22:37:41.461Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7712,6 +7856,8 @@ paths:
data:
id: '53'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7720,6 +7866,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7728,6 +7876,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}/ship":
patch:
summary: Mark Shipment as shipped
@@ -7763,12 +7913,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H72008525025
+ number: H00455357252
cost: '100.0'
- shipped_at: '2021-10-29T16:23:38.876Z'
+ shipped_at: '2021-10-29T22:37:41.873Z'
state: shipped
- created_at: '2021-10-29T16:23:38.841Z'
- updated_at: '2021-10-29T16:23:38.876Z'
+ created_at: '2021-10-29T22:37:41.834Z'
+ updated_at: '2021-10-29T22:37:41.873Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7810,6 +7960,8 @@ paths:
data:
id: '61'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7818,6 +7970,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7826,6 +7980,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}/cancel":
patch:
summary: Cancels the Shipment
@@ -7861,12 +8017,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H50576869674
+ number: H81229596042
cost: '100.0'
shipped_at:
state: canceled
- created_at: '2021-10-29T16:23:39.280Z'
- updated_at: '2021-10-29T16:23:39.305Z'
+ created_at: '2021-10-29T22:37:42.257Z'
+ updated_at: '2021-10-29T22:37:42.283Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7908,6 +8064,8 @@ paths:
data:
id: '69'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -7916,6 +8074,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -7924,6 +8084,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}/resume":
patch:
summary: Resumes the Shipment
@@ -7959,12 +8121,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H27278186879
+ number: H60432752617
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-10-29T16:23:39.705Z'
- updated_at: '2021-10-29T16:23:39.734Z'
+ created_at: '2021-10-29T22:37:42.666Z'
+ updated_at: '2021-10-29T22:37:42.695Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8006,6 +8168,8 @@ paths:
data:
id: '77'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -8014,6 +8178,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8022,6 +8188,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipments/{id}/pend":
patch:
summary: Moves Shipment back to pending state
@@ -8057,12 +8225,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H03186671627
+ number: H58735809312
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T16:23:40.149Z'
- updated_at: '2021-10-29T16:23:40.178Z'
+ created_at: '2021-10-29T22:37:43.103Z'
+ updated_at: '2021-10-29T22:37:43.130Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8104,6 +8272,8 @@ paths:
data:
id: '85'
type: shipping_rate
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -8112,6 +8282,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8120,6 +8292,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipping_categories":
get:
summary: Return a list of Shipping Categories
@@ -8159,14 +8333,14 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #119'
- created_at: '2021-10-29T16:23:40.498Z'
- updated_at: '2021-10-29T16:23:40.498Z'
+ created_at: '2021-10-29T22:37:43.365Z'
+ updated_at: '2021-10-29T22:37:43.365Z'
- id: '120'
type: shipping_category
attributes:
name: 'ShippingCategory #120'
- created_at: '2021-10-29T16:23:40.499Z'
- updated_at: '2021-10-29T16:23:40.499Z'
+ created_at: '2021-10-29T22:37:43.366Z'
+ updated_at: '2021-10-29T22:37:43.366Z'
meta:
count: 2
total_count: 2
@@ -8177,6 +8351,8 @@ paths:
prev: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
last: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
first: http://www.example.com/api/v2/platform/shipping_categories?filter%5Bname_i_cont%5D=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -8185,6 +8361,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Shipping Category
tags:
@@ -8207,8 +8385,10 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #123'
- created_at: '2021-10-29T16:23:40.544Z'
- updated_at: '2021-10-29T16:23:40.544Z'
+ created_at: '2021-10-29T22:37:43.412Z'
+ updated_at: '2021-10-29T22:37:43.412Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -8220,6 +8400,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -8253,8 +8435,10 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #124'
- created_at: '2021-10-29T16:23:40.573Z'
- updated_at: '2021-10-29T16:23:40.573Z'
+ created_at: '2021-10-29T22:37:43.440Z'
+ updated_at: '2021-10-29T22:37:43.440Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -8263,6 +8447,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8271,6 +8457,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Shipping Category
tags:
@@ -8298,8 +8486,10 @@ paths:
type: shipping_category
attributes:
name: Default
- created_at: '2021-10-29T16:23:40.620Z'
- updated_at: '2021-10-29T16:23:40.626Z'
+ created_at: '2021-10-29T22:37:43.494Z'
+ updated_at: '2021-10-29T22:37:43.501Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -8311,6 +8501,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -8319,6 +8511,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8327,6 +8521,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -8357,6 +8553,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8365,6 +8563,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/shipping_methods":
get:
summary: Return a list of Shipping Methods
@@ -8421,8 +8621,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T16:23:40.741Z'
- updated_at: '2021-10-29T16:23:40.741Z'
+ created_at: '2021-10-29T22:37:43.614Z'
+ updated_at: '2021-10-29T22:37:43.614Z'
deleted_at:
relationships:
shipping_categories:
@@ -8445,8 +8645,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T16:23:40.751Z'
- updated_at: '2021-10-29T16:23:40.751Z'
+ created_at: '2021-10-29T22:37:43.624Z'
+ updated_at: '2021-10-29T22:37:43.624Z'
deleted_at:
relationships:
shipping_categories:
@@ -8471,6 +8671,8 @@ paths:
prev: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -8479,6 +8681,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Shipping Method
tags:
@@ -8512,8 +8716,8 @@ paths:
admin_name: DHL Express- Zone A
display_on: both
tracking_url:
- created_at: '2021-10-29T16:23:40.836Z'
- updated_at: '2021-10-29T16:23:40.836Z'
+ created_at: '2021-10-29T22:37:43.793Z'
+ updated_at: '2021-10-29T22:37:43.793Z'
deleted_at:
relationships:
shipping_categories:
@@ -8530,6 +8734,8 @@ paths:
data:
id: '75'
type: calculator
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -8549,6 +8755,8 @@ paths:
- can't be blank
base:
- You must select at least one shipping category
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -8593,8 +8801,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T16:23:40.879Z'
- updated_at: '2021-10-29T16:23:40.879Z'
+ created_at: '2021-10-29T22:37:43.835Z'
+ updated_at: '2021-10-29T22:37:43.835Z'
deleted_at:
relationships:
shipping_categories:
@@ -8609,6 +8817,8 @@ paths:
data:
id: '76'
type: calculator
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -8617,6 +8827,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8625,6 +8837,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Shipping Method
tags:
@@ -8663,8 +8877,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T16:23:40.952Z'
- updated_at: '2021-10-29T16:23:40.967Z'
+ created_at: '2021-10-29T22:37:43.905Z'
+ updated_at: '2021-10-29T22:37:43.919Z'
deleted_at:
relationships:
shipping_categories:
@@ -8679,6 +8893,8 @@ paths:
data:
id: '79'
type: calculator
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -8690,6 +8906,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -8698,6 +8916,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8706,6 +8926,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -8736,6 +8958,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -8744,6 +8968,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/taxons":
get:
summary: Return a list of Taxons
@@ -8801,8 +9027,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T16:23:41.193Z'
- updated_at: '2021-10-29T16:23:41.196Z'
+ created_at: '2021-10-29T22:37:44.143Z'
+ updated_at: '2021-10-29T22:37:44.147Z'
meta_title:
meta_description:
meta_keywords:
@@ -8836,8 +9062,8 @@ paths:
lft: 4
rgt: 5
description:
- created_at: '2021-10-29T16:23:41.243Z'
- updated_at: '2021-10-29T16:23:41.247Z'
+ created_at: '2021-10-29T22:37:44.196Z'
+ updated_at: '2021-10-29T22:37:44.200Z'
meta_title:
meta_description:
meta_keywords:
@@ -8871,8 +9097,8 @@ paths:
lft: 1
rgt: 6
description:
- created_at: '2021-10-29T16:23:41.136Z'
- updated_at: '2021-10-29T16:23:41.255Z'
+ created_at: '2021-10-29T22:37:44.088Z'
+ updated_at: '2021-10-29T22:37:44.211Z'
meta_title:
meta_description:
meta_keywords:
@@ -8907,6 +9133,8 @@ paths:
prev: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/taxons?filter%5Bname_cont%5D=&filter%5Btaxonomy_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -8915,6 +9143,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Taxon
tags:
@@ -8949,8 +9179,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T16:23:41.490Z'
- updated_at: '2021-10-29T16:23:41.494Z'
+ created_at: '2021-10-29T22:37:44.445Z'
+ updated_at: '2021-10-29T22:37:44.449Z'
meta_title:
meta_description:
meta_keywords:
@@ -8973,6 +9203,8 @@ paths:
data: []
image:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -8986,6 +9218,8 @@ paths:
- can't be blank
taxonomy:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -9031,8 +9265,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T16:23:41.586Z'
- updated_at: '2021-10-29T16:23:41.590Z'
+ created_at: '2021-10-29T22:37:44.543Z'
+ updated_at: '2021-10-29T22:37:44.547Z'
meta_title:
meta_description:
meta_keywords:
@@ -9059,6 +9293,8 @@ paths:
data:
id: '96'
type: taxon_image
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -9067,6 +9303,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9075,6 +9313,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Taxon
tags:
@@ -9114,8 +9354,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T16:23:41.822Z'
- updated_at: '2021-10-29T16:23:41.845Z'
+ created_at: '2021-10-29T22:37:44.740Z'
+ updated_at: '2021-10-29T22:37:44.763Z'
meta_title:
meta_description:
meta_keywords:
@@ -9140,6 +9380,8 @@ paths:
data:
id: '98'
type: taxon_image
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -9151,6 +9393,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -9159,6 +9403,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9167,6 +9413,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -9197,6 +9445,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9205,6 +9455,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/users":
get:
summary: Return a list of Users
@@ -9256,9 +9508,9 @@ paths:
- id: '97'
type: user
attributes:
- created_at: '2021-10-29T16:23:42.270Z'
- updated_at: '2021-10-29T16:23:42.270Z'
+ created_at: '2021-10-29T22:37:45.197Z'
+ updated_at: '2021-10-29T22:37:45.197Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9270,9 +9522,9 @@ paths:
- id: '98'
type: user
attributes:
- created_at: '2021-10-29T16:23:42.274Z'
- updated_at: '2021-10-29T16:23:42.274Z'
+ created_at: '2021-10-29T22:37:45.203Z'
+ updated_at: '2021-10-29T22:37:45.203Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9284,9 +9536,9 @@ paths:
- id: '99'
type: user
attributes:
- created_at: '2021-10-29T16:23:42.276Z'
- updated_at: '2021-10-29T16:23:42.276Z'
+ created_at: '2021-10-29T22:37:45.204Z'
+ updated_at: '2021-10-29T22:37:45.204Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9305,6 +9557,8 @@ paths:
prev: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -9313,6 +9567,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create an User
tags:
@@ -9341,9 +9597,9 @@ paths:
id: '104'
type: user
attributes:
- created_at: '2021-10-29T16:23:42.336Z'
- updated_at: '2021-10-29T16:23:42.336Z'
+ created_at: '2021-10-29T22:37:45.267Z'
+ updated_at: '2021-10-29T22:37:45.267Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9352,6 +9608,8 @@ paths:
data:
ship_address:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -9363,6 +9621,8 @@ paths:
errors:
bill_address_id:
- belongs to other user
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -9402,9 +9662,9 @@ paths:
id: '107'
type: user
attributes:
- created_at: '2021-10-29T16:23:42.378Z'
- updated_at: '2021-10-29T16:23:42.378Z'
+ created_at: '2021-10-29T22:37:45.310Z'
+ updated_at: '2021-10-29T22:37:45.310Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9413,6 +9673,8 @@ paths:
data:
ship_address:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -9421,6 +9683,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9429,6 +9693,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update an User
tags:
@@ -9463,8 +9729,8 @@ paths:
type: user
attributes:
- created_at: '2021-10-29T16:23:42.448Z'
- updated_at: '2021-10-29T16:23:42.456Z'
+ created_at: '2021-10-29T22:37:45.375Z'
+ updated_at: '2021-10-29T22:37:45.389Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9473,6 +9739,8 @@ paths:
data:
ship_address:
data:
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -9484,6 +9752,8 @@ paths:
errors:
bill_address_id:
- belongs to other user
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -9492,6 +9762,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9500,6 +9772,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -9530,6 +9804,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9538,6 +9814,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/variants":
get:
summary: Return a list of Variants
@@ -9599,12 +9877,12 @@ paths:
position: 1
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T16:23:42.653Z'
+ updated_at: '2021-10-29T22:37:45.588Z'
discontinue_on:
- created_at: '2021-10-29T16:23:42.649Z'
+ created_at: '2021-10-29T22:37:45.582Z'
display_price: "$19.99"
display_compare_at_price:
- name: 'Product #184 - 8966'
+ name: 'Product #184 - 9798'
options_text: ''
total_on_hand: 0
purchasable: true
@@ -9639,21 +9917,21 @@ paths:
type: variant
attributes:
sku: SKU-252
- weight: '85.66'
- height: '102.1'
- depth: '8.7'
+ weight: '111.5'
+ height: '117.61'
+ depth: '190.8'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T16:23:42.679Z'
+ updated_at: '2021-10-29T22:37:45.617Z'
discontinue_on:
- created_at: '2021-10-29T16:23:42.673Z'
+ created_at: '2021-10-29T22:37:45.611Z'
display_price: "$19.99"
display_compare_at_price:
- name: 'Product #184 - 8966'
+ name: 'Product #184 - 9798'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -9690,21 +9968,21 @@ paths:
type: variant
attributes:
sku: SKU-253
- weight: '93.7'
- height: '135.37'
- depth: '108.22'
+ weight: '171.19'
+ height: '177.83'
+ depth: '193.5'
deleted_at:
is_master: false
cost_price: '17.0'
position: 3
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T16:23:42.697Z'
+ updated_at: '2021-10-29T22:37:45.635Z'
discontinue_on:
- created_at: '2021-10-29T16:23:42.691Z'
+ created_at: '2021-10-29T22:37:45.629Z'
display_price: "$19.99"
display_compare_at_price:
- name: 'Product #184 - 8966'
+ name: 'Product #184 - 9798'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -9747,6 +10025,8 @@ paths:
prev: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/variants?filter%5Bproduct_id_eq%5D=&filter%5Bsku_i_cont%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -9755,6 +10035,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/variants/{id}":
get:
summary: Return a Variant
@@ -9790,21 +10072,21 @@ paths:
type: variant
attributes:
sku: SKU-258
- weight: '125.2'
- height: '174.3'
- depth: '5.24'
+ weight: '89.82'
+ height: '107.94'
+ depth: '110.2'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T16:23:42.900Z'
+ updated_at: '2021-10-29T22:37:45.867Z'
discontinue_on:
- created_at: '2021-10-29T16:23:42.894Z'
+ created_at: '2021-10-29T22:37:45.858Z'
display_price: "$19.99"
display_compare_at_price:
- name: 'Product #186 - 8118'
+ name: 'Product #186 - 9751'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -9837,6 +10119,8 @@ paths:
data:
- id: '178'
type: stock_location
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -9845,6 +10129,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9853,6 +10139,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
delete:
summary: Delete a Variant
tags:
@@ -9878,6 +10166,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -9886,6 +10176,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/webhooks/events":
get:
summary: Return a list of Webhook Events
@@ -9955,14 +10247,14 @@ paths:
- id: '1'
type: event
attributes:
- execution_time: 96711
+ execution_time: 37677
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url1.com/
- created_at: '2021-10-29T16:23:43.229Z'
- updated_at: '2021-10-29T16:23:43.229Z'
+ created_at: '2021-10-29T22:37:46.200Z'
+ updated_at: '2021-10-29T22:37:46.200Z'
relationships:
subscriber:
data:
@@ -9971,14 +10263,14 @@ paths:
- id: '2'
type: event
attributes:
- execution_time: 94804
+ execution_time: 75802
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url2.com/
- created_at: '2021-10-29T16:23:43.234Z'
- updated_at: '2021-10-29T16:23:43.234Z'
+ created_at: '2021-10-29T22:37:46.205Z'
+ updated_at: '2021-10-29T22:37:46.205Z'
relationships:
subscriber:
data:
@@ -9994,6 +10286,8 @@ paths:
prev: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -10002,6 +10296,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/webhooks/subscribers":
get:
summary: Return a list of Webhook Subscribers
@@ -10050,8 +10346,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T16:23:43.277Z'
- updated_at: '2021-10-29T16:23:43.277Z'
+ created_at: '2021-10-29T22:37:46.248Z'
+ updated_at: '2021-10-29T22:37:46.248Z'
- id: '6'
type: subscriber
attributes:
@@ -10059,8 +10355,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T16:23:43.278Z'
- updated_at: '2021-10-29T16:23:43.278Z'
+ created_at: '2021-10-29T22:37:46.249Z'
+ updated_at: '2021-10-29T22:37:46.249Z'
meta:
count: 2
total_count: 2
@@ -10071,6 +10367,8 @@ paths:
prev: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
last: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
first: http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -10079,6 +10377,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Webhook Subscriber
tags:
@@ -10104,8 +10404,10 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T16:23:43.327Z'
- updated_at: '2021-10-29T16:23:43.327Z'
+ created_at: '2021-10-29T22:37:46.298Z'
+ updated_at: '2021-10-29T22:37:46.298Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10120,6 +10422,8 @@ paths:
- must be a valid URL
- can't be blank
- the URL must have a path
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -10156,8 +10460,10 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T16:23:43.356Z'
- updated_at: '2021-10-29T16:23:43.356Z'
+ created_at: '2021-10-29T22:37:46.328Z'
+ updated_at: '2021-10-29T22:37:46.328Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -10166,6 +10472,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10174,6 +10482,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Webhook Subscriber
tags:
@@ -10204,8 +10514,10 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T16:23:43.403Z'
- updated_at: '2021-10-29T16:23:43.403Z'
+ created_at: '2021-10-29T22:37:46.376Z'
+ updated_at: '2021-10-29T22:37:46.376Z'
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10220,6 +10532,8 @@ paths:
- must be a valid URL
- can't be blank
- the URL must have a path
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -10228,6 +10542,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10236,6 +10552,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -10266,6 +10584,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10274,6 +10594,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/wished_items":
get:
summary: Return a list of Wished Items
@@ -10314,8 +10636,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:43.647Z'
- updated_at: '2021-10-29T16:23:43.647Z'
+ created_at: '2021-10-29T22:37:46.614Z'
+ updated_at: '2021-10-29T22:37:46.614Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10329,8 +10651,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:43.700Z'
- updated_at: '2021-10-29T16:23:43.700Z'
+ created_at: '2021-10-29T22:37:46.661Z'
+ updated_at: '2021-10-29T22:37:46.661Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10344,8 +10666,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:43.750Z'
- updated_at: '2021-10-29T16:23:43.750Z'
+ created_at: '2021-10-29T22:37:46.707Z'
+ updated_at: '2021-10-29T22:37:46.707Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10359,8 +10681,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:43.800Z'
- updated_at: '2021-10-29T16:23:43.800Z'
+ created_at: '2021-10-29T22:37:46.753Z'
+ updated_at: '2021-10-29T22:37:46.753Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10380,6 +10702,8 @@ paths:
prev: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -10388,6 +10712,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Wished Item
tags:
@@ -10417,8 +10743,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:44.183Z'
- updated_at: '2021-10-29T16:23:44.183Z'
+ created_at: '2021-10-29T22:37:47.137Z'
+ updated_at: '2021-10-29T22:37:47.137Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10428,6 +10754,8 @@ paths:
data:
id: '286'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10444,6 +10772,8 @@ paths:
- can't be blank
quantity:
- is not a number
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -10484,8 +10814,8 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T16:23:44.393Z'
- updated_at: '2021-10-29T16:23:44.393Z'
+ created_at: '2021-10-29T22:37:47.342Z'
+ updated_at: '2021-10-29T22:37:47.342Z'
display_price: "$19.99"
display_total: "$19.99"
price: '19.99'
@@ -10495,6 +10825,8 @@ paths:
data:
id: '292'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -10503,6 +10835,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10511,6 +10845,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Wished Item
tags:
@@ -10545,8 +10881,8 @@ paths:
type: wished_item
attributes:
quantity: 3
- created_at: '2021-10-29T16:23:44.754Z'
- updated_at: '2021-10-29T16:23:44.763Z'
+ created_at: '2021-10-29T22:37:47.685Z'
+ updated_at: '2021-10-29T22:37:47.693Z'
display_price: "$19.99"
display_total: "$59.97"
price: '19.99'
@@ -10556,6 +10892,8 @@ paths:
data:
id: '302'
type: variant
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10567,6 +10905,8 @@ paths:
errors:
quantity:
- is not a number
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -10575,6 +10915,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10583,6 +10925,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -10613,6 +10957,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10621,6 +10967,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/wishlists":
get:
summary: Return a list of Wishlists
@@ -10669,9 +11017,9 @@ paths:
name: Black Friday
is_private: true
is_default: false
- created_at: '2021-10-29T16:23:45.495Z'
- updated_at: '2021-10-29T16:23:45.495Z'
- token: 1JTMKWWjFhUPa6CaGzzQQrQF
+ created_at: '2021-10-29T22:37:48.406Z'
+ updated_at: '2021-10-29T22:37:48.406Z'
+ token: hzz2XeUekvfx5rYUL1vDnCvo
variant_included: false
relationships:
wished_items:
@@ -10686,9 +11034,9 @@ paths:
name: Birthday
is_private: true
is_default: false
- created_at: '2021-10-29T16:23:45.496Z'
- updated_at: '2021-10-29T16:23:45.496Z'
- token: Cu5heDXJYTxRgADQKTUdfXY9
+ created_at: '2021-10-29T22:37:48.408Z'
+ updated_at: '2021-10-29T22:37:48.408Z'
+ token: caSdJP5i2tawwVYD19pY1Xuw
variant_included: false
relationships:
wished_items:
@@ -10707,6 +11055,8 @@ paths:
prev: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
last: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
first: http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
'401':
description: Authentication Failed
content:
@@ -10715,6 +11065,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
post:
summary: Create a Wishlist
tags:
@@ -10746,13 +11098,15 @@ paths:
name: Wishlist_26
is_private: true
is_default: false
- created_at: '2021-10-29T16:23:45.981Z'
- updated_at: '2021-10-29T16:23:45.981Z'
- token: iCRRHeTZ5fMcunEDLfosaTTv
+ created_at: '2021-10-29T22:37:48.872Z'
+ updated_at: '2021-10-29T22:37:48.872Z'
+ token: toYjZg66xS9vSXrKPHEXvTZE
variant_included: false
relationships:
wished_items:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10766,6 +11120,8 @@ paths:
- can't be blank
user:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
requestBody:
content:
application/json:
@@ -10808,13 +11164,15 @@ paths:
name: My Wishlist
is_private: true
is_default: false
- created_at: '2021-10-29T16:23:46.018Z'
- updated_at: '2021-10-29T16:23:46.018Z'
- token: mZZ8Dh2AgiapfXxJK9LYLkJb
+ created_at: '2021-10-29T22:37:48.908Z'
+ updated_at: '2021-10-29T22:37:48.908Z'
+ token: YKC9AoiAadpMHuAStGtvVSa7
variant_included: false
relationships:
wished_items:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'404':
description: Record not found
content:
@@ -10823,6 +11181,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10831,6 +11191,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
patch:
summary: Update a Wishlist
tags:
@@ -10867,13 +11229,15 @@ paths:
name: My Super Wishlist
is_private: true
is_default: false
- created_at: '2021-10-29T16:23:46.075Z'
- updated_at: '2021-10-29T16:23:46.084Z'
- token: CxfVenpuq3knonhs5WXLE4EB
+ created_at: '2021-10-29T22:37:48.965Z'
+ updated_at: '2021-10-29T22:37:48.973Z'
+ token: zx6yPtKxrXZ1ootQj2HGLYkj
variant_included: false
relationships:
wished_items:
data: []
+ schema:
+ "$ref": "#/components/schemas/resource"
'422':
description: invalid request
content:
@@ -10885,6 +11249,8 @@ paths:
errors:
name:
- can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
'404':
description: Record not found
content:
@@ -10893,6 +11259,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10901,6 +11269,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
@@ -10931,6 +11301,8 @@ paths:
Example:
value:
error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
'401':
description: Authentication Failed
content:
@@ -10939,6 +11311,8 @@ paths:
Example:
value:
error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
servers:
- url: https://{defaultHost}
variables:
@@ -11103,92 +11477,215 @@ components:
required:
- classification
x-internal: true
- line_item_params:
+ cms_page_params:
type: object
properties:
- line_item:
+ cms_page:
type: object
required:
- - order_id
- - variant_id
- - quantity
+ - title
+ - locale
properties:
- order_id:
+ title:
type: string
- example: '1'
- variant_id:
+ meta_title:
+ type: string
+ content:
+ type: string
+ meta_description:
+ type: string
+ visible:
+ type: string
+ slug:
+ type: string
+ locale:
type: string
- example: '1'
- quantity:
- type: integer
- example: 2
required:
- - line_item
+ - cms_page
x-internal: true
- option_type_params:
+ cms_section_params:
type: object
properties:
- option_type:
+ cms_section:
type: object
required:
- name
- - presentation
+ - cms_page_id
properties:
name:
type: string
- example: color
- presentation:
+ cms_page_id:
+ type: string
+ content:
+ type: object
+ settings:
+ type: object
+ fit:
+ type: string
+ destination:
type: string
- example: Color
required:
- - option_type
+ - cms_section
x-internal: true
- option_value_params:
+ cms_section_reposition_params:
type: object
properties:
- option_value:
+ new_position_idx:
+ type: integer
+ required:
+ - new_position_idx
+ x-internal: true
+ digital_params:
+ type: object
+ properties:
+ digital[attachment]:
+ type: string
+ format: binary
+ digital[variant_id]:
+ type: string
+ example: '123'
+ required:
+ - digital[attachment]
+ - digital[variant_id]
+ x-internal: true
+ digital_link_params:
+ type: object
+ properties:
+ digital_link:
type: object
required:
- - name
- - presentation
+ - line_item_id
+ - digital_id
properties:
- name:
+ access_counter:
+ type: integer
+ example: 0
+ line_item_id:
type: string
- example: red
- presentation:
+ example: '1'
+ digital_id:
type: string
- example: Red
+ example: '1'
required:
- - option_value
+ - digital_link
x-internal: true
- webhook_subscriber_params:
+ line_item_params:
type: object
properties:
- subscriber:
+ line_item:
type: object
required:
- - url
+ - order_id
+ - variant_id
+ - quantity
properties:
- active:
- type: boolean
- example: true
- default: false
- subscriptions:
- type: array
- items:
- allOf:
- - type: string
- example: order.completed
- example:
- - order.created
- - order.completed
- - product.updated
- default: []
- url:
+ order_id:
type: string
- example: https://www.url.com/
+ example: '1'
+ variant_id:
+ type: string
+ example: '1'
+ quantity:
+ type: integer
+ example: 2
required:
- - subscriber
+ - line_item
+ x-internal: true
+ menu_params:
+ type: object
+ properties:
+ menu:
+ type: object
+ required:
+ - name
+ - location
+ - locale
+ properties:
+ name:
+ type: string
+ location:
+ type: string
+ locale:
+ type: string
+ required:
+ - menu
+ x-internal: true
+ menu_item_params:
+ type: object
+ properties:
+ menu_item:
+ type: object
+ required:
+ - name
+ - menu_id
+ properties:
+ name:
+ type: string
+ code:
+ type: string
+ subtitle:
+ type: string
+ destination:
+ type: string
+ menu_id:
+ type: string
+ new_window:
+ type: boolean
+ item_type:
+ type: string
+ linked_resource_type:
+ type: string
+ linked_resource_id:
+ type: integer
+ required:
+ - menu_item
+ x-internal: true
+ menu_item_reposition_params:
+ type: object
+ properties:
+ new_parent_id:
+ type: integer
+ new_position_idx:
+ type: integer
+ required:
+ - new_parent_id
+ - new_position_idx
+ x-internal: true
+ option_type_params:
+ type: object
+ properties:
+ option_type:
+ type: object
+ required:
+ - name
+ - presentation
+ properties:
+ name:
+ type: string
+ example: color
+ presentation:
+ type: string
+ example: Color
+ required:
+ - option_type
+ x-internal: true
+ option_value_params:
+ type: object
+ properties:
+ option_value:
+ type: object
+ required:
+ - name
+ - presentation
+ properties:
+ name:
+ type: string
+ example: red
+ presentation:
+ type: string
+ example: Red
+ required:
+ - option_value
x-internal: true
order_params:
type: object
@@ -11222,7 +11719,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-10-29 16:23:12 UTC
+ example: 2021-10-29 22:37:15 UTC
bill_address_id:
type: string
example: '1'
@@ -11290,7 +11787,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-10-29 16:23:12 UTC
+ example: 2021-10-29 22:37:15 UTC
confirmation_delivered:
type: boolean
example: true
@@ -11401,107 +11898,6 @@ components:
required:
- promotion_category
x-internal: true
- user_params:
- type: object
- properties:
- user:
- type: object
- required:
- - email
- - password
- - password_confirmation
- properties:
- email:
- type: string
- password:
- type: string
- password_confirmation:
- type: string
- ship_address_id:
- type: string
- bill_address_id:
- type: string
- required:
- - user
- x-internal: true
- taxon_params:
- type: object
- properties:
- taxon:
- type: object
- required:
- - name
- - taxonomy_id
- properties:
- taxonomy_id:
- type: string
- parent_id:
- type: string
- name:
- type: string
- required:
- - taxon
- x-internal: true
- menu_params:
- type: object
- properties:
- menu:
- type: object
- required:
- - name
- - location
- - locale
- properties:
- name:
- type: string
- location:
- type: string
- locale:
- type: string
- required:
- - menu
- x-internal: true
- menu_item_params:
- type: object
- properties:
- menu_item:
- type: object
- required:
- - name
- - menu_id
- properties:
- name:
- type: string
- code:
- type: string
- subtitle:
- type: string
- destination:
- type: string
- menu_id:
- type: string
- new_window:
- type: boolean
- item_type:
- type: string
- linked_resource_type:
- type: string
- linked_resource_id:
- type: integer
- required:
- - menu_item
- x-internal: true
- menu_item_reposition_params:
- type: object
- properties:
- new_parent_id:
- type: integer
- new_position_idx:
- type: integer
- required:
- - new_parent_id
- - new_position_idx
- x-internal: true
shipping_category_params:
type: object
properties:
@@ -11575,137 +11971,115 @@ components:
required:
- type
x-internal: true
- wishlist_params:
+ taxon_params:
type: object
properties:
- wishlist:
+ taxon:
type: object
required:
- name
- - user_id
+ - taxonomy_id
properties:
- name:
+ taxonomy_id:
type: string
- user_id:
+ parent_id:
+ type: string
+ name:
type: string
- is_default:
- type: boolean
- is_private:
- type: boolean
required:
- - wishlist
+ - taxon
x-internal: true
- wished_item_params:
+ user_params:
type: object
properties:
- wished_item:
+ user:
type: object
required:
- - wishlist_id
- - variant_id
- - quantity
+ - email
+ - password
+ - password_confirmation
properties:
- wishlist_id:
+ email:
type: string
- variant_id:
+ password:
+ type: string
+ password_confirmation:
+ type: string
+ ship_address_id:
+ type: string
+ bill_address_id:
type: string
- quantity:
- type: integer
- description: Must be an integer greater than 0
required:
- - wished_item
+ - user
x-internal: true
- cms_page_params:
+ webhook_subscriber_params:
type: object
properties:
- cms_page:
+ subscriber:
type: object
required:
- - title
- - locale
+ - url
properties:
- title:
- type: string
- meta_title:
- type: string
- content:
- type: string
- meta_description:
- type: string
- visible:
- type: string
- slug:
- type: string
- locale:
+ active:
+ type: boolean
+ example: true
+ default: false
+ subscriptions:
+ type: array
+ items:
+ allOf:
+ - type: string
+ example: order.completed
+ example:
+ - order.created
+ - order.completed
+ - product.updated
+ default: []
+ url:
type: string
+ example: https://www.url.com/
required:
- - cms_page
+ - subscriber
x-internal: true
- cms_section_params:
+ wishlist_params:
type: object
properties:
- cms_section:
+ wishlist:
type: object
required:
- name
- - cms_page_id
+ - user_id
properties:
name:
type: string
- cms_page_id:
- type: string
- content:
- type: object
- settings:
- type: object
- fit:
- type: string
- destination:
+ user_id:
type: string
+ is_default:
+ type: boolean
+ is_private:
+ type: boolean
required:
- - cms_section
- x-internal: true
- cms_section_reposition_params:
- type: object
- properties:
- new_position_idx:
- type: integer
- required:
- - new_position_idx
- x-internal: true
- digital_params:
- type: object
- properties:
- digital[attachment]:
- type: string
- format: binary
- digital[variant_id]:
- type: string
- example: '123'
- required:
- - digital[attachment]
- - digital[variant_id]
+ - wishlist
x-internal: true
- digital_link_params:
+ wished_item_params:
type: object
properties:
- digital_link:
+ wished_item:
type: object
required:
- - line_item_id
- - digital_id
+ - wishlist_id
+ - variant_id
+ - quantity
properties:
- access_counter:
- type: integer
- example: 0
- line_item_id:
+ wishlist_id:
type: string
- example: '1'
- digital_id:
+ variant_id:
type: string
- example: '1'
+ quantity:
+ type: integer
+ description: Must be an integer greater than 0
required:
- - digital_link
+ - wished_item
x-internal: true
amount_param:
type: object
diff --git a/api/spec/integration/api/v2/platform/orders_spec.rb b/api/spec/integration/api/v2/platform/orders_spec.rb
index a05985d011..c009959950 100644
--- a/api/spec/integration/api/v2/platform/orders_spec.rb
+++ b/api/spec/integration/api/v2/platform/orders_spec.rb
@@ -91,9 +91,7 @@ describe 'Orders API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -109,9 +107,7 @@ describe 'Orders API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -131,9 +127,7 @@ describe 'Orders API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -149,9 +143,7 @@ describe 'Orders API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -167,9 +159,7 @@ describe 'Orders API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record approved' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
diff --git a/api/spec/integration/api/v2/platform/shipments_spec.rb b/api/spec/integration/api/v2/platform/shipments_spec.rb
index be86463d1f..a091ceef37 100644
--- a/api/spec/integration/api/v2/platform/shipments_spec.rb
+++ b/api/spec/integration/api/v2/platform/shipments_spec.rb
@@ -48,9 +48,7 @@ describe 'Shipments API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -68,9 +66,7 @@ describe 'Shipments API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -86,9 +82,7 @@ describe 'Shipments API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -106,9 +100,7 @@ describe 'Shipments API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end
@@ -126,9 +118,7 @@ describe 'Shipments API', swagger: true do
parameter name: :id, in: :path, type: :string
json_api_include_parameter(options[:include_example])
- response '200', 'record updated' do
- run_test!
- end
+ it_behaves_like 'record updated'
it_behaves_like 'record not found'
it_behaves_like 'authentication failed'
end