Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add separate create and update params

Matthew Kennedy3e06ff450c17
diff --git a/api/docs/v2/platform/index.yaml b/api/docs/v2/platform/index.yaml
index dc11103ba4..943228364c 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-29T22:37:16.250Z'
- updated_at: '2021-10-29T22:37:16.250Z'
+ created_at: '2021-10-29T23:23:30.290Z'
+ updated_at: '2021-10-29T23:23:30.290Z'
deleted_at:
label:
relationships:
@@ -98,8 +98,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T22:37:16.254Z'
- updated_at: '2021-10-29T22:37:16.254Z'
+ created_at: '2021-10-29T23:23:30.293Z'
+ updated_at: '2021-10-29T23:23:30.293Z'
deleted_at:
label:
relationships:
@@ -173,8 +173,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T22:37:16.455Z'
- updated_at: '2021-10-29T22:37:16.455Z'
+ created_at: '2021-10-29T23:23:30.506Z'
+ updated_at: '2021-10-29T23:23:30.506Z'
deleted_at:
label:
relationships:
@@ -223,7 +223,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/create_address_params"
"/api/v2/platform/addresses/{id}":
get:
summary: Return an Address
@@ -268,8 +268,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T22:37:16.485Z'
- updated_at: '2021-10-29T22:37:16.485Z'
+ created_at: '2021-10-29T23:23:30.540Z'
+ updated_at: '2021-10-29T23:23:30.540Z'
deleted_at:
label:
relationships:
@@ -348,8 +348,8 @@ paths:
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-10-29T22:37:16.532Z'
- updated_at: '2021-10-29T22:37:16.539Z'
+ created_at: '2021-10-29T23:23:30.600Z'
+ updated_at: '2021-10-29T23:23:30.609Z'
deleted_at:
label:
relationships:
@@ -404,7 +404,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/update_address_params"
delete:
summary: Delete an Address
tags:
@@ -493,8 +493,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T22:37:16.747Z'
- updated_at: '2021-10-29T22:37:16.747Z'
+ created_at: '2021-10-29T23:23:30.831Z'
+ updated_at: '2021-10-29T23:23:30.831Z'
state: open
included: false
display_amount: "$100.00"
@@ -520,8 +520,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T22:37:16.764Z'
- updated_at: '2021-10-29T22:37:16.764Z'
+ created_at: '2021-10-29T23:23:30.852Z'
+ updated_at: '2021-10-29T23:23:30.852Z'
state: open
included: false
display_amount: "$100.00"
@@ -594,8 +594,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T22:37:17.031Z'
- updated_at: '2021-10-29T22:37:17.031Z'
+ created_at: '2021-10-29T23:23:31.146Z'
+ updated_at: '2021-10-29T23:23:31.146Z'
state: open
included: false
display_amount: "$100.00"
@@ -636,7 +636,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/adjustment_params"
+ "$ref": "#/components/schemas/create_adjustment_params"
"/api/v2/platform/adjustments/{id}":
get:
summary: Return an Adjustment
@@ -677,8 +677,8 @@ paths:
label: Shipping
mandatory:
eligible: true
- created_at: '2021-10-29T22:37:17.127Z'
- updated_at: '2021-10-29T22:37:17.131Z'
+ created_at: '2021-10-29T23:23:31.248Z'
+ updated_at: '2021-10-29T23:23:31.252Z'
state: open
included: false
display_amount: "$1.00"
@@ -756,8 +756,8 @@ paths:
label: New label
mandatory:
eligible: true
- created_at: '2021-10-29T22:37:17.308Z'
- updated_at: '2021-10-29T22:37:17.322Z'
+ created_at: '2021-10-29T23:23:31.453Z'
+ updated_at: '2021-10-29T23:23:31.466Z'
state: open
included: false
display_amount: "$15.00"
@@ -813,7 +813,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/adjustment_params"
+ "$ref": "#/components/schemas/update_adjustment_params"
delete:
summary: Delete an Adjustment
tags:
@@ -897,8 +897,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T22:37:17.822Z'
- updated_at: '2021-10-29T22:37:17.822Z'
+ created_at: '2021-10-29T23:23:32.020Z'
+ updated_at: '2021-10-29T23:23:32.020Z'
relationships:
product:
data:
@@ -912,8 +912,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T22:37:17.889Z'
- updated_at: '2021-10-29T22:37:17.889Z'
+ created_at: '2021-10-29T23:23:32.096Z'
+ updated_at: '2021-10-29T23:23:32.096Z'
relationships:
product:
data:
@@ -974,8 +974,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T22:37:18.396Z'
- updated_at: '2021-10-29T22:37:18.396Z'
+ created_at: '2021-10-29T23:23:32.645Z'
+ updated_at: '2021-10-29T23:23:32.645Z'
relationships:
product:
data:
@@ -1006,7 +1006,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/classification_params"
+ "$ref": "#/components/schemas/create_classification_params"
"/api/v2/platform/classifications/{id}":
get:
summary: Return a Classification
@@ -1042,8 +1042,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T22:37:18.525Z'
- updated_at: '2021-10-29T22:37:18.525Z'
+ created_at: '2021-10-29T23:23:32.797Z'
+ updated_at: '2021-10-29T23:23:32.797Z'
relationships:
product:
data:
@@ -1109,8 +1109,8 @@ paths:
type: classification
attributes:
position: 1
- created_at: '2021-10-29T22:37:18.809Z'
- updated_at: '2021-10-29T22:37:18.809Z'
+ created_at: '2021-10-29T23:23:33.086Z'
+ updated_at: '2021-10-29T23:23:33.086Z'
relationships:
product:
data:
@@ -1159,7 +1159,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/classification_params"
+ "$ref": "#/components/schemas/update_classification_params"
delete:
summary: Delete a Classification
tags:
@@ -1232,8 +1232,8 @@ paths:
type: classification
attributes:
position: 2
- created_at: '2021-10-29T22:37:19.506Z'
- updated_at: '2021-10-29T22:37:19.526Z'
+ created_at: '2021-10-29T23:23:33.797Z'
+ updated_at: '2021-10-29T23:23:33.816Z'
relationships:
product:
data:
@@ -1280,7 +1280,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/classification_params"
+ "$ref": "#/components/schemas/update_classification_params"
"/api/v2/platform/cms_pages":
get:
summary: Return a list of CMS Pages
@@ -1332,34 +1332,34 @@ paths:
- id: '1'
type: cms_page
attributes:
- title: Eaque culpa occaecati temporibus cumque harum.
+ title: Dignissimos voluptatum illo quis illum cum quod sint.
meta_title:
content:
meta_description:
visible: true
- slug: eaque-culpa-occaecati-temporibus-cumque-harum
+ slug: dignissimos-voluptatum-illo-quis-illum-cum-quod-sint
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T22:37:19.848Z'
- updated_at: '2021-10-29T22:37:19.848Z'
+ created_at: '2021-10-29T23:23:34.140Z'
+ updated_at: '2021-10-29T23:23:34.140Z'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
- title: Vel dolore dicta temporibus consectetur nisi eius labore.
+ title: Aspernatur velit fuga enim quis autem veniam.
meta_title:
content:
meta_description:
visible: true
- slug: vel-dolore-dicta-temporibus-consectetur-nisi-eius-labore
+ slug: aspernatur-velit-fuga-enim-quis-autem-veniam
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T22:37:19.852Z'
- updated_at: '2021-10-29T22:37:19.852Z'
+ created_at: '2021-10-29T23:23:34.143Z'
+ updated_at: '2021-10-29T23:23:34.143Z'
relationships:
cms_sections:
data: []
@@ -1413,17 +1413,17 @@ paths:
id: '5'
type: cms_page
attributes:
- title: Eaque tempore incidunt at et dicta tenetur quasi.
+ title: Quam optio numquam deserunt beatae repellat.
meta_title:
content:
meta_description:
visible: true
- slug: eaque-tempore-incidunt-at-et-dicta-tenetur-quasi
+ slug: quam-optio-numquam-deserunt-beatae-repellat
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T22:37:19.920Z'
- updated_at: '2021-10-29T22:37:19.920Z'
+ created_at: '2021-10-29T23:23:34.223Z'
+ updated_at: '2021-10-29T23:23:34.223Z'
relationships:
cms_sections:
data: []
@@ -1448,7 +1448,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/cms_page_params"
+ "$ref": "#/components/schemas/create_cms_page_params"
"/api/v2/platform/cms_pages/{id}":
get:
summary: Return a CMS Page
@@ -1483,17 +1483,17 @@ paths:
id: '6'
type: cms_page
attributes:
- title: Ratione quas ea in soluta.
+ title: Recusandae corrupti asperiores nisi tempore cupiditate.
meta_title:
content:
meta_description:
visible: true
- slug: ratione-quas-ea-in-soluta
+ slug: recusandae-corrupti-asperiores-nisi-tempore-cupiditate
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T22:37:19.952Z'
- updated_at: '2021-10-29T22:37:19.952Z'
+ created_at: '2021-10-29T23:23:34.261Z'
+ updated_at: '2021-10-29T23:23:34.261Z'
relationships:
cms_sections:
data: []
@@ -1557,12 +1557,12 @@ paths:
content:
meta_description:
visible: true
- slug: incidunt-beatae-quod-perspiciatis-adipisci-necessitatibus
+ slug: cupiditate-deleniti-ipsum-debitis-error-molestiae-alias-facere-veritatis
type: Spree::Cms::Pages::StandardPage
locale: en
deleted_at:
- created_at: '2021-10-29T22:37:20.011Z'
- updated_at: '2021-10-29T22:37:20.020Z'
+ created_at: '2021-10-29T23:23:34.393Z'
+ updated_at: '2021-10-29T23:23:34.403Z'
relationships:
cms_sections:
data: []
@@ -1605,7 +1605,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/cms_page_params"
+ "$ref": "#/components/schemas/update_cms_page_params"
delete:
summary: Delete a CMS Page
tags:
@@ -1688,7 +1688,7 @@ paths:
- id: '1'
type: cms_section
attributes:
- name: Sapiente in esse nostrum tenetur.
+ name: Labore aperiam ipsam minus provident odit.
content: {}
settings:
gutters: No Gutters
@@ -1697,8 +1697,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 1
linked_resource_type: Spree::Taxon
- created_at: '2021-10-29T22:37:20.251Z'
- updated_at: '2021-10-29T22:37:20.251Z'
+ created_at: '2021-10-29T23:23:34.573Z'
+ updated_at: '2021-10-29T23:23:34.573Z'
relationships:
cms_page:
data:
@@ -1709,8 +1709,8 @@ paths:
- id: '2'
type: cms_section
attributes:
- name: Fuga necessitatibus veritatis qui ea sapiente ipsam
- deleniti earum.
+ name: Voluptate dignissimos voluptas fugiat velit quae temporibus
+ quibusdam eos.
content:
link_type_one: Spree::Taxon
link_type_two: Spree::Taxon
@@ -1722,8 +1722,8 @@ paths:
type: Spree::Cms::Sections::ImageGallery
position: 2
linked_resource_type:
- created_at: '2021-10-29T22:37:20.254Z'
- updated_at: '2021-10-29T22:37:20.254Z'
+ created_at: '2021-10-29T23:23:34.577Z'
+ updated_at: '2021-10-29T23:23:34.577Z'
relationships:
cms_page:
data:
@@ -1734,7 +1734,7 @@ paths:
- id: '3'
type: cms_section
attributes:
- name: Est recusandae aperiam suscipit beatae.
+ name: Ducimus rem illum nisi autem harum totam recusandae.
content: {}
settings:
gutters: No Gutters
@@ -1743,8 +1743,8 @@ paths:
type: Spree::Cms::Sections::FeaturedArticle
position: 3
linked_resource_type: Spree::Taxon
- created_at: '2021-10-29T22:37:20.262Z'
- updated_at: '2021-10-29T22:37:20.262Z'
+ created_at: '2021-10-29T23:23:34.584Z'
+ updated_at: '2021-10-29T23:23:34.584Z'
relationships:
cms_page:
data:
@@ -1755,8 +1755,7 @@ paths:
- id: '4'
type: cms_section
attributes:
- name: Non cumque quisquam eligendi ipsam laudantium fugit
- illo eveniet.
+ name: Laborum doloremque quas nihil assumenda.
content: {}
settings:
gutters: No Gutters
@@ -1765,8 +1764,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:20.269Z'
- updated_at: '2021-10-29T22:37:20.269Z'
+ created_at: '2021-10-29T23:23:34.591Z'
+ updated_at: '2021-10-29T23:23:34.591Z'
relationships:
cms_page:
data:
@@ -1779,8 +1778,8 @@ paths:
- id: '5'
type: cms_section
attributes:
- name: Numquam quidem iste iure in architecto dolorum minus
- nesciunt.
+ name: Aspernatur possimus unde aliquam maiores sed iure quam
+ porro.
content: {}
settings:
gutters: No Gutters
@@ -1789,8 +1788,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 5
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:20.276Z'
- updated_at: '2021-10-29T22:37:20.276Z'
+ created_at: '2021-10-29T23:23:34.598Z'
+ updated_at: '2021-10-29T23:23:34.598Z'
relationships:
cms_page:
data:
@@ -1850,7 +1849,7 @@ paths:
id: '14'
type: cms_section
attributes:
- name: Eaque deleniti sunt libero et in hic fugit dolor.
+ name: Hic magnam ea totam natus.
content: {}
settings:
gutters: No Gutters
@@ -1859,8 +1858,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:20.433Z'
- updated_at: '2021-10-29T22:37:20.433Z'
+ created_at: '2021-10-29T23:23:34.758Z'
+ updated_at: '2021-10-29T23:23:34.758Z'
relationships:
cms_page:
data:
@@ -1891,7 +1890,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/cms_section_params"
+ "$ref": "#/components/schemas/create_cms_section_params"
"/api/v2/platform/cms_sections/{id}":
get:
summary: Return a CMS Section
@@ -1926,7 +1925,8 @@ paths:
id: '21'
type: cms_section
attributes:
- name: Iusto cum pariatur aut omnis sit.
+ name: Deserunt inventore maiores voluptatem quam hic dignissimos
+ optio harum.
content: {}
settings:
gutters: No Gutters
@@ -1935,8 +1935,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:20.562Z'
- updated_at: '2021-10-29T22:37:20.562Z'
+ created_at: '2021-10-29T23:23:34.892Z'
+ updated_at: '2021-10-29T23:23:34.892Z'
relationships:
cms_page:
data:
@@ -2010,8 +2010,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 4
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:20.763Z'
- updated_at: '2021-10-29T22:37:20.774Z'
+ created_at: '2021-10-29T23:23:35.164Z'
+ updated_at: '2021-10-29T23:23:35.175Z'
relationships:
cms_page:
data:
@@ -2060,7 +2060,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/cms_section_params"
+ "$ref": "#/components/schemas/update_cms_section_params"
delete:
summary: Delete a CMS Section
tags:
@@ -2125,7 +2125,8 @@ paths:
id: '58'
type: cms_section
attributes:
- name: Impedit non consequatur ut cumque unde minus placeat.
+ name: Laboriosam magni animi maxime atque dolores amet blanditiis
+ accusantium.
content: {}
settings:
gutters: No Gutters
@@ -2134,8 +2135,8 @@ paths:
type: Spree::Cms::Sections::HeroImage
position: 3
linked_resource_type: Spree::Product
- created_at: '2021-10-29T22:37:21.332Z'
- updated_at: '2021-10-29T22:37:21.343Z'
+ created_at: '2021-10-29T23:23:35.661Z'
+ updated_at: '2021-10-29T23:23:35.672Z'
relationships:
cms_page:
data:
@@ -2199,9 +2200,9 @@ paths:
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-10-29T22:37:21.485Z'
+ updated_at: '2021-10-29T23:23:35.810Z'
zipcode_required: true
- created_at: '2021-10-29T22:37:21.485Z'
+ created_at: '2021-10-29T23:23:35.810Z'
relationships:
states:
data: []
@@ -2214,9 +2215,9 @@ paths:
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-10-29T22:37:21.490Z'
+ updated_at: '2021-10-29T23:23:35.816Z'
zipcode_required: true
- created_at: '2021-10-29T22:37:21.490Z'
+ created_at: '2021-10-29T23:23:35.816Z'
relationships:
states:
data: []
@@ -2229,9 +2230,9 @@ paths:
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-10-29T22:37:21.496Z'
+ updated_at: '2021-10-29T23:23:35.818Z'
zipcode_required: true
- created_at: '2021-10-29T22:37:21.496Z'
+ created_at: '2021-10-29T23:23:35.818Z'
relationships:
states:
data: []
@@ -2290,9 +2291,9 @@ paths:
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-10-29T22:37:21.540Z'
+ updated_at: '2021-10-29T23:23:35.860Z'
zipcode_required: true
- created_at: '2021-10-29T22:37:21.540Z'
+ created_at: '2021-10-29T23:23:35.860Z'
relationships:
states:
data: []
@@ -2350,7 +2351,7 @@ paths:
- id: '1'
type: digital_link
attributes:
- token: 7rfNAgnWtCwXkQRDxa177eWN
+ token: cjEa1aNAvNPLAMQ9hX7fjckc
access_counter: 0
relationships:
digital:
@@ -2364,7 +2365,7 @@ paths:
- id: '2'
type: digital_link
attributes:
- token: f4RAdiKEQwZDjM32W5TV5Gbh
+ token: W5KazZug9DZxQvvNszLm8DRi
access_counter: 0
relationships:
digital:
@@ -2418,7 +2419,7 @@ paths:
id: '5'
type: digital_link
attributes:
- token: wfYP5fr2TFoSAiKaxV4ahBMM
+ token: Pe63Nw9NuAMdNxDJzRSXYMc1
access_counter: 0
relationships:
digital:
@@ -2453,7 +2454,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/digital_link_params"
+ "$ref": "#/components/schemas/create_digital_link_params"
"/api/v2/platform/digital_links/{id}":
get:
summary: Return a Digital Link
@@ -2481,7 +2482,7 @@ paths:
id: '6'
type: digital_link
attributes:
- token: xtWzdmfYGhYCnsJDmLjcUpAR
+ token: Hbnv64nvUCAvnjFgMjscS2ri
access_counter: 0
relationships:
digital:
@@ -2540,7 +2541,7 @@ paths:
id: '8'
type: digital_link
attributes:
- token: quyJoYRNXDASXS3R7ki7G4EM
+ token: PdXCSKb52mCYpmcRVkiRaY3v
access_counter: 0
relationships:
digital:
@@ -2590,7 +2591,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/digital_link_params"
+ "$ref": "#/components/schemas/update_digital_link_params"
delete:
summary: Delete a Digital Link
tags:
@@ -2655,7 +2656,7 @@ paths:
id: '13'
type: digital_link
attributes:
- token: UFEvUZxWWzZRwQdA4AiqLCAA
+ token: ATVA9DWnqkZgnSZYtftxinTn
access_counter: 0
relationships:
digital:
@@ -2840,7 +2841,7 @@ paths:
content:
multipart/form-data:
schema:
- "$ref": "#/components/schemas/digital_params"
+ "$ref": "#/components/schemas/create_digital_params"
"/api/v2/platform/digitals/{id}":
get:
summary: Return a Digital Asset
@@ -2987,7 +2988,7 @@ paths:
content:
multipart/form-data:
schema:
- "$ref": "#/components/schemas/digital_params"
+ "$ref": "#/components/schemas/update_digital_params"
delete:
summary: Delete a Digital Asset
tags:
@@ -3072,8 +3073,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T22:37:28.532Z'
- updated_at: '2021-10-29T22:37:28.541Z'
+ created_at: '2021-10-29T23:23:42.707Z'
+ updated_at: '2021-10-29T23:23:42.716Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3083,6 +3084,10 @@ paths:
pre_tax_amount: '10.0'
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
+ display_pre_tax_amount: "$10.00"
+ display_adjustment_total: "$0.00"
display_price: "$10.00"
single_display_amount: "$10.00"
display_discounted_amount: "$10.00"
@@ -3090,11 +3095,7 @@ paths:
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
- display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
- display_included_tax_total: "$0.00"
- display_pre_tax_amount: "$10.00"
relationships:
order:
data:
@@ -3119,8 +3120,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T22:37:28.569Z'
- updated_at: '2021-10-29T22:37:28.574Z'
+ created_at: '2021-10-29T23:23:42.752Z'
+ updated_at: '2021-10-29T23:23:42.760Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3130,6 +3131,10 @@ paths:
pre_tax_amount: '10.0'
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
+ display_pre_tax_amount: "$10.00"
+ display_adjustment_total: "$0.00"
display_price: "$10.00"
single_display_amount: "$10.00"
display_discounted_amount: "$10.00"
@@ -3137,11 +3142,7 @@ paths:
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
- display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
- display_included_tax_total: "$0.00"
- display_pre_tax_amount: "$10.00"
relationships:
order:
data:
@@ -3213,8 +3214,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T22:37:28.772Z'
- updated_at: '2021-10-29T22:37:28.806Z'
+ created_at: '2021-10-29T23:23:42.974Z'
+ updated_at: '2021-10-29T23:23:43.010Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3224,6 +3225,10 @@ paths:
pre_tax_amount: '10.0'
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
+ display_pre_tax_amount: "$10.00"
+ display_adjustment_total: "$0.00"
display_price: "$10.00"
single_display_amount: "$10.00"
display_discounted_amount: "$10.00"
@@ -3231,11 +3236,7 @@ paths:
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
- display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
- display_included_tax_total: "$0.00"
- display_pre_tax_amount: "$10.00"
relationships:
order:
data:
@@ -3279,7 +3280,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/line_item_params"
+ "$ref": "#/components/schemas/create_line_item_params"
"/api/v2/platform/line_items/{id}":
get:
summary: Return a Line Item
@@ -3316,8 +3317,8 @@ paths:
attributes:
quantity: 1
price: '10.0'
- created_at: '2021-10-29T22:37:28.941Z'
- updated_at: '2021-10-29T22:37:28.950Z'
+ created_at: '2021-10-29T23:23:43.162Z'
+ updated_at: '2021-10-29T23:23:43.169Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3327,6 +3328,10 @@ paths:
pre_tax_amount: '10.0'
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
+ display_pre_tax_amount: "$10.00"
+ display_adjustment_total: "$0.00"
display_price: "$10.00"
single_display_amount: "$10.00"
display_discounted_amount: "$10.00"
@@ -3334,11 +3339,7 @@ paths:
display_amount: "$10.00"
display_subtotal: "$10.00"
display_final_amount: "$10.00"
- display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
- display_included_tax_total: "$0.00"
- display_pre_tax_amount: "$10.00"
relationships:
order:
data:
@@ -3415,8 +3416,8 @@ paths:
attributes:
quantity: 4
price: '10.0'
- created_at: '2021-10-29T22:37:29.153Z'
- updated_at: '2021-10-29T22:37:29.191Z'
+ created_at: '2021-10-29T23:23:43.411Z'
+ updated_at: '2021-10-29T23:23:43.451Z'
currency: USD
cost_price: '17.0'
adjustment_total: '0.0'
@@ -3426,6 +3427,10 @@ paths:
pre_tax_amount: '40.0'
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
+ display_pre_tax_amount: "$40.00"
+ display_adjustment_total: "$0.00"
display_price: "$10.00"
single_display_amount: "$10.00"
display_discounted_amount: "$40.00"
@@ -3433,11 +3438,7 @@ paths:
display_amount: "$40.00"
display_subtotal: "$40.00"
display_final_amount: "$40.00"
- display_adjustment_total: "$0.00"
display_additional_tax_total: "$0.00"
- display_promo_total: "$0.00"
- display_included_tax_total: "$0.00"
- display_pre_tax_amount: "$40.00"
relationships:
order:
data:
@@ -3466,10 +3467,10 @@ paths:
examples:
Example:
value:
- error: 'Quantity selected of "Product #133 - 9680" is not available.'
+ error: 'Quantity selected of "Product #133 - 1805" is not available.'
errors:
quantity:
- - 'selected of "Product #133 - 9680" is not available.'
+ - 'selected of "Product #133 - 1805" is not available.'
schema:
"$ref": "#/components/schemas/validation_errors"
'404':
@@ -3496,7 +3497,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/line_item_params"
+ "$ref": "#/components/schemas/update_line_item_params"
delete:
summary: Delete a Line Item
tags:
@@ -3589,8 +3590,8 @@ paths:
lft: 2
rgt: 3
depth: 1
- created_at: '2021-10-29T22:37:29.887Z'
- updated_at: '2021-10-29T22:37:29.893Z'
+ created_at: '2021-10-29T23:23:44.068Z'
+ updated_at: '2021-10-29T23:23:44.073Z'
link:
is_container: false
is_root: false
@@ -3626,8 +3627,8 @@ paths:
lft: 4
rgt: 5
depth: 1
- created_at: '2021-10-29T22:37:29.941Z'
- updated_at: '2021-10-29T22:37:29.945Z'
+ created_at: '2021-10-29T23:23:44.119Z'
+ updated_at: '2021-10-29T23:23:44.123Z'
link:
is_container: false
is_root: false
@@ -3663,8 +3664,8 @@ paths:
lft: 6
rgt: 7
depth: 1
- created_at: '2021-10-29T22:37:29.992Z'
- updated_at: '2021-10-29T22:37:29.996Z'
+ created_at: '2021-10-29T23:23:44.168Z'
+ updated_at: '2021-10-29T23:23:44.172Z'
link:
is_container: false
is_root: false
@@ -3700,8 +3701,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T22:37:30.044Z'
- updated_at: '2021-10-29T22:37:30.049Z'
+ created_at: '2021-10-29T23:23:44.220Z'
+ updated_at: '2021-10-29T23:23:44.224Z'
link:
is_container: false
is_root: false
@@ -3737,8 +3738,8 @@ paths:
lft: 10
rgt: 11
depth: 1
- created_at: '2021-10-29T22:37:30.098Z'
- updated_at: '2021-10-29T22:37:30.102Z'
+ created_at: '2021-10-29T23:23:44.269Z'
+ updated_at: '2021-10-29T23:23:44.273Z'
link:
is_container: false
is_root: false
@@ -3774,8 +3775,8 @@ paths:
lft: 12
rgt: 13
depth: 1
- created_at: '2021-10-29T22:37:30.150Z'
- updated_at: '2021-10-29T22:37:30.154Z'
+ created_at: '2021-10-29T23:23:44.330Z'
+ updated_at: '2021-10-29T23:23:44.340Z'
link:
is_container: false
is_root: false
@@ -3811,8 +3812,8 @@ paths:
lft: 14
rgt: 15
depth: 1
- created_at: '2021-10-29T22:37:30.201Z'
- updated_at: '2021-10-29T22:37:30.206Z'
+ created_at: '2021-10-29T23:23:44.412Z'
+ updated_at: '2021-10-29T23:23:44.419Z'
link:
is_container: false
is_root: false
@@ -3838,7 +3839,7 @@ paths:
- id: '1'
type: menu_item
attributes:
- name: Eos suscipit recusandae dolorum consequuntur cum voluptatem.
+ name: Quod eaque ex quaerat voluptas.
subtitle:
destination:
new_window: false
@@ -3848,8 +3849,8 @@ paths:
lft: 1
rgt: 16
depth: 0
- created_at: '2021-10-29T22:37:29.830Z'
- updated_at: '2021-10-29T22:37:30.215Z'
+ created_at: '2021-10-29T23:23:44.012Z'
+ updated_at: '2021-10-29T23:23:44.433Z'
link:
is_container: true
is_root: true
@@ -3942,8 +3943,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T22:37:30.823Z'
- updated_at: '2021-10-29T22:37:30.827Z'
+ created_at: '2021-10-29T23:23:45.089Z'
+ updated_at: '2021-10-29T23:23:45.092Z'
link:
is_container: false
is_root: false
@@ -3988,7 +3989,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/menu_item_params"
+ "$ref": "#/components/schemas/create_menu_item_params"
"/api/v2/platform/menu_items/{id}":
get:
summary: Return a Menu Item
@@ -4033,8 +4034,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T22:37:31.248Z'
- updated_at: '2021-10-29T22:37:31.253Z'
+ created_at: '2021-10-29T23:23:45.521Z'
+ updated_at: '2021-10-29T23:23:45.525Z'
link:
is_container: false
is_root: false
@@ -4122,8 +4123,8 @@ paths:
lft: 8
rgt: 9
depth: 1
- created_at: '2021-10-29T22:37:31.934Z'
- updated_at: '2021-10-29T22:37:31.957Z'
+ created_at: '2021-10-29T23:23:46.199Z'
+ updated_at: '2021-10-29T23:23:46.225Z'
link:
is_container: false
is_root: false
@@ -4185,7 +4186,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/menu_item_params"
+ "$ref": "#/components/schemas/update_menu_item_params"
delete:
summary: Delete a Menu Item
tags:
@@ -4260,8 +4261,8 @@ paths:
lft: 5
rgt: 6
depth: 2
- created_at: '2021-10-29T22:37:33.499Z'
- updated_at: '2021-10-29T22:37:33.523Z'
+ created_at: '2021-10-29T23:23:47.817Z'
+ updated_at: '2021-10-29T23:23:47.841Z'
link:
is_container: false
is_root: false
@@ -4359,8 +4360,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T22:37:34.000Z'
- updated_at: '2021-10-29T22:37:34.112Z'
+ created_at: '2021-10-29T23:23:48.347Z'
+ updated_at: '2021-10-29T23:23:48.458Z'
relationships:
menu_items:
data:
@@ -4376,8 +4377,8 @@ paths:
name: Footer Menu
location: footer
locale: en
- created_at: '2021-10-29T22:37:34.008Z'
- updated_at: '2021-10-29T22:37:34.246Z'
+ created_at: '2021-10-29T23:23:48.354Z'
+ updated_at: '2021-10-29T23:23:48.565Z'
relationships:
menu_items:
data:
@@ -4440,8 +4441,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T22:37:34.548Z'
- updated_at: '2021-10-29T22:37:34.554Z'
+ created_at: '2021-10-29T23:23:48.864Z'
+ updated_at: '2021-10-29T23:23:48.870Z'
relationships:
menu_items:
data:
@@ -4471,7 +4472,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/menu_params"
+ "$ref": "#/components/schemas/create_menu_params"
"/api/v2/platform/menus/{id}":
get:
summary: Return a Menu
@@ -4509,8 +4510,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T22:37:34.587Z'
- updated_at: '2021-10-29T22:37:34.593Z'
+ created_at: '2021-10-29T23:23:48.910Z'
+ updated_at: '2021-10-29T23:23:48.916Z'
relationships:
menu_items:
data:
@@ -4574,8 +4575,8 @@ paths:
name: Main Menu
location: header
locale: en
- created_at: '2021-10-29T22:37:34.670Z'
- updated_at: '2021-10-29T22:37:34.676Z'
+ created_at: '2021-10-29T23:23:48.992Z'
+ updated_at: '2021-10-29T23:23:48.999Z'
relationships:
menu_items:
data:
@@ -4625,7 +4626,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/menu_params"
+ "$ref": "#/components/schemas/update_menu_params"
delete:
summary: Delete a Menu
tags:
@@ -4710,8 +4711,8 @@ paths:
name: foo-size-68
presentation: Size
position: 1
- created_at: '2021-10-29T22:37:34.850Z'
- updated_at: '2021-10-29T22:37:34.850Z'
+ created_at: '2021-10-29T23:23:49.169Z'
+ updated_at: '2021-10-29T23:23:49.169Z'
filterable: true
relationships:
option_values:
@@ -4722,8 +4723,8 @@ paths:
name: foo-size-69
presentation: Size
position: 2
- created_at: '2021-10-29T22:37:34.852Z'
- updated_at: '2021-10-29T22:37:34.852Z'
+ created_at: '2021-10-29T23:23:49.171Z'
+ updated_at: '2021-10-29T23:23:49.171Z'
filterable: true
relationships:
option_values:
@@ -4774,8 +4775,8 @@ paths:
name: foo-size-72
presentation: Size
position: 1
- created_at: '2021-10-29T22:37:34.901Z'
- updated_at: '2021-10-29T22:37:34.901Z'
+ created_at: '2021-10-29T23:23:49.220Z'
+ updated_at: '2021-10-29T23:23:49.220Z'
filterable: true
relationships:
option_values:
@@ -4801,7 +4802,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/option_type_params"
+ "$ref": "#/components/schemas/create_option_type_params"
"/api/v2/platform/option_types/{id}":
get:
summary: Return an Option Type
@@ -4832,8 +4833,8 @@ paths:
name: foo-size-73
presentation: Size
position: 1
- created_at: '2021-10-29T22:37:34.931Z'
- updated_at: '2021-10-29T22:37:34.931Z'
+ created_at: '2021-10-29T23:23:49.259Z'
+ updated_at: '2021-10-29T23:23:49.259Z'
filterable: true
relationships:
option_values:
@@ -4889,8 +4890,8 @@ paths:
name: Size-X
presentation: Size
position: 1
- created_at: '2021-10-29T22:37:34.977Z'
- updated_at: '2021-10-29T22:37:34.984Z'
+ created_at: '2021-10-29T23:23:49.320Z'
+ updated_at: '2021-10-29T23:23:49.328Z'
filterable: true
relationships:
option_values:
@@ -4934,7 +4935,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/option_type_params"
+ "$ref": "#/components/schemas/update_option_type_params"
delete:
summary: Delete an Option Type
tags:
@@ -5026,8 +5027,8 @@ paths:
position: 1
name: Size-68
presentation: S
- created_at: '2021-10-29T22:37:35.102Z'
- updated_at: '2021-10-29T22:37:35.102Z'
+ created_at: '2021-10-29T23:23:49.458Z'
+ updated_at: '2021-10-29T23:23:49.458Z'
relationships:
option_type:
data:
@@ -5039,8 +5040,8 @@ paths:
position: 1
name: Size-69
presentation: S
- created_at: '2021-10-29T22:37:35.109Z'
- updated_at: '2021-10-29T22:37:35.109Z'
+ created_at: '2021-10-29T23:23:49.464Z'
+ updated_at: '2021-10-29T23:23:49.464Z'
relationships:
option_type:
data:
@@ -5099,8 +5100,8 @@ paths:
position: 1
name: Size-72
presentation: S
- created_at: '2021-10-29T22:37:35.164Z'
- updated_at: '2021-10-29T22:37:35.164Z'
+ created_at: '2021-10-29T23:23:49.519Z'
+ updated_at: '2021-10-29T23:23:49.519Z'
relationships:
option_type:
data:
@@ -5125,7 +5126,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/option_value_params"
+ "$ref": "#/components/schemas/create_option_value_params"
"/api/v2/platform/option_values/{id}":
get:
summary: Return an Option Value
@@ -5163,8 +5164,8 @@ paths:
position: 1
name: Size-73
presentation: S
- created_at: '2021-10-29T22:37:35.194Z'
- updated_at: '2021-10-29T22:37:35.194Z'
+ created_at: '2021-10-29T23:23:49.556Z'
+ updated_at: '2021-10-29T23:23:49.556Z'
relationships:
option_type:
data:
@@ -5228,8 +5229,8 @@ paths:
position: 1
name: M
presentation: S
- created_at: '2021-10-29T22:37:35.248Z'
- updated_at: '2021-10-29T22:37:35.256Z'
+ created_at: '2021-10-29T23:23:49.637Z'
+ updated_at: '2021-10-29T23:23:49.645Z'
relationships:
option_type:
data:
@@ -5274,7 +5275,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/option_value_params"
+ "$ref": "#/components/schemas/update_option_value_params"
delete:
summary: Delete an Option Value
tags:
@@ -5357,7 +5358,7 @@ paths:
- id: '40'
type: order
attributes:
- number: R711934114
+ number: R108079985
item_total: '0.0'
total: '0.0'
state: cart
@@ -5366,10 +5367,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:35.400Z'
- updated_at: '2021-10-29T22:37:35.400Z'
+ created_at: '2021-10-29T23:23:49.799Z'
+ updated_at: '2021-10-29T23:23:49.799Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5385,6 +5386,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$0.00"
display_ship_total: "$0.00"
display_shipment_total: "$0.00"
@@ -5396,8 +5399,6 @@ paths:
display_pre_tax_item_amount: "$0.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: "$0.00"
@@ -5441,7 +5442,7 @@ paths:
- id: '41'
type: order
attributes:
- number: R813613111
+ number: R424061137
item_total: '0.0'
total: '0.0'
state: cart
@@ -5450,10 +5451,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:35.408Z'
- updated_at: '2021-10-29T22:37:35.408Z'
+ created_at: '2021-10-29T23:23:49.808Z'
+ updated_at: '2021-10-29T23:23:49.808Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5469,6 +5470,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$0.00"
display_ship_total: "$0.00"
display_shipment_total: "$0.00"
@@ -5480,8 +5483,6 @@ paths:
display_pre_tax_item_amount: "$0.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: "$0.00"
@@ -5572,7 +5573,7 @@ paths:
id: '44'
type: order
attributes:
- number: R598507074
+ number: R005918748
item_total: '0.0'
total: '0.0'
state: cart
@@ -5583,8 +5584,8 @@ paths:
payment_state:
email:
special_instructions:
- created_at: '2021-10-29T22:37:35.688Z'
- updated_at: '2021-10-29T22:37:35.701Z'
+ created_at: '2021-10-29T23:23:50.077Z'
+ updated_at: '2021-10-29T23:23:50.092Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -5600,6 +5601,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$20.00"
display_ship_total: "$0.00"
display_shipment_total: "$0.00"
@@ -5611,8 +5614,6 @@ paths:
display_pre_tax_item_amount: "$20.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: "$0.00"
@@ -5663,7 +5664,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/order_params"
+ "$ref": "#/components/schemas/create_order_params"
"/api/v2/platform/orders/{id}":
get:
summary: Return an Order
@@ -5698,7 +5699,7 @@ paths:
id: '45'
type: order
attributes:
- number: R275840570
+ number: R633370677
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5707,10 +5708,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:35.737Z'
- updated_at: '2021-10-29T22:37:35.884Z'
+ created_at: '2021-10-29T23:23:50.130Z'
+ updated_at: '2021-10-29T23:23:50.264Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5726,6 +5727,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$10.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -5737,8 +5740,6 @@ paths:
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: "$110.00"
@@ -5840,7 +5841,7 @@ paths:
id: '47'
type: order
attributes:
- number: R612896884
+ number: R198662449
item_total: '10.0'
total: '110.0'
state: delivery
@@ -5851,8 +5852,8 @@ paths:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:36.048Z'
- updated_at: '2021-10-29T22:37:36.140Z'
+ created_at: '2021-10-29T23:23:50.442Z'
+ updated_at: '2021-10-29T23:23:50.532Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -5868,6 +5869,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$10.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -5879,8 +5882,6 @@ paths:
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: "$110.00"
@@ -5966,7 +5967,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/order_params"
+ "$ref": "#/components/schemas/update_order_params"
delete:
summary: Delete an Order
tags:
@@ -6038,7 +6039,7 @@ paths:
id: '52'
type: order
attributes:
- number: R086394308
+ number: R933619649
item_total: '10.0'
total: '110.0'
state: payment
@@ -6047,10 +6048,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:36.681Z'
- updated_at: '2021-10-29T22:37:36.812Z'
+ created_at: '2021-10-29T23:23:51.079Z'
+ updated_at: '2021-10-29T23:23:51.208Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6066,6 +6067,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$110.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -6077,8 +6080,6 @@ paths:
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: "$110.00"
@@ -6183,7 +6184,7 @@ paths:
id: '54'
type: order
attributes:
- number: R650614089
+ number: R226444906
item_total: '10.0'
total: '110.0'
state: payment
@@ -6192,10 +6193,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:36.992Z'
- updated_at: '2021-10-29T22:37:37.125Z'
+ created_at: '2021-10-29T23:23:51.406Z'
+ updated_at: '2021-10-29T23:23:51.541Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6211,6 +6212,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$110.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -6222,8 +6225,6 @@ paths:
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: "$110.00"
@@ -6328,19 +6329,19 @@ paths:
id: '56'
type: order
attributes:
- number: R732790132
+ number: R745502971
item_total: '10.0'
total: '110.0'
state: complete
adjustment_total: '0.0'
- completed_at: '2021-10-29T22:37:37.507Z'
+ completed_at: '2021-10-29T23:23:51.910Z'
payment_total: '0.0'
shipment_state: pending
payment_state: balance_due
special_instructions:
- created_at: '2021-10-29T22:37:37.312Z'
- updated_at: '2021-10-29T22:37:37.507Z'
+ created_at: '2021-10-29T23:23:51.717Z'
+ updated_at: '2021-10-29T23:23:51.910Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6356,6 +6357,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$110.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -6367,8 +6370,6 @@ paths:
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: "$110.00"
@@ -6484,7 +6485,7 @@ paths:
id: '59'
type: order
attributes:
- number: R891868374
+ number: R199729391
item_total: '0.0'
total: '0.0'
state: cart
@@ -6493,10 +6494,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:37.804Z'
- updated_at: '2021-10-29T22:37:37.913Z'
+ created_at: '2021-10-29T23:23:52.203Z'
+ updated_at: '2021-10-29T23:23:52.305Z'
currency: USD
last_ip_address:
shipment_total: '0.0'
@@ -6512,6 +6513,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$0.00"
display_ship_total: "$0.00"
display_shipment_total: "$0.00"
@@ -6523,8 +6526,6 @@ paths:
display_pre_tax_item_amount: "$0.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: "$0.00"
@@ -6624,7 +6625,7 @@ paths:
id: '61'
type: order
attributes:
- number: R233772120
+ number: R646999590
item_total: '10.0'
total: '110.0'
state: delivery
@@ -6633,10 +6634,10 @@ paths:
payment_total: '0.0'
shipment_state:
payment_state:
special_instructions:
- created_at: '2021-10-29T22:37:38.064Z'
- updated_at: '2021-10-29T22:37:38.147Z'
+ created_at: '2021-10-29T23:23:52.472Z'
+ updated_at: '2021-10-29T23:23:52.555Z'
currency: USD
last_ip_address:
shipment_total: '100.0'
@@ -6652,6 +6653,8 @@ paths:
taxable_adjustment_total: '0.0'
non_taxable_adjustment_total: '0.0'
store_owner_notification_delivered:
+ display_promo_total: "$0.00"
+ display_included_tax_total: "$0.00"
display_pre_tax_total: "$10.00"
display_ship_total: "$100.00"
display_shipment_total: "$100.00"
@@ -6663,8 +6666,6 @@ paths:
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: "$110.00"
@@ -6941,9 +6942,9 @@ paths:
state: invalid
response_code: '12345'
avs_response:
- created_at: '2021-10-29T22:37:39.689Z'
- updated_at: '2021-10-29T22:37:39.707Z'
- number: PQAJTV43
+ created_at: '2021-10-29T23:23:54.150Z'
+ updated_at: '2021-10-29T23:23:54.170Z'
+ number: P7CZ7NJ8
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -6978,9 +6979,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-10-29T22:37:39.704Z'
- updated_at: '2021-10-29T22:37:39.704Z'
- number: PXUZXZ7D
+ created_at: '2021-10-29T23:23:54.166Z'
+ updated_at: '2021-10-29T23:23:54.166Z'
+ number: PD77I7CL
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -7066,9 +7067,9 @@ paths:
state: checkout
response_code: '12345'
avs_response:
- created_at: '2021-10-29T22:37:39.857Z'
- updated_at: '2021-10-29T22:37:39.857Z'
- number: P0IYIUQF
+ created_at: '2021-10-29T23:23:54.336Z'
+ updated_at: '2021-10-29T23:23:54.336Z'
+ number: P9DW7TGA
cvv_response_code:
cvv_response_message:
display_amount: "$45.75"
@@ -7204,8 +7205,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T22:37:40.061Z'
- updated_at: '2021-10-29T22:37:40.061Z'
+ created_at: '2021-10-29T23:23:54.556Z'
+ updated_at: '2021-10-29T23:23:54.556Z'
code: POP123
relationships:
promotions:
@@ -7214,8 +7215,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T22:37:40.063Z'
- updated_at: '2021-10-29T22:37:40.063Z'
+ created_at: '2021-10-29T23:23:54.558Z'
+ updated_at: '2021-10-29T23:23:54.558Z'
code: POP123
relationships:
promotions:
@@ -7271,8 +7272,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T22:37:40.105Z'
- updated_at: '2021-10-29T22:37:40.105Z'
+ created_at: '2021-10-29T23:23:54.607Z'
+ updated_at: '2021-10-29T23:23:54.607Z'
code: 2021-BFM
relationships:
promotions:
@@ -7296,7 +7297,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/promotion_category_params"
+ "$ref": "#/components/schemas/create_promotion_category_params"
"/api/v2/platform/promotion_categories/{id}":
get:
summary: Return a Promotion Category
@@ -7332,8 +7333,8 @@ paths:
type: promotion_category
attributes:
name: Promotion Category
- created_at: '2021-10-29T22:37:40.139Z'
- updated_at: '2021-10-29T22:37:40.139Z'
+ created_at: '2021-10-29T23:23:54.640Z'
+ updated_at: '2021-10-29T23:23:54.640Z'
code: MJO
relationships:
promotions:
@@ -7394,8 +7395,8 @@ paths:
type: promotion_category
attributes:
name: 2021 Promotions
- created_at: '2021-10-29T22:37:40.188Z'
- updated_at: '2021-10-29T22:37:40.194Z'
+ created_at: '2021-10-29T23:23:54.695Z'
+ updated_at: '2021-10-29T23:23:54.701Z'
code: 2021-Promos
relationships:
promotions:
@@ -7439,7 +7440,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/promotion_category_params"
+ "$ref": "#/components/schemas/update_promotion_category_params"
delete:
summary: Delete a Promotion Category
tags:
@@ -7523,12 +7524,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H03043946098
+ number: H42597052364
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T22:37:40.314Z'
- updated_at: '2021-10-29T22:37:40.317Z'
+ created_at: '2021-10-29T23:23:54.838Z'
+ updated_at: '2021-10-29T23:23:54.842Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7570,12 +7571,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H31813446413
+ number: H18069206798
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T22:37:40.344Z'
- updated_at: '2021-10-29T22:37:40.348Z'
+ created_at: '2021-10-29T23:23:54.868Z'
+ updated_at: '2021-10-29T23:23:54.871Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7670,12 +7671,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H31811256833
+ number: H30367228273
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T22:37:40.643Z'
- updated_at: '2021-10-29T22:37:40.661Z'
+ created_at: '2021-10-29T23:23:55.169Z'
+ updated_at: '2021-10-29T23:23:55.187Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7809,12 +7810,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H88928102789
+ number: H78052690466
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-10-29T22:37:41.437Z'
- updated_at: '2021-10-29T22:37:41.461Z'
+ created_at: '2021-10-29T23:23:55.988Z'
+ updated_at: '2021-10-29T23:23:56.016Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -7913,12 +7914,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H00455357252
+ number: H33315109928
cost: '100.0'
- shipped_at: '2021-10-29T22:37:41.873Z'
+ shipped_at: '2021-10-29T23:23:56.434Z'
state: shipped
- created_at: '2021-10-29T22:37:41.834Z'
- updated_at: '2021-10-29T22:37:41.873Z'
+ created_at: '2021-10-29T23:23:56.402Z'
+ updated_at: '2021-10-29T23:23:56.434Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8017,12 +8018,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H81229596042
+ number: H25484341432
cost: '100.0'
shipped_at:
state: canceled
- created_at: '2021-10-29T22:37:42.257Z'
- updated_at: '2021-10-29T22:37:42.283Z'
+ created_at: '2021-10-29T23:23:56.831Z'
+ updated_at: '2021-10-29T23:23:56.857Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8121,12 +8122,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H60432752617
+ number: H51087163536
cost: '100.0'
shipped_at:
state: ready
- created_at: '2021-10-29T22:37:42.666Z'
- updated_at: '2021-10-29T22:37:42.695Z'
+ created_at: '2021-10-29T23:23:57.260Z'
+ updated_at: '2021-10-29T23:23:57.288Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8225,12 +8226,12 @@ paths:
type: shipment
attributes:
tracking: U10000
- number: H58735809312
+ number: H55856768622
cost: '100.0'
shipped_at:
state: pending
- created_at: '2021-10-29T22:37:43.103Z'
- updated_at: '2021-10-29T22:37:43.130Z'
+ created_at: '2021-10-29T23:23:57.703Z'
+ updated_at: '2021-10-29T23:23:57.731Z'
adjustment_total: '0.0'
additional_tax_total: '0.0'
promo_total: '0.0'
@@ -8333,14 +8334,14 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #119'
- created_at: '2021-10-29T22:37:43.365Z'
- updated_at: '2021-10-29T22:37:43.365Z'
+ created_at: '2021-10-29T23:23:57.980Z'
+ updated_at: '2021-10-29T23:23:57.980Z'
- id: '120'
type: shipping_category
attributes:
name: 'ShippingCategory #120'
- created_at: '2021-10-29T22:37:43.366Z'
- updated_at: '2021-10-29T22:37:43.366Z'
+ created_at: '2021-10-29T23:23:57.981Z'
+ updated_at: '2021-10-29T23:23:57.981Z'
meta:
count: 2
total_count: 2
@@ -8385,8 +8386,8 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #123'
- created_at: '2021-10-29T22:37:43.412Z'
- updated_at: '2021-10-29T22:37:43.412Z'
+ created_at: '2021-10-29T23:23:58.028Z'
+ updated_at: '2021-10-29T23:23:58.028Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -8406,7 +8407,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/shipping_category_params"
+ "$ref": "#/components/schemas/create_shipping_category_params"
"/api/v2/platform/shipping_categories/{id}":
get:
summary: Return a Shipping Category
@@ -8435,8 +8436,8 @@ paths:
type: shipping_category
attributes:
name: 'ShippingCategory #124'
- created_at: '2021-10-29T22:37:43.440Z'
- updated_at: '2021-10-29T22:37:43.440Z'
+ created_at: '2021-10-29T23:23:58.067Z'
+ updated_at: '2021-10-29T23:23:58.067Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -8486,8 +8487,8 @@ paths:
type: shipping_category
attributes:
name: Default
- created_at: '2021-10-29T22:37:43.494Z'
- updated_at: '2021-10-29T22:37:43.501Z'
+ created_at: '2021-10-29T23:23:58.121Z'
+ updated_at: '2021-10-29T23:23:58.128Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -8527,7 +8528,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/shipping_category_params"
+ "$ref": "#/components/schemas/update_shipping_category_params"
delete:
summary: Delete a Shipping Category
tags:
@@ -8621,8 +8622,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T22:37:43.614Z'
- updated_at: '2021-10-29T22:37:43.614Z'
+ created_at: '2021-10-29T23:23:58.251Z'
+ updated_at: '2021-10-29T23:23:58.251Z'
deleted_at:
relationships:
shipping_categories:
@@ -8645,8 +8646,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T22:37:43.624Z'
- updated_at: '2021-10-29T22:37:43.624Z'
+ created_at: '2021-10-29T23:23:58.261Z'
+ updated_at: '2021-10-29T23:23:58.261Z'
deleted_at:
relationships:
shipping_categories:
@@ -8716,8 +8717,8 @@ paths:
admin_name: DHL Express- Zone A
display_on: both
tracking_url:
- created_at: '2021-10-29T22:37:43.793Z'
- updated_at: '2021-10-29T22:37:43.793Z'
+ created_at: '2021-10-29T23:23:58.337Z'
+ updated_at: '2021-10-29T23:23:58.337Z'
deleted_at:
relationships:
shipping_categories:
@@ -8761,7 +8762,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/shipping_method_params"
+ "$ref": "#/components/schemas/create_shipping_method_params"
"/api/v2/platform/shipping_methods/{id}":
get:
summary: Return a Shipping Method
@@ -8801,8 +8802,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T22:37:43.835Z'
- updated_at: '2021-10-29T22:37:43.835Z'
+ created_at: '2021-10-29T23:23:58.381Z'
+ updated_at: '2021-10-29T23:23:58.381Z'
deleted_at:
relationships:
shipping_categories:
@@ -8877,8 +8878,8 @@ paths:
admin_name:
display_on: both
tracking_url:
- created_at: '2021-10-29T22:37:43.905Z'
- updated_at: '2021-10-29T22:37:43.919Z'
+ created_at: '2021-10-29T23:23:58.465Z'
+ updated_at: '2021-10-29T23:23:58.479Z'
deleted_at:
relationships:
shipping_categories:
@@ -8932,7 +8933,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/shipping_method_params"
+ "$ref": "#/components/schemas/update_shipping_method_params"
delete:
summary: Delete a Shipping Method
tags:
@@ -9027,8 +9028,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T22:37:44.143Z'
- updated_at: '2021-10-29T22:37:44.147Z'
+ created_at: '2021-10-29T23:23:58.795Z'
+ updated_at: '2021-10-29T23:23:58.799Z'
meta_title:
meta_description:
meta_keywords:
@@ -9062,8 +9063,8 @@ paths:
lft: 4
rgt: 5
description:
- created_at: '2021-10-29T22:37:44.196Z'
- updated_at: '2021-10-29T22:37:44.200Z'
+ created_at: '2021-10-29T23:23:58.847Z'
+ updated_at: '2021-10-29T23:23:58.850Z'
meta_title:
meta_description:
meta_keywords:
@@ -9097,8 +9098,8 @@ paths:
lft: 1
rgt: 6
description:
- created_at: '2021-10-29T22:37:44.088Z'
- updated_at: '2021-10-29T22:37:44.211Z'
+ created_at: '2021-10-29T23:23:58.745Z'
+ updated_at: '2021-10-29T23:23:58.860Z'
meta_title:
meta_description:
meta_keywords:
@@ -9179,8 +9180,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T22:37:44.445Z'
- updated_at: '2021-10-29T22:37:44.449Z'
+ created_at: '2021-10-29T23:23:59.077Z'
+ updated_at: '2021-10-29T23:23:59.082Z'
meta_title:
meta_description:
meta_keywords:
@@ -9224,7 +9225,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/taxon_params"
+ "$ref": "#/components/schemas/create_taxon_params"
"/api/v2/platform/taxons/{id}":
get:
summary: Return a Taxon
@@ -9265,8 +9266,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T22:37:44.543Z'
- updated_at: '2021-10-29T22:37:44.547Z'
+ created_at: '2021-10-29T23:23:59.190Z'
+ updated_at: '2021-10-29T23:23:59.195Z'
meta_title:
meta_description:
meta_keywords:
@@ -9354,8 +9355,8 @@ paths:
lft: 2
rgt: 3
description:
- created_at: '2021-10-29T22:37:44.740Z'
- updated_at: '2021-10-29T22:37:44.763Z'
+ created_at: '2021-10-29T23:23:59.425Z'
+ updated_at: '2021-10-29T23:23:59.449Z'
meta_title:
meta_description:
meta_keywords:
@@ -9419,7 +9420,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/taxon_params"
+ "$ref": "#/components/schemas/update_taxon_params"
delete:
summary: Delete a Taxon
tags:
@@ -9508,9 +9509,9 @@ paths:
- id: '97'
type: user
attributes:
- created_at: '2021-10-29T22:37:45.197Z'
- updated_at: '2021-10-29T22:37:45.197Z'
+ created_at: '2021-10-29T23:23:59.890Z'
+ updated_at: '2021-10-29T23:23:59.890Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9522,9 +9523,9 @@ paths:
- id: '98'
type: user
attributes:
- created_at: '2021-10-29T22:37:45.203Z'
- updated_at: '2021-10-29T22:37:45.203Z'
+ created_at: '2021-10-29T23:23:59.897Z'
+ updated_at: '2021-10-29T23:23:59.897Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9536,9 +9537,9 @@ paths:
- id: '99'
type: user
attributes:
- created_at: '2021-10-29T22:37:45.204Z'
- updated_at: '2021-10-29T22:37:45.204Z'
+ created_at: '2021-10-29T23:23:59.898Z'
+ updated_at: '2021-10-29T23:23:59.898Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9570,12 +9571,12 @@ paths:
schema:
"$ref": "#/components/schemas/error"
post:
- summary: Create an User
+ summary: Create a User
tags:
- Users
security:
- bearer_auth: []
- description: Creates an User
+ description: Creates a User
operationId: create-user
parameters:
- name: include
@@ -9597,9 +9598,9 @@ paths:
id: '104'
type: user
attributes:
- created_at: '2021-10-29T22:37:45.267Z'
- updated_at: '2021-10-29T22:37:45.267Z'
+ created_at: '2021-10-29T23:23:59.966Z'
+ updated_at: '2021-10-29T23:23:59.966Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9627,15 +9628,15 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/user_params"
+ "$ref": "#/components/schemas/create_user_params"
"/api/v2/platform/users/{id}":
get:
- summary: Return an User
+ summary: Return a User
tags:
- Users
security:
- bearer_auth: []
- description: Returns an User
+ description: Returns a User
operationId: show-user
parameters:
- name: id
@@ -9662,9 +9663,9 @@ paths:
id: '107'
type: user
attributes:
- created_at: '2021-10-29T22:37:45.310Z'
- updated_at: '2021-10-29T22:37:45.310Z'
+ created_at: '2021-10-29T23:24:00.013Z'
+ updated_at: '2021-10-29T23:24:00.013Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9696,12 +9697,12 @@ paths:
schema:
"$ref": "#/components/schemas/error"
patch:
- summary: Update an User
+ summary: Update a User
tags:
- Users
security:
- bearer_auth: []
- description: Updates an User
+ description: Updates a User
operationId: update-user
parameters:
- name: id
@@ -9729,8 +9730,8 @@ paths:
type: user
attributes:
- created_at: '2021-10-29T22:37:45.375Z'
- updated_at: '2021-10-29T22:37:45.389Z'
+ created_at: '2021-10-29T23:24:00.082Z'
+ updated_at: '2021-10-29T23:24:00.091Z'
average_order_value: []
lifetime_value: []
store_credits: []
@@ -9778,14 +9779,14 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/user_params"
+ "$ref": "#/components/schemas/update_user_params"
delete:
- summary: Delete an User
+ summary: Delete a User
tags:
- Users
security:
- bearer_auth: []
- description: Deletes an User
+ description: Deletes a User
operationId: delete-user
parameters:
- name: id
@@ -9877,12 +9878,12 @@ paths:
position: 1
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T22:37:45.588Z'
+ updated_at: '2021-10-29T23:24:00.297Z'
discontinue_on:
- created_at: '2021-10-29T22:37:45.582Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:00.291Z'
display_compare_at_price:
- name: 'Product #184 - 9798'
+ display_price: "$19.99"
+ name: 'Product #184 - 3386'
options_text: ''
total_on_hand: 0
purchasable: true
@@ -9917,21 +9918,21 @@ paths:
type: variant
attributes:
sku: SKU-252
- weight: '111.5'
- height: '117.61'
- depth: '190.8'
+ weight: '32.2'
+ height: '81.4'
+ depth: '181.29'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T22:37:45.617Z'
+ updated_at: '2021-10-29T23:24:00.327Z'
discontinue_on:
- created_at: '2021-10-29T22:37:45.611Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:00.321Z'
display_compare_at_price:
- name: 'Product #184 - 9798'
+ display_price: "$19.99"
+ name: 'Product #184 - 3386'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -9968,21 +9969,21 @@ paths:
type: variant
attributes:
sku: SKU-253
- weight: '171.19'
- height: '177.83'
- depth: '193.5'
+ weight: '167.97'
+ height: '41.49'
+ depth: '160.8'
deleted_at:
is_master: false
cost_price: '17.0'
position: 3
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T22:37:45.635Z'
+ updated_at: '2021-10-29T23:24:00.346Z'
discontinue_on:
- created_at: '2021-10-29T22:37:45.629Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:00.340Z'
display_compare_at_price:
- name: 'Product #184 - 9798'
+ display_price: "$19.99"
+ name: 'Product #184 - 3386'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -10072,21 +10073,21 @@ paths:
type: variant
attributes:
sku: SKU-258
- weight: '89.82'
- height: '107.94'
- depth: '110.2'
+ weight: '160.3'
+ height: '161.4'
+ depth: '5.46'
deleted_at:
is_master: false
cost_price: '17.0'
position: 2
cost_currency: USD
track_inventory: true
- updated_at: '2021-10-29T22:37:45.867Z'
+ updated_at: '2021-10-29T23:24:00.550Z'
discontinue_on:
- created_at: '2021-10-29T22:37:45.858Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:00.544Z'
display_compare_at_price:
- name: 'Product #186 - 9751'
+ display_price: "$19.99"
+ name: 'Product #186 - 8328'
options_text: 'Size: S'
total_on_hand: 0
purchasable: true
@@ -10247,14 +10248,14 @@ paths:
- id: '1'
type: event
attributes:
- execution_time: 37677
+ execution_time: 70208
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url1.com/
- created_at: '2021-10-29T22:37:46.200Z'
- updated_at: '2021-10-29T22:37:46.200Z'
+ created_at: '2021-10-29T23:24:00.900Z'
+ updated_at: '2021-10-29T23:24:00.900Z'
relationships:
subscriber:
data:
@@ -10263,14 +10264,14 @@ paths:
- id: '2'
type: event
attributes:
- execution_time: 75802
+ execution_time: 55978
name: order.canceled
request_errors: ''
response_code: '200'
success: true
url: https://www.url2.com/
- created_at: '2021-10-29T22:37:46.205Z'
- updated_at: '2021-10-29T22:37:46.205Z'
+ created_at: '2021-10-29T23:24:00.903Z'
+ updated_at: '2021-10-29T23:24:00.903Z'
relationships:
subscriber:
data:
@@ -10346,8 +10347,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T22:37:46.248Z'
- updated_at: '2021-10-29T22:37:46.248Z'
+ created_at: '2021-10-29T23:24:00.949Z'
+ updated_at: '2021-10-29T23:24:00.949Z'
- id: '6'
type: subscriber
attributes:
@@ -10355,8 +10356,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T22:37:46.249Z'
- updated_at: '2021-10-29T22:37:46.249Z'
+ created_at: '2021-10-29T23:24:00.950Z'
+ updated_at: '2021-10-29T23:24:00.950Z'
meta:
count: 2
total_count: 2
@@ -10404,8 +10405,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T22:37:46.298Z'
- updated_at: '2021-10-29T22:37:46.298Z'
+ created_at: '2021-10-29T23:24:01.000Z'
+ updated_at: '2021-10-29T23:24:01.000Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -10428,7 +10429,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/webhook_subscriber_params"
+ "$ref": "#/components/schemas/create_webhook_subscriber_params"
"/api/v2/platform/webhooks/subscribers/{id}":
get:
summary: Return a Webhook Subscriber
@@ -10460,8 +10461,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T22:37:46.328Z'
- updated_at: '2021-10-29T22:37:46.328Z'
+ created_at: '2021-10-29T23:24:01.033Z'
+ updated_at: '2021-10-29T23:24:01.033Z'
schema:
"$ref": "#/components/schemas/resource"
'404':
@@ -10514,8 +10515,8 @@ paths:
active: true
subscriptions:
- "*"
- created_at: '2021-10-29T22:37:46.376Z'
- updated_at: '2021-10-29T22:37:46.376Z'
+ created_at: '2021-10-29T23:24:01.088Z'
+ updated_at: '2021-10-29T23:24:01.088Z'
schema:
"$ref": "#/components/schemas/resource"
'422':
@@ -10558,7 +10559,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/webhook_subscriber_params"
+ "$ref": "#/components/schemas/update_webhook_subscriber_params"
delete:
summary: Delete a Webhook Subscriber
tags:
@@ -10636,10 +10637,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:46.614Z'
- updated_at: '2021-10-29T22:37:46.614Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:01.337Z'
+ updated_at: '2021-10-29T23:24:01.337Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10651,10 +10652,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:46.661Z'
- updated_at: '2021-10-29T22:37:46.661Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:01.384Z'
+ updated_at: '2021-10-29T23:24:01.384Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10666,10 +10667,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:46.707Z'
- updated_at: '2021-10-29T22:37:46.707Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:01.431Z'
+ updated_at: '2021-10-29T23:24:01.431Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10681,10 +10682,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:46.753Z'
- updated_at: '2021-10-29T22:37:46.753Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:01.477Z'
+ updated_at: '2021-10-29T23:24:01.477Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10743,10 +10744,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:47.137Z'
- updated_at: '2021-10-29T22:37:47.137Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:01.849Z'
+ updated_at: '2021-10-29T23:24:01.849Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10778,7 +10779,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/wished_item_params"
+ "$ref": "#/components/schemas/create_wished_item_params"
"/api/v2/platform/wished_items/{id}":
get:
summary: Return a Wished Item
@@ -10814,10 +10815,10 @@ paths:
type: wished_item
attributes:
quantity: 1
- created_at: '2021-10-29T22:37:47.342Z'
- updated_at: '2021-10-29T22:37:47.342Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:02.053Z'
+ updated_at: '2021-10-29T23:24:02.053Z'
display_total: "$19.99"
+ display_price: "$19.99"
price: '19.99'
total: '19.99'
relationships:
@@ -10881,10 +10882,10 @@ paths:
type: wished_item
attributes:
quantity: 3
- created_at: '2021-10-29T22:37:47.685Z'
- updated_at: '2021-10-29T22:37:47.693Z'
- display_price: "$19.99"
+ created_at: '2021-10-29T23:24:02.399Z'
+ updated_at: '2021-10-29T23:24:02.406Z'
display_total: "$59.97"
+ display_price: "$19.99"
price: '19.99'
total: '59.97'
relationships:
@@ -10931,7 +10932,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/wished_item_params"
+ "$ref": "#/components/schemas/update_wished_item_params"
delete:
summary: Delete a Wished Item
tags:
@@ -11017,9 +11018,9 @@ paths:
name: Black Friday
is_private: true
is_default: false
- created_at: '2021-10-29T22:37:48.406Z'
- updated_at: '2021-10-29T22:37:48.406Z'
- token: hzz2XeUekvfx5rYUL1vDnCvo
+ created_at: '2021-10-29T23:24:03.114Z'
+ updated_at: '2021-10-29T23:24:03.114Z'
+ token: KAFYDF3GHYbSGZg2tJ52U9Ag
variant_included: false
relationships:
wished_items:
@@ -11034,9 +11035,9 @@ paths:
name: Birthday
is_private: true
is_default: false
- created_at: '2021-10-29T22:37:48.408Z'
- updated_at: '2021-10-29T22:37:48.408Z'
- token: caSdJP5i2tawwVYD19pY1Xuw
+ created_at: '2021-10-29T23:24:03.115Z'
+ updated_at: '2021-10-29T23:24:03.115Z'
+ token: iQDymaP6B3E2pBrZJtmExnpi
variant_included: false
relationships:
wished_items:
@@ -11098,9 +11099,9 @@ paths:
name: Wishlist_26
is_private: true
is_default: false
- created_at: '2021-10-29T22:37:48.872Z'
- updated_at: '2021-10-29T22:37:48.872Z'
- token: toYjZg66xS9vSXrKPHEXvTZE
+ created_at: '2021-10-29T23:24:03.617Z'
+ updated_at: '2021-10-29T23:24:03.617Z'
+ token: hNum8sii6F1y5cQF8RWQFLqw
variant_included: false
relationships:
wished_items:
@@ -11126,7 +11127,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/wishlist_params"
+ "$ref": "#/components/schemas/create_wishlist_params"
"/api/v2/platform/wishlists/{id}":
get:
summary: Return a Wishlist
@@ -11164,9 +11165,9 @@ paths:
name: My Wishlist
is_private: true
is_default: false
- created_at: '2021-10-29T22:37:48.908Z'
- updated_at: '2021-10-29T22:37:48.908Z'
- token: YKC9AoiAadpMHuAStGtvVSa7
+ created_at: '2021-10-29T23:24:03.666Z'
+ updated_at: '2021-10-29T23:24:03.666Z'
+ token: 92Emip5PUaPcJkA31ihpmniN
variant_included: false
relationships:
wished_items:
@@ -11229,9 +11230,9 @@ paths:
name: My Super Wishlist
is_private: true
is_default: false
- created_at: '2021-10-29T22:37:48.965Z'
- updated_at: '2021-10-29T22:37:48.973Z'
- token: zx6yPtKxrXZ1ootQj2HGLYkj
+ created_at: '2021-10-29T23:24:03.730Z'
+ updated_at: '2021-10-29T23:24:03.738Z'
+ token: UjJM2HCnGh3dGjrt8oSZPE7c
variant_included: false
relationships:
wished_items:
@@ -11275,7 +11276,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/wishlist_params"
+ "$ref": "#/components/schemas/update_wishlist_params"
delete:
summary: Delete a Wishlist
tags:
@@ -11351,7 +11352,7 @@ components:
type: http
scheme: bearer
schemas:
- address_params:
+ create_address_params:
type: object
properties:
address:
@@ -11408,7 +11409,56 @@ components:
required:
- address
x-internal: true
- adjustment_params:
+ update_address_params:
+ type: object
+ properties:
+ address:
+ type: object
+ properties:
+ country_id:
+ type: string
+ example: '224'
+ state_id:
+ type: string
+ example: '516'
+ state_name:
+ type: string
+ example: New York
+ address1:
+ type: string
+ example: 5th ave
+ address2:
+ type: string
+ example: 1st suite
+ city:
+ type: string
+ example: NY
+ zipcode:
+ type: string
+ example: '10001'
+ phone:
+ type: string
+ example: "+1 123 456 789"
+ alternative_phone:
+ type: string
+ firstname:
+ type: string
+ example: John
+ lastname:
+ type: string
+ example: Snow
+ label:
+ type: string
+ example: My home address
+ company:
+ type: string
+ example: Vendo Cloud Inc
+ user_id:
+ type: string
+ required:
+ - address
+ x-internal: true
+ create_adjustment_params:
type: object
properties:
adjustment:
@@ -11455,7 +11505,49 @@ components:
required:
- adjustment
x-internal: true
- classification_params:
+ update_adjustment_params:
+ type: object
+ properties:
+ adjustment:
+ type: object
+ properties:
+ order_id:
+ type: string
+ label:
+ type: string
+ example: Shipping costs
+ adjustable_id:
+ type: string
+ adjustable_type:
+ type: string
+ example: Spree::LineItem
+ source_id:
+ type: string
+ source_type:
+ type: string
+ example: Spree::TaxRate
+ amount:
+ type: number
+ example: 10.9
+ mandatory:
+ type: boolean
+ eligible:
+ type: boolean
+ state:
+ type: string
+ example: closed
+ default: open
+ enum:
+ - closed
+ - open
+ included:
+ type: boolean
+ example: true
+ default: false
+ required:
+ - adjustment
+ x-internal: true
+ create_classification_params:
type: object
properties:
classification:
@@ -11477,7 +11569,25 @@ components:
required:
- classification
x-internal: true
- cms_page_params:
+ update_classification_params:
+ type: object
+ properties:
+ classification:
+ type: object
+ properties:
+ product_id:
+ type: string
+ example: '1'
+ taxon_id:
+ type: string
+ example: '1'
+ position:
+ type: integer
+ example: 1
+ required:
+ - classification
+ x-internal: true
+ create_cms_page_params:
type: object
properties:
cms_page:
@@ -11503,7 +11613,30 @@ components:
required:
- cms_page
x-internal: true
- cms_section_params:
+ update_cms_page_params:
+ type: object
+ properties:
+ cms_page:
+ type: object
+ properties:
+ title:
+ type: string
+ meta_title:
+ type: string
+ content:
+ type: string
+ meta_description:
+ type: string
+ visible:
+ type: string
+ slug:
+ type: string
+ locale:
+ type: string
+ required:
+ - cms_page
+ x-internal: true
+ create_cms_section_params:
type: object
properties:
cms_section:
@@ -11527,6 +11660,27 @@ components:
required:
- cms_section
x-internal: true
+ update_cms_section_params:
+ type: object
+ properties:
+ cms_section:
+ type: object
+ properties:
+ name:
+ type: string
+ cms_page_id:
+ type: string
+ content:
+ type: object
+ settings:
+ type: object
+ fit:
+ type: string
+ destination:
+ type: string
+ required:
+ - cms_section
+ x-internal: true
cms_section_reposition_params:
type: object
properties:
@@ -11535,7 +11689,7 @@ components:
required:
- new_position_idx
x-internal: true
- digital_params:
+ create_digital_params:
type: object
properties:
digital[attachment]:
@@ -11548,15 +11702,46 @@ components:
- digital[attachment]
- digital[variant_id]
x-internal: true
- digital_link_params:
+ update_digital_params:
type: object
properties:
- digital_link:
- type: object
- required:
- - line_item_id
- - digital_id
- properties:
+ digital[attachment]:
+ type: string
+ format: binary
+ digital[variant_id]:
+ type: string
+ example: '123'
+ required:
+ - digital[attachment]
+ - digital[variant_id]
+ x-internal: true
+ create_digital_link_params:
+ type: object
+ properties:
+ digital_link:
+ type: object
+ required:
+ - line_item_id
+ - digital_id
+ properties:
+ access_counter:
+ type: integer
+ example: 0
+ line_item_id:
+ type: string
+ example: '1'
+ digital_id:
+ type: string
+ example: '1'
+ required:
+ - digital_link
+ x-internal: true
+ update_digital_link_params:
+ type: object
+ properties:
+ digital_link:
+ type: object
+ properties:
access_counter:
type: integer
example: 0
@@ -11569,7 +11754,7 @@ components:
required:
- digital_link
x-internal: true
- line_item_params:
+ create_line_item_params:
type: object
properties:
line_item:
@@ -11591,7 +11776,22 @@ components:
required:
- line_item
x-internal: true
- menu_params:
+ update_line_item_params:
+ type: object
+ properties:
+ line_item:
+ type: object
+ properties:
+ variant_id:
+ type: string
+ example: '1'
+ quantity:
+ type: integer
+ example: 2
+ required:
+ - line_item
+ x-internal: true
+ create_menu_params:
type: object
properties:
menu:
@@ -11610,7 +11810,22 @@ components:
required:
- menu
x-internal: true
- menu_item_params:
+ update_menu_params:
+ type: object
+ properties:
+ menu:
+ type: object
+ properties:
+ name:
+ type: string
+ location:
+ type: string
+ locale:
+ type: string
+ required:
+ - menu
+ x-internal: true
+ create_menu_item_params:
type: object
properties:
menu_item:
@@ -11640,6 +11855,33 @@ components:
required:
- menu_item
x-internal: true
+ update_menu_item_params:
+ type: object
+ properties:
+ menu_item:
+ type: object
+ 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:
@@ -11651,7 +11893,7 @@ components:
- new_parent_id
- new_position_idx
x-internal: true
- option_type_params:
+ create_option_type_params:
type: object
properties:
option_type:
@@ -11669,7 +11911,22 @@ components:
required:
- option_type
x-internal: true
- option_value_params:
+ update_option_type_params:
+ type: object
+ properties:
+ option_type:
+ type: object
+ properties:
+ name:
+ type: string
+ example: color
+ presentation:
+ type: string
+ example: Color
+ required:
+ - option_type
+ x-internal: true
+ create_option_value_params:
type: object
properties:
option_value:
@@ -11687,7 +11944,157 @@ components:
required:
- option_value
x-internal: true
- order_params:
+ update_option_value_params:
+ type: object
+ properties:
+ option_value:
+ type: object
+ properties:
+ name:
+ type: string
+ example: red
+ presentation:
+ type: string
+ example: Red
+ required:
+ - option_value
+ x-internal: true
+ create_order_params:
+ type: object
+ properties:
+ order:
+ type: object
+ properties:
+ item_total:
+ type: number
+ example: 170.9
+ total:
+ type: number
+ example: 190.9
+ state:
+ type: string
+ example: complete
+ enum:
+ - cart
+ - address
+ - delivery
+ - payment
+ - confirm
+ - complete
+ - canceled
+ adjustment_total:
+ type: number
+ example: 20.0
+ user_id:
+ type: string
+ example: '1'
+ completed_at:
+ type: string
+ format: date_time
+ example: 2021-10-29 23:23:29 UTC
+ bill_address_id:
+ type: string
+ example: '1'
+ ship_address_id:
+ type: string
+ example: '1'
+ payment_total:
+ type: number
+ example: 190.9
+ shipment_state:
+ type: string
+ example: shipped
+ enum:
+ - backorder
+ - canceled
+ - partial
+ - pending
+ - ready
+ - shipped
+ payment_state:
+ type: string
+ example: paid
+ enum:
+ - balance_due
+ - credit_owed
+ - failed
+ - paid
+ - void
+ email:
+ type: string
+ format: email
+ special_instructions:
+ type: string
+ example: I need it ASAP!
+ currency:
+ type: string
+ example: USD
+ last_ip_address:
+ type: string
+ example: 127.0.0.1
+ created_by_id:
+ type: string
+ example: '1'
+ shipment_total:
+ type: number
+ example: 10.0
+ additional_tax_total:
+ type: number
+ example: 10.0
+ promo_total:
+ type: number
+ example: 0.0
+ channel:
+ type: string
+ example: online
+ included_tax_total:
+ type: number
+ example: 0.0
+ item_count:
+ type: integer
+ example: 2
+ approver_id:
+ type: string
+ approved_at:
+ type: string
+ format: date_time
+ example: 2021-10-29 23:23:29 UTC
+ confirmation_delivered:
+ type: boolean
+ example: true
+ default: false
+ considered_risky:
+ type: boolean
+ example: true
+ default: false
+ canceled_at:
+ type: string
+ format: date_time
+ canceler_id:
+ type: string
+ taxable_adjustment_total:
+ type: number
+ example: 170.9
+ non_taxable_adjustment_total:
+ type: number
+ example: 10.0
+ store_owner_notification_delivered:
+ type: boolean
+ example: true
+ default: false
+ bill_address_attributes:
+ "$ref": "#/components/schemas/update_address_params"
+ ship_address_attributes:
+ "$ref": "#/components/schemas/update_address_params"
+ line_items_attributes:
+ type: array
+ items:
+ "$ref": "#/components/schemas/update_line_item_params"
+ required:
+ - order
+ x-internal: true
+ update_order_params:
type: object
properties:
order:
@@ -11719,7 +12126,7 @@ components:
completed_at:
type: string
format: date_time
- example: 2021-10-29 22:37:15 UTC
+ example: 2021-10-29 23:23:29 UTC
bill_address_id:
type: string
example: '1'
@@ -11787,7 +12194,7 @@ components:
approved_at:
type: string
format: date_time
- example: 2021-10-29 22:37:15 UTC
+ example: 2021-10-29 23:23:29 UTC
confirmation_delivered:
type: boolean
example: true
@@ -11812,17 +12219,17 @@ components:
example: true
default: false
bill_address_attributes:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/update_address_params"
ship_address_attributes:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/update_address_params"
line_items_attributes:
type: array
items:
- "$ref": "#/components/schemas/line_item_params"
+ "$ref": "#/components/schemas/update_line_item_params"
required:
- order
x-internal: true
- product_params:
+ create_product_params:
type: object
properties:
product:
@@ -11881,7 +12288,62 @@ components:
required:
- product
x-internal: true
- promotion_category_params:
+ update_product_params:
+ type: object
+ properties:
+ product:
+ type: object
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ available_on:
+ type: string
+ discontinue_on:
+ type: string
+ permalink:
+ type: string
+ meta_description:
+ type: string
+ meta_keywords:
+ type: string
+ price:
+ type: string
+ sku:
+ type: string
+ deleted_at:
+ type: string
+ prototype_id:
+ type: string
+ option_values_hash:
+ type: string
+ weight:
+ type: string
+ height:
+ type: string
+ width:
+ type: string
+ depth:
+ type: string
+ shipping_category_id:
+ type: string
+ tax_category_id:
+ type: string
+ cost_currency:
+ type: string
+ cost_price:
+ type: string
+ compare_at_price:
+ type: string
+ option_type_ids:
+ type: string
+ taxon_ids:
+ type: string
+ required:
+ - product
+ x-internal: true
+ create_promotion_category_params:
type: object
properties:
promotion_category:
@@ -11898,7 +12360,38 @@ components:
required:
- promotion_category
x-internal: true
- shipping_category_params:
+ update_promotion_category_params:
+ type: object
+ properties:
+ promotion_category:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: Promotions Used in 2021
+ code:
+ type: string
+ example: 2021-PROMOS
+ required:
+ - promotion_category
+ x-internal: true
+ create_shipping_category_params:
+ type: object
+ properties:
+ shipping_category:
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ example: Another Category
+ required:
+ - shipping_category
+ x-internal: true
+ update_shipping_category_params:
type: object
properties:
shipping_category:
@@ -11912,7 +12405,7 @@ components:
required:
- shipping_category
x-internal: true
- shipping_method_params:
+ create_shipping_method_params:
type: object
properties:
shipping_method:
@@ -11955,6 +12448,45 @@ components:
required:
- shipping_method
x-internal: true
+ update_shipping_method_params:
+ type: object
+ properties:
+ shipping_method:
+ type: object
+ properties:
+ name:
+ type: string
+ example: DHL Express
+ admin_name:
+ type: string
+ example: DHL Area Code D
+ code:
+ type: string
+ example: DHL-A-D
+ tracking_url:
+ type: string
+ example: dhlexpress.com?tracking=
+ display_on:
+ type: string
+ example: both
+ enum:
+ - both
+ - back_end
+ - front_end
+ tax_category_id:
+ type: string
+ example: '1'
+ shipping_category_ids:
+ type: array
+ items:
+ allOf:
+ - type: string
+ example: '2'
+ calculator_attributes:
+ "$ref": "#/components/schemas/shipping_calculator_params"
+ required:
+ - shipping_method
+ x-internal: true
shipping_calculator_params:
type: object
properties:
@@ -11971,7 +12503,7 @@ components:
required:
- type
x-internal: true
- taxon_params:
+ create_taxon_params:
type: object
properties:
taxon:
@@ -11989,7 +12521,22 @@ components:
required:
- taxon
x-internal: true
- user_params:
+ update_taxon_params:
+ type: object
+ properties:
+ taxon:
+ type: object
+ properties:
+ taxonomy_id:
+ type: string
+ parent_id:
+ type: string
+ name:
+ type: string
+ required:
+ - taxon
+ x-internal: true
+ create_user_params:
type: object
properties:
user:
@@ -12012,7 +12559,26 @@ components:
required:
- user
x-internal: true
- webhook_subscriber_params:
+ update_user_params:
+ type: object
+ properties:
+ user:
+ type: object
+ 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
+ create_webhook_subscriber_params:
type: object
properties:
subscriber:
@@ -12041,7 +12607,36 @@ components:
required:
- subscriber
x-internal: true
- wishlist_params:
+ update_webhook_subscriber_params:
+ type: object
+ properties:
+ subscriber:
+ type: object
+ required:
+ - url
+ 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:
+ type: string
+ example: https://www.url.com/
+ required:
+ - subscriber
+ x-internal: true
+ create_wishlist_params:
type: object
properties:
wishlist:
@@ -12061,7 +12656,44 @@ components:
required:
- wishlist
x-internal: true
- wished_item_params:
+ update_wishlist_params:
+ type: object
+ properties:
+ wishlist:
+ type: object
+ properties:
+ name:
+ type: string
+ user_id:
+ type: string
+ is_default:
+ type: boolean
+ is_private:
+ type: boolean
+ required:
+ - wishlist
+ x-internal: true
+ create_wished_item_params:
+ type: object
+ properties:
+ wished_item:
+ type: object
+ required:
+ - wishlist_id
+ - variant_id
+ - quantity
+ properties:
+ wishlist_id:
+ type: string
+ variant_id:
+ type: string
+ quantity:
+ type: integer
+ description: Must be an integer greater than 0
+ required:
+ - wished_item
+ x-internal: true
+ update_wished_item_params:
type: object
properties:
wished_item:
diff --git a/api/lib/spree/api/testing_support/v2/platform_contexts.rb b/api/lib/spree/api/testing_support/v2/platform_contexts.rb
index e60c406b1e..feed6bc7f2 100644
--- a/api/lib/spree/api/testing_support/v2/platform_contexts.rb
+++ b/api/lib/spree/api/testing_support/v2/platform_contexts.rb
@@ -1,6 +1,10 @@
class String
def articleize
- %w(a e i o u).include?(self[0].downcase) ? "an #{self}" : "a #{self}"
+ if self.split.first == 'User'
+ "a #{self}"
+ else
+ %w(a e i o u).include?(self[0].downcase) ? "an #{self}" : "a #{self}"
+ end
end
end
@@ -177,7 +181,7 @@ shared_examples 'POST create record' do |resource_name, **options|
security [ bearer_auth: [] ]
description "Creates #{endpoint_name.articleize}"
operationId "create-#{resource_name.parameterize.to_sym}"
- parameter name: param_name, in: request_data_type, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
+ parameter name: param_name, in: request_data_type, schema: { '$ref' => "#/components/schemas/create_#{param_name}_params" }
json_api_include_parameter(options[:include_example]) unless options[:include_example].nil?
let(param_name) { valid_create_param_value }
@@ -206,7 +210,7 @@ shared_examples 'PATCH update record' do |resource_name, **options|
operationId "update-#{resource_name.parameterize.to_sym}"
consumes consumes_kind
parameter name: :id, in: :path, type: :string
- parameter name: param_name, in: request_data_type, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
+ parameter name: param_name, in: request_data_type, schema: { '$ref' => "#/components/schemas/update_#{param_name}_params" }
json_api_include_parameter(options[:include_example]) unless options[:include_example].nil?
let(param_name) { valid_update_param_value }
diff --git a/api/spec/integration/api/v2/platform/classifications_spec.rb b/api/spec/integration/api/v2/platform/classifications_spec.rb
index c2919d39fa..f2b03444c1 100644
--- a/api/spec/integration/api/v2/platform/classifications_spec.rb
+++ b/api/spec/integration/api/v2/platform/classifications_spec.rb
@@ -35,7 +35,7 @@ describe 'Classifications API', swagger: true do
description 'Reposition a Classification'
consumes 'application/json'
parameter name: :id, in: :path, type: :string
- parameter name: :classification, in: :body, schema: { '$ref' => '#/components/schemas/classification_params' }
+ parameter name: :classification, in: :body, schema: { '$ref' => '#/components/schemas/update_classification_params' }
json_api_include_parameter(options[:include_example])
let(:classification) { valid_update_param_value }
diff --git a/api/spec/integration/api/v2/platform/orders_spec.rb b/api/spec/integration/api/v2/platform/orders_spec.rb
index c009959950..7abc594b3a 100644
--- a/api/spec/integration/api/v2/platform/orders_spec.rb
+++ b/api/spec/integration/api/v2/platform/orders_spec.rb
@@ -65,7 +65,7 @@ describe 'Orders API', swagger: true do
security [ bearer_auth: [] ]
description "Creates #{resource_name.articleize}"
operationId "create-#{resource_name.parameterize.to_sym}"
- parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
+ parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/create_#{param_name}_params" }
json_api_include_parameter(options[:include_example])
let(param_name) { valid_create_param_value }
diff --git a/api/spec/swagger_helper.rb b/api/spec/swagger_helper.rb
index 2cbcadf503..a4e4cd3b76 100644
--- a/api/spec/swagger_helper.rb
+++ b/api/spec/swagger_helper.rb
@@ -77,7 +77,7 @@ RSpec.configure do |config|
schemas: {
# Address
- address_params: {
+ create_address_params: {
type: :object,
properties: {
address: {
@@ -104,9 +104,35 @@ RSpec.configure do |config|
required: %w[address],
'x-internal': true
},
+ update_address_params: {
+ type: :object,
+ properties: {
+ address: {
+ type: :object,
+ properties: {
+ country_id: { type: :string, example: '224' },
+ state_id: { type: :string, example: '516' },
+ state_name: { type: :string, example: 'New York' },
+ address1: { type: :string, example: '5th ave' },
+ address2: { type: :string, example: '1st suite' },
+ city: { type: :string, example: 'NY' },
+ zipcode: { type: :string, example: '10001' },
+ phone: { type: :string, example: '+1 123 456 789' },
+ alternative_phone: { type: :string },
+ firstname: { type: :string, example: 'John' },
+ lastname: { type: :string, example: 'Snow' },
+ label: { type: :string, example: 'My home address' },
+ company: { type: :string, example: 'Vendo Cloud Inc' },
+ user_id: { type: :string }
+ }
+ }
+ },
+ required: %w[address],
+ 'x-internal': true
+ },
# Adjustment
- adjustment_params: {
+ create_adjustment_params: {
type: :object,
properties: {
adjustment: {
@@ -130,9 +156,32 @@ RSpec.configure do |config|
required: %w[adjustment],
'x-internal': true
},
+ update_adjustment_params: {
+ type: :object,
+ properties: {
+ adjustment: {
+ type: :object,
+ properties: {
+ order_id: { type: :string },
+ label: { type: :string, example: 'Shipping costs' },
+ adjustable_id: { type: :string },
+ adjustable_type: { type: :string, example: 'Spree::LineItem' },
+ source_id: { type: :string },
+ source_type: { type: :string, example: 'Spree::TaxRate' },
+ amount: { type: :number, example: 10.90 },
+ mandatory: { type: :boolean },
+ eligible: { type: :boolean },
+ state: { type: :string, example: 'closed', default: 'open', enum: ['closed', 'open'] },
+ included: { type: :boolean, example: true, default: false },
+ }
+ }
+ },
+ required: %w[adjustment],
+ 'x-internal': true
+ },
# Classification
- classification_params: {
+ create_classification_params: {
type: :object,
properties: {
classification: {
@@ -148,9 +197,24 @@ RSpec.configure do |config|
required: %w[classification],
'x-internal': true
},
+ update_classification_params: {
+ type: :object,
+ properties: {
+ classification: {
+ type: :object,
+ properties: {
+ product_id: { type: :string, example: '1' },
+ taxon_id: { type: :string, example: '1' },
+ position: { type: :integer, example: 1 }
+ }
+ }
+ },
+ required: %w[classification],
+ 'x-internal': true
+ },
# CMS Page
- cms_page_params: {
+ create_cms_page_params: {
type: :object,
properties: {
cms_page: {
@@ -170,9 +234,28 @@ RSpec.configure do |config|
required: %w[cms_page],
'x-internal': true
},
+ update_cms_page_params: {
+ type: :object,
+ properties: {
+ cms_page: {
+ type: :object,
+ properties: {
+ title: { type: :string },
+ meta_title: { type: :string },
+ content: { type: :string, },
+ meta_description: { type: :string },
+ visible: { type: :string },
+ slug: { type: :string },
+ locale: { type: :string }
+ }
+ }
+ },
+ required: %w[cms_page],
+ 'x-internal': true
+ },
# CMS Section
- cms_section_params: {
+ create_cms_section_params: {
type: :object,
properties: {
cms_section: {
@@ -191,6 +274,24 @@ RSpec.configure do |config|
required: %w[cms_section],
'x-internal': true
},
+ update_cms_section_params: {
+ type: :object,
+ properties: {
+ cms_section: {
+ type: :object,
+ properties: {
+ name: { type: :string },
+ cms_page_id: { type: :string },
+ content: { type: :object, },
+ settings: { type: :object },
+ fit: { type: :string },
+ destination: { type: :string }
+ }
+ }
+ },
+ required: %w[cms_section],
+ 'x-internal': true
+ },
cms_section_reposition_params: {
type: :object,
properties: {
@@ -201,7 +302,16 @@ RSpec.configure do |config|
},
# Digital
- digital_params: {
+ create_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
+ },
+ update_digital_params: {
type: :object,
properties: {
'digital[attachment]': { type: :string, format: :binary },
@@ -212,7 +322,7 @@ RSpec.configure do |config|
},
# Digital Link
- digital_link_params: {
+ create_digital_link_params: {
type: :object,
properties: {
digital_link: {
@@ -228,9 +338,24 @@ RSpec.configure do |config|
required: %w[digital_link],
'x-internal': true
},
+ update_digital_link_params: {
+ type: :object,
+ properties: {
+ digital_link: {
+ type: :object,
+ properties: {
+ access_counter: { type: :integer, example: 0 },
+ line_item_id: { type: :string, example: '1' },
+ digital_id: { type: :string, example: '1' }
+ }
+ }
+ },
+ required: %w[digital_link],
+ 'x-internal': true
+ },
# Line Item
- line_item_params: {
+ create_line_item_params: {
type: :object,
properties: {
line_item: {
@@ -246,9 +371,24 @@ RSpec.configure do |config|
required: %w[line_item],
'x-internal': true
},
+ # TODO: Check these are correct.
+ update_line_item_params: {
+ type: :object,
+ properties: {
+ line_item: {
+ type: :object,
+ properties: {
+ variant_id: { type: :string, example: '1' },
+ quantity: { type: :integer, example: 2 }
+ }
+ }
+ },
+ required: %w[line_item],
+ 'x-internal': true
+ },
# Menu
- menu_params: {
+ create_menu_params: {
type: :object,
properties: {
menu: {
@@ -264,9 +404,24 @@ RSpec.configure do |config|
required: %w[menu],
'x-internal': true
},
+ update_menu_params: {
+ type: :object,
+ properties: {
+ menu: {
+ type: :object,
+ properties: {
+ name: { type: :string },
+ location: { type: :string },
+ locale: { type: :string }
+ }
+ }
+ },
+ required: %w[menu],
+ 'x-internal': true
+ },
# Menu Item
- menu_item_params: {
+ create_menu_item_params: {
type: :object,
properties: {
menu_item: {
@@ -288,7 +443,27 @@ RSpec.configure do |config|
required: %w[menu_item],
'x-internal': true
},
-
+ update_menu_item_params: {
+ type: :object,
+ properties: {
+ menu_item: {
+ type: :object,
+ 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: %w[menu_item],
+ 'x-internal': true
+ },
menu_item_reposition_params: {
type: :object,
properties: {
@@ -300,7 +475,7 @@ RSpec.configure do |config|
},
# Option Type
- option_type_params: {
+ create_option_type_params: {
type: :object,
properties: {
option_type: {
@@ -315,9 +490,23 @@ RSpec.configure do |config|
required: %w[option_type],
'x-internal': true
},
+ update_option_type_params: {
+ type: :object,
+ properties: {
+ option_type: {
+ type: :object,
+ properties: {
+ name: { type: :string, example: 'color' },
+ presentation: { type: :string, example: 'Color' }
+ }
+ }
+ },
+ required: %w[option_type],
+ 'x-internal': true
+ },
# Option Value
- option_value_params: {
+ create_option_value_params: {
type: :object,
properties: {
option_value: {
@@ -332,9 +521,23 @@ RSpec.configure do |config|
required: %w[option_value],
'x-internal': true
},
+ update_option_value_params: {
+ type: :object,
+ properties: {
+ option_value: {
+ type: :object,
+ properties: {
+ name: { type: :string, example: 'red' },
+ presentation: { type: :string, example: 'Red' }
+ }
+ }
+ },
+ required: %w[option_value],
+ 'x-internal': true
+ },
# Order
- order_params: {
+ create_order_params: {
type: :object,
properties: {
order: {
@@ -371,11 +574,60 @@ RSpec.configure do |config|
taxable_adjustment_total: { type: :number, example: 170.90 },
non_taxable_adjustment_total: { type: :number, example: 10.0 },
store_owner_notification_delivered: { type: :boolean, example: true, default: false },
- bill_address_attributes: { '$ref': '#/components/schemas/address_params' },
- ship_address_attributes: { '$ref': '#/components/schemas/address_params' },
+ bill_address_attributes: { '$ref': '#/components/schemas/update_address_params' },
+ ship_address_attributes: { '$ref': '#/components/schemas/update_address_params' },
line_items_attributes: {
type: :array,
- items: { '$ref': '#/components/schemas/line_item_params' }
+ items: { '$ref': '#/components/schemas/update_line_item_params' }
+ }
+ }
+ }
+ },
+ required: %w[order],
+ 'x-internal': true
+ },
+ update_order_params: {
+ type: :object,
+ properties: {
+ order: {
+ type: :object,
+ properties: {
+ item_total: { type: :number, example: 170.90 },
+ total: { type: :number, example: 190.90 },
+ state: { type: :string, example: 'complete', enum: %w[cart address delivery payment confirm complete canceled] },
+ adjustment_total: { type: :number, example: 20.0 },
+ user_id: { type: :string, example: '1' },
+ completed_at: { type: :string, format: :date_time, example: Time.current },
+ bill_address_id: { type: :string, example: '1' },
+ ship_address_id: { type: :string, example: '1' },
+ payment_total: { type: :number, example: 190.90 },
+ shipment_state: { type: :string, example: 'shipped', enum: Spree::Order::SHIPMENT_STATES },
+ payment_state: { type: :string, example: 'paid', enum: Spree::Order::PAYMENT_STATES },
+ email: { type: :string, format: :email, example: '[email protected]' },
+ special_instructions: { type: :string, example: 'I need it ASAP!' },
+ currency: { type: :string, example: 'USD' },
+ last_ip_address: { type: :string, example: '127.0.0.1' },
+ created_by_id: { type: :string, example: '1' },
+ shipment_total: { type: :number, example: 10.0 },
+ additional_tax_total: { type: :number, example: 10.0 },
+ promo_total: { type: :number, example: 0.0 },
+ channel: { type: :string, example: 'online' },
+ included_tax_total: { type: :number, example: 0.0 },
+ item_count: { type: :integer, example: 2 },
+ approver_id: { type: :string },
+ approved_at: { type: :string, format: :date_time, example: Time.current },
+ confirmation_delivered: { type: :boolean, example: true, default: false },
+ considered_risky: { type: :boolean, example: true, default: false },
+ canceled_at: { type: :string, format: :date_time },
+ canceler_id: { type: :string },
+ taxable_adjustment_total: { type: :number, example: 170.90 },
+ non_taxable_adjustment_total: { type: :number, example: 10.0 },
+ store_owner_notification_delivered: { type: :boolean, example: true, default: false },
+ bill_address_attributes: { '$ref': '#/components/schemas/update_address_params' },
+ ship_address_attributes: { '$ref': '#/components/schemas/update_address_params' },
+ line_items_attributes: {
+ type: :array,
+ items: { '$ref': '#/components/schemas/update_line_item_params' }
}
}
}
@@ -385,7 +637,7 @@ RSpec.configure do |config|
},
# Product
- product_params: {
+ create_product_params: {
type: :object,
properties: {
product: {
@@ -421,9 +673,59 @@ RSpec.configure do |config|
required: %w[product],
'x-internal': true
},
+ update_product_params: {
+ type: :object,
+ properties: {
+ product: {
+ type: :object,
+ properties: {
+ name: { type: :string },
+ description: { type: :string },
+ available_on: { type: :string },
+ discontinue_on: { type: :string },
+ permalink: { type: :string },
+ meta_description: { type: :string },
+ meta_keywords: { type: :string },
+ price: { type: :string },
+ sku: { type: :string },
+ deleted_at: { type: :string },
+ prototype_id: { type: :string },
+ option_values_hash: { type: :string },
+ weight: { type: :string },
+ height: { type: :string },
+ width: { type: :string },
+ depth: { type: :string },
+ shipping_category_id: { type: :string },
+ tax_category_id: { type: :string },
+ cost_currency: { type: :string },
+ cost_price: { type: :string },
+ compare_at_price: { type: :string },
+ option_type_ids: { type: :string },
+ taxon_ids: { type: :string }
+ }
+ }
+ },
+ required: %w[product],
+ 'x-internal': true
+ },
# Promotion Category
- promotion_category_params: {
+ create_promotion_category_params: {
+ type: :object,
+ properties: {
+ promotion_category: {
+ type: :object,
+ required: %w[name],
+ properties: {
+ name: { type: :string, example: 'Promotions Used in 2021' },
+ code: { type: :string, example: '2021-PROMOS' }
+ }
+ }
+ },
+ required: %w[promotion_category],
+ 'x-internal': true
+ },
+ update_promotion_category_params: {
type: :object,
properties: {
promotion_category: {
@@ -440,7 +742,21 @@ RSpec.configure do |config|
},
# Shipping Category
- shipping_category_params: {
+ create_shipping_category_params: {
+ type: :object,
+ properties: {
+ shipping_category: {
+ type: :object,
+ required: %w[name],
+ properties: {
+ name: { type: :string, example: 'Another Category' }
+ }
+ }
+ },
+ required: %w[shipping_category],
+ 'x-internal': true
+ },
+ update_shipping_category_params: {
type: :object,
properties: {
shipping_category: {
@@ -456,7 +772,7 @@ RSpec.configure do |config|
},
# Shipping Method
- shipping_method_params: {
+ create_shipping_method_params: {
type: :object,
properties: {
shipping_method: {
@@ -484,6 +800,33 @@ RSpec.configure do |config|
required: %w[shipping_method],
'x-internal': true
},
+ update_shipping_method_params: {
+ type: :object,
+ properties: {
+ shipping_method: {
+ type: :object,
+ properties: {
+ name: { type: :string, example: 'DHL Express' },
+ admin_name: { type: :string, example: 'DHL Area Code D' },
+ code: { type: :string, example: 'DHL-A-D' },
+ tracking_url: { type: :string, example: 'dhlexpress.com?tracking=' },
+ display_on: { type: :string, example: 'both', enum: ['both', 'back_end', 'front_end'] },
+ tax_category_id: { type: :string, example: '1' },
+ shipping_category_ids: {
+ type: :array,
+ items: {
+ allOf: [
+ { type: :string, example: '2' }
+ ]
+ }
+ },
+ calculator_attributes: { '$ref': '#/components/schemas/shipping_calculator_params' },
+ }
+ }
+ },
+ required: %w[shipping_method],
+ 'x-internal': true
+ },
shipping_calculator_params: {
type: :object,
properties: {
@@ -494,7 +837,7 @@ RSpec.configure do |config|
},
# Taxon
- taxon_params: {
+ create_taxon_params: {
type: :object,
properties: {
taxon: {
@@ -510,9 +853,24 @@ RSpec.configure do |config|
required: %w[taxon],
'x-internal': true
},
+ update_taxon_params: {
+ type: :object,
+ properties: {
+ taxon: {
+ type: :object,
+ properties: {
+ taxonomy_id: { type: :string },
+ parent_id: { type: :string },
+ name: { type: :string }
+ }
+ }
+ },
+ required: %w[taxon],
+ 'x-internal': true
+ },
# User
- user_params: {
+ create_user_params: {
type: :object,
properties: {
user: {
@@ -530,9 +888,51 @@ RSpec.configure do |config|
required: %w[user],
'x-internal': true
},
+ update_user_params: {
+ type: :object,
+ properties: {
+ user: {
+ type: :object,
+ properties: {
+ email: { type: :string },
+ password: { type: :string },
+ password_confirmation: { type: :string },
+ ship_address_id: { type: :string },
+ bill_address_id: { type: :string },
+ }
+ }
+ },
+ required: %w[user],
+ 'x-internal': true
+ },
# Webhook
- webhook_subscriber_params: {
+ create_webhook_subscriber_params: {
+ type: :object,
+ properties: {
+ subscriber: {
+ type: :object,
+ required: %w[url],
+ 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: { type: :string, example: 'https://www.url.com/' }
+ }
+ }
+ },
+ required: %w[subscriber],
+ 'x-internal': true
+ },
+ update_webhook_subscriber_params: {
type: :object,
properties: {
subscriber: {
@@ -559,7 +959,7 @@ RSpec.configure do |config|
},
# Wishlist
- wishlist_params: {
+ create_wishlist_params: {
type: :object,
properties: {
wishlist: {
@@ -576,9 +976,44 @@ RSpec.configure do |config|
required: %w[wishlist],
'x-internal': true
},
+ update_wishlist_params: {
+ type: :object,
+ properties: {
+ wishlist: {
+ type: :object,
+ properties: {
+ name: { type: :string },
+ user_id: { type: :string },
+ is_default: { type: :boolean },
+ is_private: { type: :boolean }
+ }
+ }
+ },
+ required: %w[wishlist],
+ 'x-internal': true
+ },
# Wished Item
- wished_item_params: {
+ create_wished_item_params: {
+ type: :object,
+ properties: {
+ wished_item: {
+ type: :object,
+ required: %w[wishlist_id variant_id quantity],
+ properties: {
+ wishlist_id: { type: :string },
+ variant_id: { type: :string },
+ quantity: {
+ type: :integer,
+ description: 'Must be an integer greater than 0'
+ }
+ }
+ }
+ },
+ required: %w[wished_item],
+ 'x-internal': true
+ },
+ update_wished_item_params: {
type: :object,
properties: {
wished_item: {