From 3f2ab7dd2971ee3625985467db7548aab3916a14 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Fri, 15 Sep 2023 15:03:18 -0500 Subject: [PATCH 01/14] Add plugin to redirect 2.3 pages --- _plugins/page-params/redirect_23.rb | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 _plugins/page-params/redirect_23.rb diff --git a/_plugins/page-params/redirect_23.rb b/_plugins/page-params/redirect_23.rb new file mode 100644 index 00000000000..0905968dd14 --- /dev/null +++ b/_plugins/page-params/redirect_23.rb @@ -0,0 +1,42 @@ +# Copyright 2023 Adobe +# All Rights Reserved. +# +# NOTICE: All information contained herein is, and remains +# the property of Adobe and its suppliers, if any. The intellectual +# and technical concepts contained herein are proprietary to Adobe +# and its suppliers and are protected by all applicable intellectual +# property laws, including trade secret and copyright laws. +# Dissemination of this information or reproduction of this material +# is strictly forbidden + +# This plugin redirects 2.3 pages to the DevSite. +# It uses redirect metadata from the 2.4 version of the page. +# If there is no 2.4 version of the page, then it redirects to https://developer.adobe.com/commerce/docs/ + +Jekyll::Hooks.register :pages, :post_init do |page| + # Skip pages where the parameter is already set + next unless page.path.start_with? 'guides/v2.3/' + + # Process only files with 'md' and 'html' extensions + next unless File.extname(page.path).match?(/md|html/) + + # Skip redirects + next if page.name == 'redirect.html' + + # Skip pages where the parameter is already set + next if page.data['redirect_to'] + + pages = page.site.pages + + path_23 = page.path + + path_24 = path_23.sub('/v2.3/', '/v2.4/') + + page_24 = pages.find { |page| page.path == path_24 } + + if page_24.nil? + page.data['redirect_to'] = 'https://developer.adobe.com/commerce/docs/' + else + page.data['redirect_to'] = page_24.data['redirect_to'] + end +end From c760634283d2285127b51be1ba4d7a1a0347c947 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Fri, 15 Sep 2023 15:34:32 -0500 Subject: [PATCH 02/14] Linting fixes --- _plugins/page-params/redirect_23.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_plugins/page-params/redirect_23.rb b/_plugins/page-params/redirect_23.rb index 0905968dd14..b938ff57049 100644 --- a/_plugins/page-params/redirect_23.rb +++ b/_plugins/page-params/redirect_23.rb @@ -1,6 +1,6 @@ # Copyright 2023 Adobe # All Rights Reserved. -# +# # NOTICE: All information contained herein is, and remains # the property of Adobe and its suppliers, if any. The intellectual # and technical concepts contained herein are proprietary to Adobe @@ -13,6 +13,8 @@ # It uses redirect metadata from the 2.4 version of the page. # If there is no 2.4 version of the page, then it redirects to https://developer.adobe.com/commerce/docs/ +# frozen_string_literal: true + Jekyll::Hooks.register :pages, :post_init do |page| # Skip pages where the parameter is already set next unless page.path.start_with? 'guides/v2.3/' From 8d99763745674d4398a7ba8b4f0277269fbdc7f9 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Fri, 15 Sep 2023 15:47:48 -0500 Subject: [PATCH 03/14] Linting fixes --- _plugins/page-params/redirect_23.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_plugins/page-params/redirect_23.rb b/_plugins/page-params/redirect_23.rb index b938ff57049..0cb20fd157b 100644 --- a/_plugins/page-params/redirect_23.rb +++ b/_plugins/page-params/redirect_23.rb @@ -35,7 +35,7 @@ path_24 = path_23.sub('/v2.3/', '/v2.4/') page_24 = pages.find { |page| page.path == path_24 } - + if page_24.nil? page.data['redirect_to'] = 'https://developer.adobe.com/commerce/docs/' else From c0e595deed8907e64e56d399e6513c810bc4e7e5 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Mon, 25 Sep 2023 17:09:13 -0500 Subject: [PATCH 04/14] Use site post_read hook --- _plugins/page-params/redirect_23.rb | 37 ++++++++++++++++------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/_plugins/page-params/redirect_23.rb b/_plugins/page-params/redirect_23.rb index 0cb20fd157b..7014e30c753 100644 --- a/_plugins/page-params/redirect_23.rb +++ b/_plugins/page-params/redirect_23.rb @@ -15,30 +15,33 @@ # frozen_string_literal: true -Jekyll::Hooks.register :pages, :post_init do |page| - # Skip pages where the parameter is already set - next unless page.path.start_with? 'guides/v2.3/' +Jekyll::Hooks.register :site, :post_read do |site| + pages = site.pages - # Process only files with 'md' and 'html' extensions - next unless File.extname(page.path).match?(/md|html/) + pages.each do |page| + # Skip pages where the parameter is already set + next unless page.path.start_with? 'guides/v2.3/' - # Skip redirects - next if page.name == 'redirect.html' + # Process only files with 'md' and 'html' extensions + next unless File.extname(page.path).match?(/md|html/) - # Skip pages where the parameter is already set - next if page.data['redirect_to'] + # Skip redirects + next if page.name == 'redirect.html' - pages = page.site.pages + # Skip pages where the parameter is already set + next if page.data['redirect_to'] - path_23 = page.path + path_23 = page.path - path_24 = path_23.sub('/v2.3/', '/v2.4/') + path_24 = path_23.sub('v2.3', 'v2.4') + puts 'path_24: ' + path_24 - page_24 = pages.find { |page| page.path == path_24 } + page_24 = pages.find { |page| page.path == path_24 } - if page_24.nil? - page.data['redirect_to'] = 'https://developer.adobe.com/commerce/docs/' - else - page.data['redirect_to'] = page_24.data['redirect_to'] + if page_24.nil? + page.data['redirect_to'] = 'https://developer.adobe.com/commerce/docs/' + else + page.data['redirect_to'] = page_24.data['redirect_to'] + end end end From ccb1c543cc2a12c59488a0fe48176aa96f874948 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Tue, 26 Sep 2023 11:25:00 -0500 Subject: [PATCH 05/14] Delete redundant test --- _plugins/page-params/redirect_23.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/_plugins/page-params/redirect_23.rb b/_plugins/page-params/redirect_23.rb index 7014e30c753..4636ab5e805 100644 --- a/_plugins/page-params/redirect_23.rb +++ b/_plugins/page-params/redirect_23.rb @@ -34,7 +34,6 @@ path_23 = page.path path_24 = path_23.sub('v2.3', 'v2.4') - puts 'path_24: ' + path_24 page_24 = pages.find { |page| page.path == path_24 } From cbae8b89024654646c7f5808e2a23e002c035a5a Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Tue, 26 Sep 2023 11:25:24 -0500 Subject: [PATCH 06/14] Redirect the home page --- src/index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/src/index.html b/src/index.html index 6e434afb834..32fe5d1cf56 100644 --- a/src/index.html +++ b/src/index.html @@ -2,6 +2,7 @@ layout: home redirect_from: /guides/v2.4/ guide_version: '2.4' +redirect_to: https://developer.adobe.com/commerce/docs/ ---
From 4c60351ee597bfe7482952b10eadca34696aad0d Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Fri, 13 Oct 2023 17:39:46 -0500 Subject: [PATCH 07/14] Redirect MFTF v2 and 404 --- Docfile.yml | 2 +- _plugins/page-params/redirect_mftf_v2.rb | 30 ++++++++++++++++++++++++ src/404.md | 1 + 3 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 _plugins/page-params/redirect_mftf_v2.rb diff --git a/Docfile.yml b/Docfile.yml index 610a3cbf342..6b93f68f76a 100644 --- a/Docfile.yml +++ b/Docfile.yml @@ -12,7 +12,7 @@ content_map: filter: true - directory: src/mftf/v2 - repository: magento/magento2-functional-testing-framework + repository: commerce-docs/magento2-functional-testing-framework-public branch: 2.x-develop filter: true - diff --git a/_plugins/page-params/redirect_mftf_v2.rb b/_plugins/page-params/redirect_mftf_v2.rb new file mode 100644 index 00000000000..daf386013dc --- /dev/null +++ b/_plugins/page-params/redirect_mftf_v2.rb @@ -0,0 +1,30 @@ +# Copyright 2023 Adobe +# All Rights Reserved. +# +# NOTICE: All information contained herein is, and remains +# the property of Adobe and its suppliers, if any. The intellectual +# and technical concepts contained herein are proprietary to Adobe +# and its suppliers and are protected by all applicable intellectual +# property laws, including trade secret and copyright laws. +# Dissemination of this information or reproduction of this material +# is strictly forbidden + +# This plugin redirects 2.3 pages to the DevSite. +# It uses redirect metadata from the 2.4 version of the page. +# If there is no 2.4 version of the page, then it redirects to https://developer.adobe.com/commerce/docs/ + +# frozen_string_literal: true + +Jekyll::Hooks.register :site, :post_read do |site| + pages = site.pages + + pages.each do |page| + # Skip pages where the parameter is already set + next unless page.path.start_with? 'mftf/v2' + + # Process only files with 'md' and 'html' extensions + next unless File.extname(page.path).match?(/md/) + + page.data['redirect_to'] = "https://github.com/magento/magento2-functional-testing-framework/blob/2.x-develop/#{page.path.delete_prefix('mftf/v2/')}" + end +end diff --git a/src/404.md b/src/404.md index 3302aabccb7..0cf8c777b08 100644 --- a/src/404.md +++ b/src/404.md @@ -2,6 +2,7 @@ layout: full-width title: Page Not Found permalink: /404.html +redirect_to: https://developer.adobe.com/commerce/docs/ --- ## Sorry! From ff9e865ceb8574f7473f2a193308520d56734e88 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Fri, 13 Oct 2023 17:49:16 -0500 Subject: [PATCH 08/14] Add plugin docs --- _plugins/page-params/redirect_mftf_v2.rb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/_plugins/page-params/redirect_mftf_v2.rb b/_plugins/page-params/redirect_mftf_v2.rb index daf386013dc..7427ea2d931 100644 --- a/_plugins/page-params/redirect_mftf_v2.rb +++ b/_plugins/page-params/redirect_mftf_v2.rb @@ -9,9 +9,7 @@ # Dissemination of this information or reproduction of this material # is strictly forbidden -# This plugin redirects 2.3 pages to the DevSite. -# It uses redirect metadata from the 2.4 version of the page. -# If there is no 2.4 version of the page, then it redirects to https://developer.adobe.com/commerce/docs/ +# This plugin redirects MFTF v2 pages to the MFTF repo. # frozen_string_literal: true From c2699fab4c1583fb35876cd11e649a5bb563dd07 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Tue, 7 Nov 2023 09:30:31 -0600 Subject: [PATCH 09/14] Disallow all in robots.txt --- src/robots.txt | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/robots.txt b/src/robots.txt index ff83b7870e8..fdf46f026e8 100644 --- a/src/robots.txt +++ b/src/robots.txt @@ -2,7 +2,4 @@ layout: null --- User-agent: * -Sitemap: {{ site.url }}{{ site.baseurl }}/sitemap.xml -Disallow: /guides/v2.2/ -Disallow: /guides/v2.3/mtf/ -Disallow: /guides/v2.4/mtf/ +Disallow: / From 374f9909a8b0ea9fd1e846dc6ddbdd4ab749ff75 Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Wed, 8 Nov 2023 12:31:00 -0600 Subject: [PATCH 10/14] Delete MRG v2.3 generator --- _plugins/generators/mrg_v2_3.rb | 59 --------------------------------- 1 file changed, 59 deletions(-) delete mode 100644 _plugins/generators/mrg_v2_3.rb diff --git a/_plugins/generators/mrg_v2_3.rb b/_plugins/generators/mrg_v2_3.rb deleted file mode 100644 index dd21ebafb9a..00000000000 --- a/_plugins/generators/mrg_v2_3.rb +++ /dev/null @@ -1,59 +0,0 @@ -# Copyright © Magento, Inc. All rights reserved. -# See COPYING.txt for license details. - -# frozen_string_literal: true - -# This plugin generates module-specific topics in the 'guides/v2.3/mrg'. -# It takes data from files in '_data/codebase/mrg' and generates -# a virtual .md page for it with the same name. -# - -module Jekyll - # Custom generator for MRG pages - class Mrg23PageGenerator < Generator - safe true - - def generate(site) - # Make the site object available in any scope in this class. - @site = site - - # Data from '_data/codebase/mrg' as a Hash where - # the filename is a key and its content is a value. - mrg_data = @site.data['codebase']['v2_3']['mrg'] - # Loop through the hash where a key is assigned to a 'mod' (module is a - # special token in Ruby and should not be used) and value is assigned to - # 'metadata'. - # For example, for '_data/codebase/v2_3/mrg/NewModule.yml' that contains - # - # title: Magento_NewModule - # content: Magento_NewModule is an awesome module - # - # this will create a new virtual page guides/v2.3/mrg/NewModule.md - # that would correspond to: - # --- - # title: Magento_NewModule - # --- - # Magento_NewModule is an awesome module. - # - mrg_data.each do |mod, metadata| - # PageWithoutAFile handles processing files without reading it. - # mrg_topic is a virtual '.md' file - # See details in https://www.rubydoc.info/gems/jekyll/Jekyll/PageWithoutAFile - # See tests in https://github.com/jekyll/jekyll/blob/master/test/test_page_without_a_file.rb - mrg_topic = PageWithoutAFile.new( - @site, - @site.source, - 'guides/v2.3/mrg/', - "#{mod}.md" - ) - mrg_topic.content = metadata['content'] - mrg_topic.data['title'] = metadata['title'] - mrg_topic.process("#{mod}.md") - - # Add the newly constructed page object to the rest of pages - # on the site. - @site.pages << mrg_topic - end - end - end -end From d28ca2be9f2d2a498a5a16274e51a4b51a3b4edc Mon Sep 17 00:00:00 2001 From: Dmytro Shevtsov Date: Wed, 8 Nov 2023 16:09:48 -0600 Subject: [PATCH 11/14] Add redirect and remove non-redirectable content --- src/_includes/layout/header-styles.html | 1 - .../templates/tutorial-template-first.md | 1 + .../templates/tutorial-template-last.md | 1 + .../templates/tutorial-template-middle.md | 1 + src/feed.xml | 25 -- src/guides/v2.3/pwa/index.md | 1 + .../code-samples/ckeditor4Adapter.md | 254 ------------------ .../wysiwyg/add-custom-editor/index.md | 4 - .../code-samples/ckeditor4Adapter.md | 254 ------------------ .../wysiwyg/add-custom-editor/index.md | 4 - src/redoc/2.2/index.html | 1 + src/redoc/2.3/async-admin-rest-api.html | 5 - src/redoc/2.3/async-admin-schema.json | 1 - src/redoc/2.3/async-customer-rest-api.html | 5 - src/redoc/2.3/async-customer-schema.json | 1 - src/redoc/2.3/async-guest-rest-api.html | 5 - src/redoc/2.3/async-guest-schema.json | 1 - src/redoc/2.3/index.md | 1 + src/whats-new.md | 1 + src/whatsnew-feed.xml | 27 -- 20 files changed, 7 insertions(+), 587 deletions(-) delete mode 100644 src/feed.xml delete mode 100644 src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md delete mode 100644 src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md delete mode 100644 src/redoc/2.3/async-admin-rest-api.html delete mode 100644 src/redoc/2.3/async-admin-schema.json delete mode 100644 src/redoc/2.3/async-customer-rest-api.html delete mode 100644 src/redoc/2.3/async-customer-schema.json delete mode 100644 src/redoc/2.3/async-guest-rest-api.html delete mode 100644 src/redoc/2.3/async-guest-schema.json delete mode 100644 src/whatsnew-feed.xml diff --git a/src/_includes/layout/header-styles.html b/src/_includes/layout/header-styles.html index bcbe1e78f22..a884e32a5f9 100644 --- a/src/_includes/layout/header-styles.html +++ b/src/_includes/layout/header-styles.html @@ -1,3 +1,2 @@ - diff --git a/src/contributor-guide/templates/tutorial-template-first.md b/src/contributor-guide/templates/tutorial-template-first.md index 4f5a0cceab6..469fb60c6e3 100644 --- a/src/contributor-guide/templates/tutorial-template-first.md +++ b/src/contributor-guide/templates/tutorial-template-first.md @@ -10,6 +10,7 @@ return_to: redirect_from: - guides/v2.3/contributor-guide/templates/tutorial-template-first.html - guides/v2.4/contributor-guide/templates/tutorial-template-first.html +redirect_to: https://developer.adobe.com/commerce/contributor/guides/doc-contributions/ --- A tutorial provides procedural information spread across multiple pages. It contains several design elements that differ from standard topics: diff --git a/src/contributor-guide/templates/tutorial-template-last.md b/src/contributor-guide/templates/tutorial-template-last.md index 26f77830ff8..b59760ec96d 100644 --- a/src/contributor-guide/templates/tutorial-template-last.md +++ b/src/contributor-guide/templates/tutorial-template-last.md @@ -10,6 +10,7 @@ return_to: redirect_from: - guides/v2.3/contributor-guide/templates/tutorial-template-last.html - guides/v2.4/contributor-guide/templates/tutorial-template-last.html +redirect_to: https://developer.adobe.com/commerce/contributor/guides/doc-contributions/ --- The last page of a tutorial should acknowledge the reader has completed the tutorial and provide links to related information. Otherwise, add the content as you see fit. diff --git a/src/contributor-guide/templates/tutorial-template-middle.md b/src/contributor-guide/templates/tutorial-template-middle.md index 0157ee8c497..4cccf4a263b 100644 --- a/src/contributor-guide/templates/tutorial-template-middle.md +++ b/src/contributor-guide/templates/tutorial-template-middle.md @@ -10,6 +10,7 @@ return_to: redirect_from: - guides/v2.3/contributor-guide/templates/tutorial-template-middle.html - guides/v2.4/contributor-guide/templates/tutorial-template-middle.html +redirect_to: https://developer.adobe.com/commerce/contributor/guides/doc-contributions/ --- Add the content for each step as you see fit. diff --git a/src/feed.xml b/src/feed.xml deleted file mode 100644 index 0b1408515cd..00000000000 --- a/src/feed.xml +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: none ---- - - - - - {{ site.title | xml_escape }} - {{ site.description | xml_escape }} - {{ site.url }} - - {{ site.time | date_to_rfc822 }} - {{ site.time | date_to_rfc822 }} - Jekyll v{{ jekyll.version }} - {% assign sorted_pages = site.html_pages | where_exp: "page", "page.tag != 'omit'"| sort:"last_modified_at" | reverse %} - {% for page in sorted_pages limit: 100 %} - - {{ page.title | xml_escape }} - {{ page.content | xml_escape | strip_html | truncatewords: 75 }} - {{ page.url | prepend: site.url }} - {{ page.last_modified_at | date_to_rfc822 }} - - {% endfor %} - - diff --git a/src/guides/v2.3/pwa/index.md b/src/guides/v2.3/pwa/index.md index e8c393d1907..fab73068928 100644 --- a/src/guides/v2.3/pwa/index.md +++ b/src/guides/v2.3/pwa/index.md @@ -1,6 +1,7 @@ --- layout: full-width title: Magento Progressive Web Applications (PWA) +redirect_to: https://developer.adobe.com/commerce/pwa-studio/ --- ## What is a Progressive Web App diff --git a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md deleted file mode 100644 index 2d87d6ad38c..00000000000 --- a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md +++ /dev/null @@ -1,254 +0,0 @@ -``` js -/** - * Copyright © Magento, Inc. All rights reserved. - * See COPYING.txt for license details. - */ - -/* global varienGlobalEvents, tinyMceEditors, MediabrowserUtility, closeEditorPopup, Base64 */ -/* eslint-disable strict */ -define([ - 'jquery', - 'underscore', - 'CKEditor_CKEditor4/js/ckeditor4/ckeditor', - 'mage/translate', - 'prototype', - 'mage/adminhtml/events', - 'jquery/ui' -], function (jQuery, _, ckeditor4) { - - var ckeditorWysiwyg = Class.create(); - - ckeditorWysiwyg.prototype = { - mediaBrowserOpener: null, - mediaBrowserTargetElementId: null, - - /** - * @param {*} htmlId - * @param {Object} config - */ - initialize: function (htmlId, config) { - this.id = htmlId; - this.config = config; - - if (typeof ckeditorWysiwyg === 'undefined') { - window.ckeditorWysiwyg = $H({}); - } - - var settings = ''; - ckeditorWysiwyg.settings = this.config; - settings = $H({}); - if (this.config.plugins) { - this.config.plugins.each(function (plugin) { - settings.set(plugin.name, plugin.options); - }); - this.config.magentoPluginsOptions = settings; - } - this.config.elements = this.id; - ckeditor4.settings = this.config; - }, - - /** - * @param {*} mode - */ - setup: function (mode) { - ckeditor4.replaceAll(); - }, - - /** - * Insert content to active editor. - * - * @param {String} content - * @param {Boolean} ui - */ - insertContent: function (content, ui) { - this.activeEditor().insertText(content); - }, - - /** - * @param {Object} o - */ - openFileBrowser: function (o) { - }, - - /** - * Encodes the content so it can be inserted into the wysiwyg - * @param {String} content - The content to be encoded - * - * @returns {*} - The encoded content - */ - updateContent: function (content) { - }, - - /** - * On form validation. - */ - onFormValidation: function () { - if (tinyMCE4.get(this.id)) { - $(this.id).value = tinyMCE4.get(this.id).getContent(); - } - }, - /** - * @param {String} id - */ - get: function (id) { - return ckeditor4.instances[id]; - }, - - /** - * @return {Object} - */ - activeEditor: function () { - var activeInstance = false; - _.each(ckeditor4.instances, function (instance) { - if (instance.activeEnterMode === 1) { - activeInstance = instance; - instance.getBookmark = function () { - return null; - }; - instance.moveToBookmark = function () { - return instance; - }; - instance.getNode = function () { - return instance.getSelection(); - }; - instance.getNode = function () { - return instance.getSelection(); - }; - activeInstance.selection = instance; - - } - }); - return activeInstance; - }, - - /** - * @param {*} mode - * @return {tinyMceWysiwygSetup} - */ - turnOn: function (mode) { - }, - - /** - * @return {tinyMceWysiwygSetup} - */ - turnOff: function () { - - return this; - }, - - /** - * Retrieve directives URL with substituted directive value. - * - * @param {String} directive - */ - makeDirectiveUrl: function (directive) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeDirectives: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeWidgets: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeDirectives: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeWidgets: function (content) { - - }, - - /** - * @param {Object} attributes - * @return {Object} - */ - parseAttributesString: function (attributes) { - - }, - - /** - * Update text area. - */ - updateTextArea: function () { - - }, - setCaretOnElement: function (targetElement) { - this.activeEditor().selection.select(targetElement); - this.activeEditor().selection.collapse(); - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeContent: function (content) { - - }, - - /** - * @return {Boolean} - */ - toggle: function () { - return this.wysiwygInstance.toggle(); - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeContent: function (content) { - }, - - /** - * @param {Object} o - */ - beforeSetContent: function (o) { - - }, - - /** - * @param {Object} o - */ - saveContent: function (o) { - - }, - - /** - * @returns {Object} - */ - getAdapterPrototype: function () { - return ckeditorWysiwyg; - }, - - /** - * Return the content stored in the WYSIWYG field - * @param {String} id - * @return {String} - */ - getContent: function (id) { - - } - }; - - return ckeditorWysiwyg.prototype; -}); -``` diff --git a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md index 73f50357982..c5eb88a754e 100644 --- a/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md +++ b/src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md @@ -93,10 +93,6 @@ If you are integrating Magento entities such as variable and widget as plugins, **Example:** CKEditor/CKEditor4/view/base/web/ckeditor4Adapter.js -{% collapsible Show file content %} -{% include_relative code-samples/ckeditor4Adapter.md %} -{% endcollapsible %} - ## Step 4. Load editor library After loading, modifying, and merging all configurations, Magento serializes the result into a JSON object and passes it to the UI component. diff --git a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md deleted file mode 100644 index 2d87d6ad38c..00000000000 --- a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/code-samples/ckeditor4Adapter.md +++ /dev/null @@ -1,254 +0,0 @@ -``` js -/** - * Copyright © Magento, Inc. All rights reserved. - * See COPYING.txt for license details. - */ - -/* global varienGlobalEvents, tinyMceEditors, MediabrowserUtility, closeEditorPopup, Base64 */ -/* eslint-disable strict */ -define([ - 'jquery', - 'underscore', - 'CKEditor_CKEditor4/js/ckeditor4/ckeditor', - 'mage/translate', - 'prototype', - 'mage/adminhtml/events', - 'jquery/ui' -], function (jQuery, _, ckeditor4) { - - var ckeditorWysiwyg = Class.create(); - - ckeditorWysiwyg.prototype = { - mediaBrowserOpener: null, - mediaBrowserTargetElementId: null, - - /** - * @param {*} htmlId - * @param {Object} config - */ - initialize: function (htmlId, config) { - this.id = htmlId; - this.config = config; - - if (typeof ckeditorWysiwyg === 'undefined') { - window.ckeditorWysiwyg = $H({}); - } - - var settings = ''; - ckeditorWysiwyg.settings = this.config; - settings = $H({}); - if (this.config.plugins) { - this.config.plugins.each(function (plugin) { - settings.set(plugin.name, plugin.options); - }); - this.config.magentoPluginsOptions = settings; - } - this.config.elements = this.id; - ckeditor4.settings = this.config; - }, - - /** - * @param {*} mode - */ - setup: function (mode) { - ckeditor4.replaceAll(); - }, - - /** - * Insert content to active editor. - * - * @param {String} content - * @param {Boolean} ui - */ - insertContent: function (content, ui) { - this.activeEditor().insertText(content); - }, - - /** - * @param {Object} o - */ - openFileBrowser: function (o) { - }, - - /** - * Encodes the content so it can be inserted into the wysiwyg - * @param {String} content - The content to be encoded - * - * @returns {*} - The encoded content - */ - updateContent: function (content) { - }, - - /** - * On form validation. - */ - onFormValidation: function () { - if (tinyMCE4.get(this.id)) { - $(this.id).value = tinyMCE4.get(this.id).getContent(); - } - }, - /** - * @param {String} id - */ - get: function (id) { - return ckeditor4.instances[id]; - }, - - /** - * @return {Object} - */ - activeEditor: function () { - var activeInstance = false; - _.each(ckeditor4.instances, function (instance) { - if (instance.activeEnterMode === 1) { - activeInstance = instance; - instance.getBookmark = function () { - return null; - }; - instance.moveToBookmark = function () { - return instance; - }; - instance.getNode = function () { - return instance.getSelection(); - }; - instance.getNode = function () { - return instance.getSelection(); - }; - activeInstance.selection = instance; - - } - }); - return activeInstance; - }, - - /** - * @param {*} mode - * @return {tinyMceWysiwygSetup} - */ - turnOn: function (mode) { - }, - - /** - * @return {tinyMceWysiwygSetup} - */ - turnOff: function () { - - return this; - }, - - /** - * Retrieve directives URL with substituted directive value. - * - * @param {String} directive - */ - makeDirectiveUrl: function (directive) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeDirectives: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeWidgets: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeDirectives: function (content) { - - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeWidgets: function (content) { - - }, - - /** - * @param {Object} attributes - * @return {Object} - */ - parseAttributesString: function (attributes) { - - }, - - /** - * Update text area. - */ - updateTextArea: function () { - - }, - setCaretOnElement: function (targetElement) { - this.activeEditor().selection.select(targetElement); - this.activeEditor().selection.collapse(); - }, - - /** - * @param {Object} content - * @return {*} - */ - decodeContent: function (content) { - - }, - - /** - * @return {Boolean} - */ - toggle: function () { - return this.wysiwygInstance.toggle(); - }, - - /** - * @param {Object} content - * @return {*} - */ - encodeContent: function (content) { - }, - - /** - * @param {Object} o - */ - beforeSetContent: function (o) { - - }, - - /** - * @param {Object} o - */ - saveContent: function (o) { - - }, - - /** - * @returns {Object} - */ - getAdapterPrototype: function () { - return ckeditorWysiwyg; - }, - - /** - * Return the content stored in the WYSIWYG field - * @param {String} id - * @return {String} - */ - getContent: function (id) { - - } - }; - - return ckeditorWysiwyg.prototype; -}); -``` diff --git a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md index 7b2af0e3a5b..3b80747972b 100644 --- a/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md +++ b/src/guides/v2.4/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md @@ -95,10 +95,6 @@ If you are integrating Magento entities such as variable and widget as plugins, **Example:** CKEditor/CKEditor4/view/base/web/ckeditor4Adapter.js -{% collapsible Show file content %} -{% include_relative code-samples/ckeditor4Adapter.md %} -{% endcollapsible %} - ## Step 4. Load editor library After loading, modifying, and merging all configurations, Magento serializes the result into a JSON object and passes it to the UI component. diff --git a/src/redoc/2.2/index.html b/src/redoc/2.2/index.html index 3c714d211c5..a2e48c784ae 100644 --- a/src/redoc/2.2/index.html +++ b/src/redoc/2.2/index.html @@ -2,4 +2,5 @@ layout: redoc specUrl: latest-2.2.schema.json redirect_from: swagger/index.html +redirect_to: https://developer.adobe.com/commerce/webapi/rest/quick-reference/ --- diff --git a/src/redoc/2.3/async-admin-rest-api.html b/src/redoc/2.3/async-admin-rest-api.html deleted file mode 100644 index 095c41e7fd3..00000000000 --- a/src/redoc/2.3/async-admin-rest-api.html +++ /dev/null @@ -1,5 +0,0 @@ ---- -guide_version: 2.3 -layout: redoc -specUrl: async-admin-schema.json ---- diff --git a/src/redoc/2.3/async-admin-schema.json b/src/redoc/2.3/async-admin-schema.json deleted file mode 100644 index 2702c6aec37..00000000000 --- a/src/redoc/2.3/async-admin-schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.3.5","title":"Magento Asynchronous Admin REST endpoints - All inclusive"},"host":"example.com","basePath":"/rest/default/async","schemes":["https"],"tags":[{"name":"addresses/{addressId}"},{"name":"adobestock/asset/{id}"},{"name":"amazon-billing-address/{amazonOrderReferenceId}"},{"name":"amazon-shipping-address/{amazonOrderReferenceId}"},{"name":"amazon/order-ref"},{"name":"bundle-products/{sku}/links/{id}"},{"name":"bundle-products/{sku}/links/{optionId}"},{"name":"bundle-products/{sku}/options/{optionId}"},{"name":"bundle-products/{sku}/options/{optionId}/children/{childSku}"},{"name":"bundle-products/options/{optionId}"},{"name":"bundle-products/options/add"},{"name":"carts/"},{"name":"carts/{cartId}"},{"name":"carts/{cartId}/billing-address"},{"name":"carts/{cartId}/coupons"},{"name":"carts/{cartId}/coupons/{couponCode}"},{"name":"carts/{cartId}/estimate-shipping-methods"},{"name":"carts/{cartId}/estimate-shipping-methods-by-address-id"},{"name":"carts/{cartId}/gift-message"},{"name":"carts/{cartId}/gift-message/{itemId}"},{"name":"carts/{cartId}/giftCards"},{"name":"carts/{cartId}/giftCards/{giftCardCode}"},{"name":"carts/{cartId}/items/{itemId}"},{"name":"carts/{cartId}/order"},{"name":"carts/{cartId}/selected-payment-method"},{"name":"carts/{cartId}/shipping-information"},{"name":"carts/{cartId}/totals-information"},{"name":"carts/{quoteId}/items"},{"name":"carts/guest-carts/{cartId}/giftCards"},{"name":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"carts/mine"},{"name":"carts/mine/balance/apply"},{"name":"carts/mine/billing-address"},{"name":"carts/mine/collect-totals"},{"name":"carts/mine/coupons"},{"name":"carts/mine/coupons/{couponCode}"},{"name":"carts/mine/estimate-shipping-methods"},{"name":"carts/mine/estimate-shipping-methods-by-address-id"},{"name":"carts/mine/gift-message"},{"name":"carts/mine/gift-message/{itemId}"},{"name":"carts/mine/giftCards"},{"name":"carts/mine/giftCards/{giftCardCode}"},{"name":"carts/mine/items"},{"name":"carts/mine/items/{itemId}"},{"name":"carts/mine/order"},{"name":"carts/mine/payment-information"},{"name":"carts/mine/selected-payment-method"},{"name":"carts/mine/set-payment-information"},{"name":"carts/mine/shipping-information"},{"name":"carts/mine/totals-information"},{"name":"categories"},{"name":"categories/{categoryId}"},{"name":"categories/{categoryId}/move"},{"name":"categories/{categoryId}/products"},{"name":"categories/{categoryId}/products/{sku}"},{"name":"categories/{id}"},{"name":"cmsBlock"},{"name":"cmsBlock/{blockId}"},{"name":"cmsBlock/{id}"},{"name":"cmsPage"},{"name":"cmsPage/{id}"},{"name":"cmsPage/{pageId}"},{"name":"company/"},{"name":"company/{companyId}"},{"name":"company/assignRoles"},{"name":"company/role/"},{"name":"company/role/{id}"},{"name":"company/role/{roleId}"},{"name":"companyCredits/{creditId}/decreaseBalance"},{"name":"companyCredits/{creditId}/increaseBalance"},{"name":"companyCredits/{id}"},{"name":"companyCredits/history/{historyId}"},{"name":"configurable-products/{sku}/child"},{"name":"configurable-products/{sku}/children/{childSku}"},{"name":"configurable-products/{sku}/options"},{"name":"configurable-products/{sku}/options/{id}"},{"name":"configurable-products/variation"},{"name":"coupons"},{"name":"coupons/{couponId}"},{"name":"coupons/deleteByCodes"},{"name":"coupons/deleteByIds"},{"name":"coupons/generate"},{"name":"creditmemo"},{"name":"creditmemo/{id}"},{"name":"creditmemo/{id}/comments"},{"name":"creditmemo/{id}/emails"},{"name":"creditmemo/refund"},{"name":"customerGroups"},{"name":"customerGroups/{id}"},{"name":"customerGroups/default/{id}"},{"name":"customers"},{"name":"customers/{customerId}"},{"name":"customers/{customerId}/carts"},{"name":"customers/{email}/activate"},{"name":"customers/confirm"},{"name":"customers/isEmailAvailable"},{"name":"customers/me"},{"name":"customers/me/activate"},{"name":"customers/me/password"},{"name":"customers/password"},{"name":"customers/resetPassword"},{"name":"customers/validate"},{"name":"eav/attribute-sets"},{"name":"eav/attribute-sets/{attributeSetId}"},{"name":"gift-wrappings"},{"name":"gift-wrappings/{id}"},{"name":"gift-wrappings/{wrappingId}"},{"name":"giftregistry/mine/estimate-shipping-methods"},{"name":"guest-carts"},{"name":"guest-carts/{cartId}"},{"name":"guest-carts/{cartId}/billing-address"},{"name":"guest-carts/{cartId}/collect-totals"},{"name":"guest-carts/{cartId}/coupons"},{"name":"guest-carts/{cartId}/coupons/{couponCode}"},{"name":"guest-carts/{cartId}/estimate-shipping-methods"},{"name":"guest-carts/{cartId}/gift-message"},{"name":"guest-carts/{cartId}/gift-message/{itemId}"},{"name":"guest-carts/{cartId}/items"},{"name":"guest-carts/{cartId}/items/{itemId}"},{"name":"guest-carts/{cartId}/order"},{"name":"guest-carts/{cartId}/payment-information"},{"name":"guest-carts/{cartId}/selected-payment-method"},{"name":"guest-carts/{cartId}/set-payment-information"},{"name":"guest-carts/{cartId}/shipping-information"},{"name":"guest-carts/{cartId}/totals-information"},{"name":"guest-giftregistry/{cartId}/estimate-shipping-methods"},{"name":"hierarchy/move/{id}"},{"name":"integration/admin/token"},{"name":"integration/customer/token"},{"name":"inventory/bulk-partial-source-transfer"},{"name":"inventory/bulk-product-source-assign"},{"name":"inventory/bulk-product-source-transfer"},{"name":"inventory/bulk-product-source-unassign"},{"name":"inventory/low-quantity-notification"},{"name":"inventory/low-quantity-notifications-delete"},{"name":"inventory/source-items"},{"name":"inventory/source-items-delete"},{"name":"inventory/source-selection-algorithm-result"},{"name":"inventory/sources"},{"name":"inventory/sources/{sourceCode}"},{"name":"inventory/stock-source-links"},{"name":"inventory/stock-source-links-delete"},{"name":"inventory/stocks"},{"name":"inventory/stocks/{stockId}"},{"name":"invoice/{invoiceId}/refund"},{"name":"invoices/"},{"name":"invoices/{id}/capture"},{"name":"invoices/{id}/emails"},{"name":"invoices/{id}/void"},{"name":"invoices/comments"},{"name":"msp-2fa/default-provider-code/{userId}"},{"name":"msp-2fa/reset-provider/{userId}/{providerCode}"},{"name":"msp-2fa/trusted-devices/{tokenId}"},{"name":"msp-2fa/user-providers/{userId}"},{"name":"negotiable-carts/{cartId}/billing-address"},{"name":"negotiable-carts/{cartId}/coupons"},{"name":"negotiable-carts/{cartId}/coupons/{couponCode}"},{"name":"negotiable-carts/{cartId}/estimate-shipping-methods"},{"name":"negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"},{"name":"negotiable-carts/{cartId}/giftCards"},{"name":"negotiable-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"negotiable-carts/{cartId}/payment-information"},{"name":"negotiable-carts/{cartId}/set-payment-information"},{"name":"negotiable-carts/{cartId}/shipping-information"},{"name":"negotiableQuote/{quoteId}"},{"name":"negotiableQuote/{quoteId}/shippingMethod"},{"name":"negotiableQuote/decline"},{"name":"negotiableQuote/pricesUpdated"},{"name":"negotiableQuote/request"},{"name":"negotiableQuote/submitToCustomer"},{"name":"order/{orderId}/invoice"},{"name":"order/{orderId}/refund"},{"name":"order/{orderId}/ship"},{"name":"orders"},{"name":"orders/{id}/cancel"},{"name":"orders/{id}/comments"},{"name":"orders/{id}/emails"},{"name":"orders/{id}/hold"},{"name":"orders/{id}/unhold"},{"name":"orders/{parent_id}"},{"name":"orders/create"},{"name":"products"},{"name":"products/{productSku}/stockItems/{itemId}"},{"name":"products/{sku}"},{"name":"products/{sku}/downloadable-links"},{"name":"products/{sku}/downloadable-links/{id}"},{"name":"products/{sku}/downloadable-links/samples"},{"name":"products/{sku}/downloadable-links/samples/{id}"},{"name":"products/{sku}/group-prices/{customerGroupId}/tiers/{qty}"},{"name":"products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}"},{"name":"products/{sku}/links"},{"name":"products/{sku}/links/{type}/{linkedProductSku}"},{"name":"products/{sku}/media"},{"name":"products/{sku}/media/{entryId}"},{"name":"products/{sku}/options/{optionId}"},{"name":"products/{sku}/websites"},{"name":"products/{sku}/websites/{websiteId}"},{"name":"products/attribute-sets"},{"name":"products/attribute-sets/{attributeSetId}"},{"name":"products/attribute-sets/{attributeSetId}/attributes/{attributeCode}"},{"name":"products/attribute-sets/{attributeSetId}/groups"},{"name":"products/attribute-sets/attributes"},{"name":"products/attribute-sets/groups"},{"name":"products/attribute-sets/groups/{groupId}"},{"name":"products/attributes"},{"name":"products/attributes/{attributeCode}"},{"name":"products/attributes/{attributeCode}/options"},{"name":"products/attributes/{attributeCode}/options/{optionId}"},{"name":"products/base-prices"},{"name":"products/base-prices-information"},{"name":"products/cost"},{"name":"products/cost-delete"},{"name":"products/cost-information"},{"name":"products/downloadable-links/{id}"},{"name":"products/downloadable-links/samples/{id}"},{"name":"products/options"},{"name":"products/options/{optionId}"},{"name":"products/special-price"},{"name":"products/special-price-delete"},{"name":"products/special-price-information"},{"name":"products/tier-prices"},{"name":"products/tier-prices-delete"},{"name":"products/tier-prices-information"},{"name":"requisition_lists"},{"name":"returns"},{"name":"returns/{id}"},{"name":"returns/{id}/comments"},{"name":"returns/{id}/tracking-numbers"},{"name":"returns/{id}/tracking-numbers/{trackId}"},{"name":"reward/mine/use-reward"},{"name":"salesRules"},{"name":"salesRules/{ruleId}"},{"name":"sharedCatalog"},{"name":"sharedCatalog/{id}"},{"name":"sharedCatalog/{id}/assignCategories"},{"name":"sharedCatalog/{id}/assignProducts"},{"name":"sharedCatalog/{id}/unassignCategories"},{"name":"sharedCatalog/{id}/unassignProducts"},{"name":"sharedCatalog/{sharedCatalogId}"},{"name":"sharedCatalog/{sharedCatalogId}/assignCompanies"},{"name":"sharedCatalog/{sharedCatalogId}/unassignCompanies"},{"name":"shipment/"},{"name":"shipment/{id}/comments"},{"name":"shipment/{id}/emails"},{"name":"shipment/track"},{"name":"shipment/track/{id}"},{"name":"taxClasses"},{"name":"taxClasses/{classId}"},{"name":"taxClasses/{taxClassId}"},{"name":"taxRates"},{"name":"taxRates/{rateId}"},{"name":"taxRules"},{"name":"taxRules/{ruleId}"},{"name":"team/{companyId}"},{"name":"team/{teamId}"},{"name":"vertex-address-validation/vertex-address"},{"name":"worldpay-guest-carts/{cartId}/payment-information"}],"paths":{"/async/V1/addresses/{addressId}":{"delete":{"tags":["addresses/{addressId}"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"addresses/{addressId}"}},"/async/V1/adobestock/asset/{id}":{"delete":{"tags":["adobestock/asset/{id}"],"description":"Delete asset","operationId":"adobeStockAssetApiAssetRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"adobestock/asset/{id}"}},"/async/V1/amazon-billing-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-billing-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetBillingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetBillingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-billing-address/{amazonOrderReferenceId}"}},"/async/V1/amazon-shipping-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-shipping-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetShippingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetShippingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-shipping-address/{amazonOrderReferenceId}"}},"/async/V1/amazon/order-ref":{"delete":{"tags":["amazon/order-ref"],"description":"","operationId":"amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon/order-ref"}},"/async/V1/bundle-products/options/add":{"post":{"tags":["bundle-products/options/add"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"bundleProductOptionManagementV1SavePostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/options/add"}},"/async/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundle-products/options/{optionId}"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"bundleProductOptionManagementV1SavePutBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/options/{optionId}"}},"/async/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundle-products/{sku}/links/{id}"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"bundleProductLinkManagementV1SaveChildPutBody","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/links/{id}"}},"/async/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundle-products/{sku}/links/{optionId}"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"bundleProductLinkManagementV1AddChildByProductSkuPostBody","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/links/{optionId}"}},"/async/V1/bundle-products/{sku}/options/{optionId}":{"delete":{"tags":["bundle-products/{sku}/options/{optionId}"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/options/{optionId}"}},"/async/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundle-products/{sku}/options/{optionId}/children/{childSku}"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/options/{optionId}/children/{childSku}"}},"/async/V1/carts/":{"post":{"tags":["carts/"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/"}},"/async/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["carts/guest-carts/{cartId}/giftCards"],"description":"Add gift card to the cart.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards"}},"/async/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["carts/guest-carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1/carts/mine":{"put":{"tags":["carts/mine"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartRepositoryV1SavePutBody","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine"},"post":{"tags":["carts/mine"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine"}},"/async/V1/carts/mine/balance/apply":{"post":{"tags":["carts/mine/balance/apply"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/balance/apply"}},"/async/V1/carts/mine/billing-address":{"post":{"tags":["carts/mine/billing-address"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/billing-address"}},"/async/V1/carts/mine/collect-totals":{"put":{"tags":["carts/mine/collect-totals"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartTotalManagementV1CollectTotalsPutBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"shippingCarrierCode":{"type":"string","description":"The carrier code."},"shippingMethodCode":{"type":"string","description":"The shipping method code."},"additionalData":{"$ref":"#/definitions/quote-data-totals-additional-data-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collect-totals"}},"/async/V1/carts/mine/coupons":{"delete":{"tags":["carts/mine/coupons"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/coupons"}},"/async/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["carts/mine/coupons/{couponCode}"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/coupons/{couponCode}"}},"/async/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["carts/mine/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/estimate-shipping-methods"}},"/async/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["carts/mine/estimate-shipping-methods-by-address-id"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteShippingMethodManagementV1EstimateByAddressIdPostBody","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/estimate-shipping-methods-by-address-id"}},"/async/V1/carts/mine/gift-message":{"post":{"tags":["carts/mine/gift-message"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftMessageCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/gift-message"}},"/async/V1/carts/mine/gift-message/{itemId}":{"post":{"tags":["carts/mine/gift-message/{itemId}"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"giftMessageItemRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/gift-message/{itemId}"}},"/async/V1/carts/mine/giftCards":{"post":{"tags":["carts/mine/giftCards"],"description":"Add gift card to the cart.","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/giftCards"}},"/async/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["carts/mine/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/giftCards/{giftCardCode}"}},"/async/V1/carts/mine/items":{"post":{"tags":["carts/mine/items"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/items"}},"/async/V1/carts/mine/items/{itemId}":{"put":{"tags":["carts/mine/items/{itemId}"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"quoteCartItemRepositoryV1SavePutBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/items/{itemId}"},"delete":{"tags":["carts/mine/items/{itemId}"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/items/{itemId}"}},"/async/V1/carts/mine/order":{"put":{"tags":["carts/mine/order"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/order"}},"/async/V1/carts/mine/payment-information":{"post":{"tags":["carts/mine/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/payment-information"}},"/async/V1/carts/mine/selected-payment-method":{"put":{"tags":["carts/mine/selected-payment-method"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quotePaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/selected-payment-method"}},"/async/V1/carts/mine/set-payment-information":{"post":{"tags":["carts/mine/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutPaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/set-payment-information"}},"/async/V1/carts/mine/shipping-information":{"post":{"tags":["carts/mine/shipping-information"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/shipping-information"}},"/async/V1/carts/mine/totals-information":{"post":{"tags":["carts/mine/totals-information"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/totals-information"}},"/async/V1/carts/{cartId}":{"put":{"tags":["carts/{cartId}"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"quoteCartManagementV1AssignCustomerPutBody","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}"}},"/async/V1/carts/{cartId}/billing-address":{"post":{"tags":["carts/{cartId}/billing-address"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"quoteBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/billing-address"}},"/async/V1/carts/{cartId}/coupons":{"delete":{"tags":["carts/{cartId}/coupons"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/coupons"}},"/async/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["carts/{cartId}/coupons/{couponCode}"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/coupons/{couponCode}"}},"/async/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/estimate-shipping-methods"}},"/async/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["carts/{cartId}/estimate-shipping-methods-by-address-id"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"quoteShippingMethodManagementV1EstimateByAddressIdPostBody","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/estimate-shipping-methods-by-address-id"}},"/async/V1/carts/{cartId}/gift-message":{"post":{"tags":["carts/{cartId}/gift-message"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"giftMessageCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/gift-message"}},"/async/V1/carts/{cartId}/gift-message/{itemId}":{"post":{"tags":["carts/{cartId}/gift-message/{itemId}"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"giftMessageItemRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/gift-message/{itemId}"}},"/async/V1/carts/{cartId}/giftCards":{"put":{"tags":["carts/{cartId}/giftCards"],"description":"Add gift card to the cart.","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPutBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/giftCards"}},"/async/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["carts/{cartId}/items/{itemId}"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"quoteCartItemRepositoryV1SavePutBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/items/{itemId}"},"delete":{"tags":["carts/{cartId}/items/{itemId}"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/items/{itemId}"}},"/async/V1/carts/{cartId}/order":{"put":{"tags":["carts/{cartId}/order"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"quoteCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/order"}},"/async/V1/carts/{cartId}/selected-payment-method":{"put":{"tags":["carts/{cartId}/selected-payment-method"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"quotePaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/selected-payment-method"}},"/async/V1/carts/{cartId}/shipping-information":{"post":{"tags":["carts/{cartId}/shipping-information"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"checkoutShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/shipping-information"}},"/async/V1/carts/{cartId}/totals-information":{"post":{"tags":["carts/{cartId}/totals-information"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"checkoutTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/totals-information"}},"/async/V1/carts/{quoteId}/items":{"post":{"tags":["carts/{quoteId}/items"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"quoteCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{quoteId}/items"}},"/async/V1/categories":{"post":{"tags":["categories"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogCategoryRepositoryV1SavePostBody","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories"}},"/async/V1/categories/{categoryId}":{"delete":{"tags":["categories/{categoryId}"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}"}},"/async/V1/categories/{categoryId}/move":{"put":{"tags":["categories/{categoryId}/move"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"catalogCategoryManagementV1MovePutBody","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/move"}},"/async/V1/categories/{categoryId}/products":{"post":{"tags":["categories/{categoryId}/products"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"catalogCategoryLinkRepositoryV1SavePostBody","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/products"},"put":{"tags":["categories/{categoryId}/products"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"catalogCategoryLinkRepositoryV1SavePutBody","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/products"}},"/async/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["categories/{categoryId}/products/{sku}"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/products/{sku}"}},"/async/V1/categories/{id}":{"put":{"tags":["categories/{id}"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"catalogCategoryRepositoryV1SavePutBody","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{id}"}},"/async/V1/cmsBlock":{"post":{"tags":["cmsBlock"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cmsBlockRepositoryV1SavePostBody","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock"}},"/async/V1/cmsBlock/{blockId}":{"delete":{"tags":["cmsBlock/{blockId}"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock/{blockId}"}},"/async/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlock/{id}"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"cmsBlockRepositoryV1SavePutBody","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock/{id}"}},"/async/V1/cmsPage":{"post":{"tags":["cmsPage"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cmsPageRepositoryV1SavePostBody","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage"}},"/async/V1/cmsPage/{id}":{"put":{"tags":["cmsPage/{id}"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"cmsPageRepositoryV1SavePutBody","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage/{id}"}},"/async/V1/cmsPage/{pageId}":{"delete":{"tags":["cmsPage/{pageId}"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage/{pageId}"}},"/async/V1/company/":{"post":{"tags":["company/"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyCompanyRepositoryV1SavePostBody","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/"}},"/async/V1/company/assignRoles":{"put":{"tags":["company/assignRoles"],"description":"Change a role for a company user.","operationId":"companyAclV1AssignRolesPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyAclV1AssignRolesPutBody","in":"body","schema":{"required":["userId","roles"],"properties":{"userId":{"type":"integer"},"roles":{"type":"array","items":{"$ref":"#/definitions/company-data-role-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/assignRoles"}},"/async/V1/company/role/":{"post":{"tags":["company/role/"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyRoleRepositoryV1SavePostBody","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/"}},"/async/V1/company/role/{id}":{"put":{"tags":["company/role/{id}"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"companyRoleRepositoryV1SavePutBody","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/{id}"}},"/async/V1/company/role/{roleId}":{"delete":{"tags":["company/role/{roleId}"],"description":"Delete a role.","operationId":"companyRoleRepositoryV1DeleteDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/{roleId}"}},"/async/V1/company/{companyId}":{"delete":{"tags":["company/{companyId}"],"description":"Delete a company. Customers belonging to a company are not deleted with this request.","operationId":"companyCompanyRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/{companyId}"},"put":{"tags":["company/{companyId}"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyId","in":"path","type":"string","required":true},{"name":"companyCompanyRepositoryV1SavePutBody","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/{companyId}"}},"/async/V1/companyCredits/history/{historyId}":{"put":{"tags":["companyCredits/history/{historyId}"],"description":"Update the PO Number and/or comment for a Reimburse transaction.","operationId":"companyCreditCreditHistoryManagementV1UpdatePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"historyId","in":"path","type":"integer","required":true},{"name":"companyCreditCreditHistoryManagementV1UpdatePutBody","in":"body","schema":{"properties":{"purchaseOrder":{"type":"string","description":"[optional]"},"comment":{"type":"string","description":"[optional]"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/history/{historyId}"}},"/async/V1/companyCredits/{creditId}/decreaseBalance":{"post":{"tags":["companyCredits/{creditId}/decreaseBalance"],"description":"Decreases the company credit with an Update, Reimburse, or Purchase transaction. This transaction increases company's outstanding balance and decreases company's available credit.","operationId":"companyCreditCreditBalanceManagementV1DecreasePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"companyCreditCreditBalanceManagementV1DecreasePostBody","in":"body","schema":{"required":["value","currency","operationType"],"properties":{"value":{"type":"number"},"currency":{"type":"string"},"operationType":{"type":"integer"},"comment":{"type":"string","description":"[optional]"},"options":{"$ref":"#/definitions/company-credit-data-credit-balance-options-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{creditId}/decreaseBalance"}},"/async/V1/companyCredits/{creditId}/increaseBalance":{"post":{"tags":["companyCredits/{creditId}/increaseBalance"],"description":"Increases the company credit with an Allocate, Update, Refund, Revert, or Reimburse transaction. This transaction decreases company's outstanding balance and increases company's available credit.","operationId":"companyCreditCreditBalanceManagementV1IncreasePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"companyCreditCreditBalanceManagementV1IncreasePostBody","in":"body","schema":{"required":["value","currency","operationType"],"properties":{"value":{"type":"number"},"currency":{"type":"string"},"operationType":{"type":"integer"},"comment":{"type":"string","description":"[optional]"},"options":{"$ref":"#/definitions/company-credit-data-credit-balance-options-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{creditId}/increaseBalance"}},"/async/V1/companyCredits/{id}":{"put":{"tags":["companyCredits/{id}"],"description":"Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.","operationId":"companyCreditCreditLimitRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"companyCreditCreditLimitRepositoryV1SavePutBody","in":"body","schema":{"required":["creditLimit"],"properties":{"creditLimit":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{id}"}},"/async/V1/configurable-products/variation":{"put":{"tags":["configurable-products/variation"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"configurableProductConfigurableProductManagementV1GenerateVariationPutBody","in":"body","schema":{"required":["product","options"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/variation"}},"/async/V1/configurable-products/{sku}/child":{"post":{"tags":["configurable-products/{sku}/child"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"configurableProductLinkManagementV1AddChildPostBody","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/child"}},"/async/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurable-products/{sku}/children/{childSku}"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/children/{childSku}"}},"/async/V1/configurable-products/{sku}/options":{"post":{"tags":["configurable-products/{sku}/options"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"configurableProductOptionRepositoryV1SavePostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options"}},"/async/V1/configurable-products/{sku}/options/{id}":{"put":{"tags":["configurable-products/{sku}/options/{id}"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"configurableProductOptionRepositoryV1SavePutBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options/{id}"},"delete":{"tags":["configurable-products/{sku}/options/{id}"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options/{id}"}},"/async/V1/coupons":{"post":{"tags":["coupons"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesRuleCouponRepositoryV1SavePostBody","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons"}},"/async/V1/coupons/deleteByCodes":{"post":{"tags":["coupons/deleteByCodes"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesRuleCouponManagementV1DeleteByCodesPostBody","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/deleteByCodes"}},"/async/V1/coupons/deleteByIds":{"post":{"tags":["coupons/deleteByIds"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesRuleCouponManagementV1DeleteByIdsPostBody","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/deleteByIds"}},"/async/V1/coupons/generate":{"post":{"tags":["coupons/generate"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesRuleCouponManagementV1GeneratePostBody","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/generate"}},"/async/V1/coupons/{couponId}":{"put":{"tags":["coupons/{couponId}"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"salesRuleCouponRepositoryV1SavePutBody","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/{couponId}"},"delete":{"tags":["coupons/{couponId}"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/{couponId}"}},"/async/V1/creditmemo":{"post":{"tags":["creditmemo"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesCreditmemoRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo"}},"/async/V1/creditmemo/refund":{"post":{"tags":["creditmemo/refund"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesCreditmemoManagementV1RefundPostBody","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/refund"}},"/async/V1/creditmemo/{id}":{"put":{"tags":["creditmemo/{id}"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}"}},"/async/V1/creditmemo/{id}/comments":{"post":{"tags":["creditmemo/{id}/comments"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"salesCreditmemoCommentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}/comments"}},"/async/V1/creditmemo/{id}/emails":{"post":{"tags":["creditmemo/{id}/emails"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}/emails"}},"/async/V1/customerGroups":{"post":{"tags":["customerGroups"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerGroupRepositoryV1SavePostBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups"}},"/async/V1/customerGroups/default/{id}":{"put":{"tags":["customerGroups/default/{id}"],"description":"Set system default customer group.","operationId":"customerCustomerGroupConfigV1SetDefaultCustomerGroupPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/default/{id}"}},"/async/V1/customerGroups/{id}":{"put":{"tags":["customerGroups/{id}"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"customerGroupRepositoryV1SavePutBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/{id}"},"delete":{"tags":["customerGroups/{id}"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/{id}"}},"/async/V1/customers":{"post":{"tags":["customers"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1CreateAccountPostBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers"}},"/async/V1/customers/confirm":{"post":{"tags":["customers/confirm"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ResendConfirmationPostBody","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/confirm"}},"/async/V1/customers/isEmailAvailable":{"post":{"tags":["customers/isEmailAvailable"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1IsEmailAvailablePostBody","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/isEmailAvailable"}},"/async/V1/customers/me":{"put":{"tags":["customers/me"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerCustomerRepositoryV1SavePutBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me"}},"/async/V1/customers/me/activate":{"put":{"tags":["customers/me/activate"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ActivateByIdPutBody","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/activate"}},"/async/V1/customers/me/password":{"put":{"tags":["customers/me/password"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ChangePasswordByIdPutBody","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/password"}},"/async/V1/customers/password":{"put":{"tags":["customers/password"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1InitiatePasswordResetPutBody","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/password"}},"/async/V1/customers/resetPassword":{"post":{"tags":["customers/resetPassword"],"description":"Reset customer password.","operationId":"customerAccountManagementV1ResetPasswordPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ResetPasswordPostBody","in":"body","schema":{"required":["email","resetToken","newPassword"],"properties":{"email":{"type":"string","description":"If empty value given then the customer will be matched by the RP token."},"resetToken":{"type":"string"},"newPassword":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/resetPassword"}},"/async/V1/customers/validate":{"put":{"tags":["customers/validate"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ValidatePutBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/validate"}},"/async/V1/customers/{customerId}":{"put":{"tags":["customers/{customerId}"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true},{"name":"customerCustomerRepositoryV1SavePutBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}"},"delete":{"tags":["customers/{customerId}"],"description":"Delete customer by Customer ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}"}},"/async/V1/customers/{customerId}/carts":{"post":{"tags":["customers/{customerId}/carts"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/carts"}},"/async/V1/customers/{email}/activate":{"put":{"tags":["customers/{email}/activate"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"customerAccountManagementV1ActivatePutBody","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{email}/activate"}},"/async/V1/eav/attribute-sets":{"post":{"tags":["eav/attribute-sets"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"eavAttributeSetManagementV1CreatePostBody","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets"}},"/async/V1/eav/attribute-sets/{attributeSetId}":{"delete":{"tags":["eav/attribute-sets/{attributeSetId}"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets/{attributeSetId}"},"put":{"tags":["eav/attribute-sets/{attributeSetId}"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"eavAttributeSetRepositoryV1SavePutBody","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets/{attributeSetId}"}},"/async/V1/gift-wrappings":{"post":{"tags":["gift-wrappings"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftWrappingWrappingRepositoryV1SavePostBody","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings"}},"/async/V1/gift-wrappings/{id}":{"delete":{"tags":["gift-wrappings/{id}"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings/{id}"}},"/async/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["gift-wrappings/{wrappingId}"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"giftWrappingWrappingRepositoryV1SavePutBody","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings/{wrappingId}"}},"/async/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftregistry/mine/estimate-shipping-methods"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"giftregistry/mine/estimate-shipping-methods"}},"/async/V1/guest-carts":{"post":{"tags":["guest-carts"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts"}},"/async/V1/guest-carts/{cartId}":{"put":{"tags":["guest-carts/{cartId}"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartManagementV1AssignCustomerPutBody","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}"}},"/async/V1/guest-carts/{cartId}/billing-address":{"post":{"tags":["guest-carts/{cartId}/billing-address"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/billing-address"}},"/async/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["guest-carts/{cartId}/collect-totals"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartTotalManagementV1CollectTotalsPutBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"shippingCarrierCode":{"type":"string","description":"The carrier code."},"shippingMethodCode":{"type":"string","description":"The shipping method code."},"additionalData":{"$ref":"#/definitions/quote-data-totals-additional-data-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collect-totals"}},"/async/V1/guest-carts/{cartId}/coupons":{"delete":{"tags":["guest-carts/{cartId}/coupons"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons"}},"/async/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["guest-carts/{cartId}/coupons/{couponCode}"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons/{couponCode}"}},"/async/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/estimate-shipping-methods"}},"/async/V1/guest-carts/{cartId}/gift-message":{"post":{"tags":["guest-carts/{cartId}/gift-message"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"giftMessageGuestCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message"}},"/async/V1/guest-carts/{cartId}/gift-message/{itemId}":{"post":{"tags":["guest-carts/{cartId}/gift-message/{itemId}"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"giftMessageGuestItemRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message/{itemId}"}},"/async/V1/guest-carts/{cartId}/items":{"post":{"tags":["guest-carts/{cartId}/items"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items"}},"/async/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePutBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"},"delete":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"}},"/async/V1/guest-carts/{cartId}/order":{"put":{"tags":["guest-carts/{cartId}/order"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/order"}},"/async/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["guest-carts/{cartId}/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-information"}},"/async/V1/guest-carts/{cartId}/selected-payment-method":{"put":{"tags":["guest-carts/{cartId}/selected-payment-method"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestPaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/selected-payment-method"}},"/async/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["guest-carts/{cartId}/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/set-payment-information"}},"/async/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["guest-carts/{cartId}/shipping-information"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/shipping-information"}},"/async/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["guest-carts/{cartId}/totals-information"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/totals-information"}},"/async/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-giftregistry/{cartId}/estimate-shipping-methods"}},"/async/V1/hierarchy/move/{id}":{"put":{"tags":["hierarchy/move/{id}"],"description":"Moves teams and users within the company structure.","operationId":"companyCompanyHierarchyV1MoveNodePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"companyCompanyHierarchyV1MoveNodePutBody","in":"body","schema":{"required":["newParentId"],"properties":{"newParentId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"hierarchy/move/{id}"}},"/async/V1/integration/admin/token":{"post":{"tags":["integration/admin/token"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/admin/token"}},"/async/V1/integration/customer/token":{"post":{"tags":["integration/customer/token"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/customer/token"}},"/async/V1/inventory/bulk-partial-source-transfer":{"post":{"tags":["inventory/bulk-partial-source-transfer"],"description":"Run bulk partial inventory transfer for specified items.","operationId":"inventoryCatalogApiBulkPartialInventoryTransferV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryCatalogApiBulkPartialInventoryTransferV1ExecutePostBody","in":"body","schema":{"required":["originSourceCode","destinationSourceCode","items"],"properties":{"originSourceCode":{"type":"string"},"destinationSourceCode":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/definitions/inventory-catalog-api-data-partial-inventory-transfer-item-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/bulk-partial-source-transfer"}},"/async/V1/inventory/bulk-product-source-assign":{"post":{"tags":["inventory/bulk-product-source-assign"],"description":"Run mass product to source assignment","operationId":"inventoryCatalogApiBulkSourceAssignV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryCatalogApiBulkSourceAssignV1ExecutePostBody","in":"body","schema":{"required":["skus","sourceCodes"],"properties":{"skus":{"type":"array","items":{"type":"string"}},"sourceCodes":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/bulk-product-source-assign"}},"/async/V1/inventory/bulk-product-source-transfer":{"post":{"tags":["inventory/bulk-product-source-transfer"],"description":"Run bulk inventory transfer","operationId":"inventoryCatalogApiBulkInventoryTransferV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryCatalogApiBulkInventoryTransferV1ExecutePostBody","in":"body","schema":{"required":["skus","originSource","destinationSource","unassignFromOrigin"],"properties":{"skus":{"type":"array","items":{"type":"string"}},"originSource":{"type":"string"},"destinationSource":{"type":"string"},"unassignFromOrigin":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/bulk-product-source-transfer"}},"/async/V1/inventory/bulk-product-source-unassign":{"post":{"tags":["inventory/bulk-product-source-unassign"],"description":"Run mass product to source un-assignment","operationId":"inventoryCatalogApiBulkSourceUnassignV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryCatalogApiBulkSourceUnassignV1ExecutePostBody","in":"body","schema":{"required":["skus","sourceCodes"],"properties":{"skus":{"type":"array","items":{"type":"string"}},"sourceCodes":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/bulk-product-source-unassign"}},"/async/V1/inventory/low-quantity-notification":{"post":{"tags":["inventory/low-quantity-notification"],"description":"","operationId":"inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1ExecutePostBody","in":"body","schema":{"required":["sourceItemConfigurations"],"properties":{"sourceItemConfigurations":{"type":"array","items":{"$ref":"#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/low-quantity-notification"}},"/async/V1/inventory/low-quantity-notifications-delete":{"post":{"tags":["inventory/low-quantity-notifications-delete"],"description":"Delete multiple source items configuration for low quantity","operationId":"inventoryLowQuantityNotificationApiDeleteSourceItemsConfigurationV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryLowQuantityNotificationApiDeleteSourceItemsConfigurationV1ExecutePostBody","in":"body","schema":{"required":["sourceItems"],"properties":{"sourceItems":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/low-quantity-notifications-delete"}},"/async/V1/inventory/source-items":{"post":{"tags":["inventory/source-items"],"description":"Save Multiple Source item data","operationId":"inventoryApiSourceItemsSaveV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiSourceItemsSaveV1ExecutePostBody","in":"body","schema":{"required":["sourceItems"],"properties":{"sourceItems":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/source-items"}},"/async/V1/inventory/source-items-delete":{"post":{"tags":["inventory/source-items-delete"],"description":"Delete Multiple Source item data","operationId":"inventoryApiSourceItemsDeleteV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiSourceItemsDeleteV1ExecutePostBody","in":"body","schema":{"required":["sourceItems"],"properties":{"sourceItems":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/source-items-delete"}},"/async/V1/inventory/source-selection-algorithm-result":{"post":{"tags":["inventory/source-selection-algorithm-result"],"description":"","operationId":"inventorySourceSelectionApiSourceSelectionServiceV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventorySourceSelectionApiSourceSelectionServiceV1ExecutePostBody","in":"body","schema":{"required":["inventoryRequest","algorithmCode"],"properties":{"inventoryRequest":{"$ref":"#/definitions/inventory-source-selection-api-data-inventory-request-interface"},"algorithmCode":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/source-selection-algorithm-result"}},"/async/V1/inventory/sources":{"post":{"tags":["inventory/sources"],"description":"Save Source data","operationId":"inventoryApiSourceRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiSourceRepositoryV1SavePostBody","in":"body","schema":{"required":["source"],"properties":{"source":{"$ref":"#/definitions/inventory-api-data-source-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/sources"}},"/async/V1/inventory/sources/{sourceCode}":{"put":{"tags":["inventory/sources/{sourceCode}"],"description":"Save Source data","operationId":"inventoryApiSourceRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sourceCode","in":"path","type":"string","required":true},{"name":"inventoryApiSourceRepositoryV1SavePutBody","in":"body","schema":{"required":["source"],"properties":{"source":{"$ref":"#/definitions/inventory-api-data-source-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/sources/{sourceCode}"}},"/async/V1/inventory/stock-source-links":{"post":{"tags":["inventory/stock-source-links"],"description":"Save StockSourceLink list data","operationId":"inventoryApiStockSourceLinksSaveV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiStockSourceLinksSaveV1ExecutePostBody","in":"body","schema":{"required":["links"],"properties":{"links":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-stock-source-link-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/stock-source-links"}},"/async/V1/inventory/stock-source-links-delete":{"post":{"tags":["inventory/stock-source-links-delete"],"description":"Remove StockSourceLink list list","operationId":"inventoryApiStockSourceLinksDeleteV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiStockSourceLinksDeleteV1ExecutePostBody","in":"body","schema":{"required":["links"],"properties":{"links":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-stock-source-link-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/stock-source-links-delete"}},"/async/V1/inventory/stocks":{"post":{"tags":["inventory/stocks"],"description":"Save Stock data","operationId":"inventoryApiStockRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"inventoryApiStockRepositoryV1SavePostBody","in":"body","schema":{"required":["stock"],"properties":{"stock":{"$ref":"#/definitions/inventory-api-data-stock-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/stocks"}},"/async/V1/inventory/stocks/{stockId}":{"delete":{"tags":["inventory/stocks/{stockId}"],"description":"Delete the Stock data by stockId. If stock is not found do nothing","operationId":"inventoryApiStockRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/stocks/{stockId}"},"put":{"tags":["inventory/stocks/{stockId}"],"description":"Save Stock data","operationId":"inventoryApiStockRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"stockId","in":"path","type":"string","required":true},{"name":"inventoryApiStockRepositoryV1SavePutBody","in":"body","schema":{"required":["stock"],"properties":{"stock":{"$ref":"#/definitions/inventory-api-data-stock-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"inventory/stocks/{stockId}"}},"/async/V1/invoice/{invoiceId}/refund":{"post":{"tags":["invoice/{invoiceId}/refund"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"salesRefundInvoiceV1ExecutePostBody","in":"body","schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/sales-data-creditmemo-item-creation-interface"}},"isOnline":{"type":"boolean"},"notify":{"type":"boolean"},"appendComment":{"type":"boolean"},"comment":{"$ref":"#/definitions/sales-data-creditmemo-comment-creation-interface"},"arguments":{"$ref":"#/definitions/sales-data-creditmemo-creation-arguments-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoice/{invoiceId}/refund"}},"/async/V1/invoices/":{"post":{"tags":["invoices/"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesInvoiceRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/"}},"/async/V1/invoices/comments":{"post":{"tags":["invoices/comments"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesInvoiceCommentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/comments"}},"/async/V1/invoices/{id}/capture":{"post":{"tags":["invoices/{id}/capture"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/capture"}},"/async/V1/invoices/{id}/emails":{"post":{"tags":["invoices/{id}/emails"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/emails"}},"/async/V1/invoices/{id}/void":{"post":{"tags":["invoices/{id}/void"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/void"}},"/async/V1/msp-2fa/default-provider-code/{userId}":{"put":{"tags":["msp-2fa/default-provider-code/{userId}"],"description":"Set default provider code","operationId":"\\MSPTwoFactorAuthTfaV1SetDefaultProviderCodePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"userId","in":"path","type":"integer","required":true},{"name":"\\MSPTwoFactorAuthTfaV1SetDefaultProviderCodePutBody","in":"body","schema":{"required":["providerCode"],"properties":{"providerCode":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"msp-2fa/default-provider-code/{userId}"}},"/async/V1/msp-2fa/reset-provider/{userId}/{providerCode}":{"post":{"tags":["msp-2fa/reset-provider/{userId}/{providerCode}"],"description":"Reset default provider code","operationId":"\\MSPTwoFactorAuthTfaV1ResetProviderConfigPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"userId","in":"path","type":"integer","required":true},{"name":"providerCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"msp-2fa/reset-provider/{userId}/{providerCode}"}},"/async/V1/msp-2fa/trusted-devices/{tokenId}":{"delete":{"tags":["msp-2fa/trusted-devices/{tokenId}"],"description":"Revoke trusted device","operationId":"\\MSPTwoFactorAuthTrustedManagerV1RevokeTrustedDeviceDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"tokenId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"msp-2fa/trusted-devices/{tokenId}"}},"/async/V1/msp-2fa/user-providers/{userId}":{"put":{"tags":["msp-2fa/user-providers/{userId}"],"description":"Set providers","operationId":"\\MSPTwoFactorAuthTfaV1SetProvidersCodesPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"userId","in":"path","type":"integer","required":true},{"name":"\\MSPTwoFactorAuthTfaV1SetProvidersCodesPutBody","in":"body","schema":{"required":["providersCodes"],"properties":{"providersCodes":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"msp-2fa/user-providers/{userId}"}},"/async/V1/negotiable-carts/{cartId}/billing-address":{"post":{"tags":["negotiable-carts/{cartId}/billing-address"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"negotiableQuoteBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/billing-address"}},"/async/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiable-carts/{cartId}/coupons"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons"}},"/async/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiable-carts/{cartId}/coupons/{couponCode}"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons/{couponCode}"}},"/async/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiable-carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/estimate-shipping-methods"}},"/async/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPostBody","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"}},"/async/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiable-carts/{cartId}/giftCards"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards"}},"/async/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiable-carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiable-carts/{cartId}/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/payment-information"}},"/async/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiable-carts/{cartId}/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/set-payment-information"}},"/async/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiable-carts/{cartId}/shipping-information"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/shipping-information"}},"/async/V1/negotiableQuote/decline":{"post":{"tags":["negotiableQuote/decline"],"description":"Decline the B2B quote. All custom pricing will be removed from this quote. The buyer will be able to place an order using their standard catalog prices and discounts.","operationId":"negotiableQuoteNegotiableQuoteManagementV1DeclinePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"negotiableQuoteNegotiableQuoteManagementV1DeclinePostBody","in":"body","schema":{"required":["quoteId","reason"],"properties":{"quoteId":{"type":"integer"},"reason":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/decline"}},"/async/V1/negotiableQuote/pricesUpdated":{"post":{"tags":["negotiableQuote/pricesUpdated"],"description":"Refreshes item prices, taxes, discounts, cart rules in the negotiable quote as per the latest changes in the catalog / shared catalog and in the price rules. Depending on the negotiable quote state and totals, all or just some of quote numbers will be recalculated. 'Update Prices' parameter forces refresh on any quote that is not locked for admin user, including the quotes with a negotiated price. The request can be applied to one or more quotes at the same time.","operationId":"negotiableQuoteNegotiableQuotePriceManagementV1PricesUpdatedPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"negotiableQuoteNegotiableQuotePriceManagementV1PricesUpdatedPostBody","in":"body","schema":{"required":["quoteIds"],"properties":{"quoteIds":{"type":"array","items":{"type":"integer"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/pricesUpdated"}},"/async/V1/negotiableQuote/request":{"post":{"tags":["negotiableQuote/request"],"description":"Create a B2B quote based on a regular Magento quote. If the B2B quote requires a shipping address (for negotiation or tax calculations), add it to the regular quote before you create a B2B quote.","operationId":"negotiableQuoteNegotiableQuoteManagementV1CreatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"negotiableQuoteNegotiableQuoteManagementV1CreatePostBody","in":"body","schema":{"required":["quoteId","quoteName"],"properties":{"quoteId":{"type":"integer"},"quoteName":{"type":"string"},"comment":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/request"}},"/async/V1/negotiableQuote/submitToCustomer":{"post":{"tags":["negotiableQuote/submitToCustomer"],"description":"Submit the B2B quote to the customer. The quote status for the customer will be changed to 'Updated', and the customer can work with the quote.","operationId":"negotiableQuoteNegotiableQuoteManagementV1AdminSendPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"negotiableQuoteNegotiableQuoteManagementV1AdminSendPostBody","in":"body","schema":{"required":["quoteId"],"properties":{"quoteId":{"type":"integer"},"comment":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/submitToCustomer"}},"/async/V1/negotiableQuote/{quoteId}":{"put":{"tags":["negotiableQuote/{quoteId}"],"description":"Save quote","operationId":"negotiableQuoteNegotiableCartRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"negotiableQuoteNegotiableCartRepositoryV1SavePutBody","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/{quoteId}"}},"/async/V1/negotiableQuote/{quoteId}/shippingMethod":{"put":{"tags":["negotiableQuote/{quoteId}/shippingMethod"],"description":"Updates the shipping method on a negotiable quote.","operationId":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote id"},{"name":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPutBody","in":"body","schema":{"required":["shippingMethod"],"properties":{"shippingMethod":{"type":"string","description":"The shipping method code."}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/{quoteId}/shippingMethod"}},"/async/V1/order/{orderId}/invoice":{"post":{"tags":["order/{orderId}/invoice"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"salesInvoiceOrderV1ExecutePostBody","in":"body","schema":{"properties":{"capture":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/definitions/sales-data-invoice-item-creation-interface"}},"notify":{"type":"boolean"},"appendComment":{"type":"boolean"},"comment":{"$ref":"#/definitions/sales-data-invoice-comment-creation-interface"},"arguments":{"$ref":"#/definitions/sales-data-invoice-creation-arguments-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/invoice"}},"/async/V1/order/{orderId}/refund":{"post":{"tags":["order/{orderId}/refund"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"salesRefundOrderV1ExecutePostBody","in":"body","schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/sales-data-creditmemo-item-creation-interface"}},"notify":{"type":"boolean"},"appendComment":{"type":"boolean"},"comment":{"$ref":"#/definitions/sales-data-creditmemo-comment-creation-interface"},"arguments":{"$ref":"#/definitions/sales-data-creditmemo-creation-arguments-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/refund"}},"/async/V1/order/{orderId}/ship":{"post":{"tags":["order/{orderId}/ship"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"salesShipOrderV1ExecutePostBody","in":"body","schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipment-item-creation-interface"}},"notify":{"type":"boolean"},"appendComment":{"type":"boolean"},"comment":{"$ref":"#/definitions/sales-data-shipment-comment-creation-interface"},"tracks":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipment-track-creation-interface"}},"packages":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipment-package-creation-interface"}},"arguments":{"$ref":"#/definitions/sales-data-shipment-creation-arguments-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/ship"}},"/async/V1/orders":{"post":{"tags":["orders"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesOrderRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders"}},"/async/V1/orders/create":{"put":{"tags":["orders/create"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesOrderRepositoryV1SavePutBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/create"}},"/async/V1/orders/{id}/cancel":{"post":{"tags":["orders/{id}/cancel"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/cancel"}},"/async/V1/orders/{id}/comments":{"post":{"tags":["orders/{id}/comments"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"salesOrderManagementV1AddCommentPostBody","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/comments"}},"/async/V1/orders/{id}/emails":{"post":{"tags":["orders/{id}/emails"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/emails"}},"/async/V1/orders/{id}/hold":{"post":{"tags":["orders/{id}/hold"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/hold"}},"/async/V1/orders/{id}/unhold":{"post":{"tags":["orders/{id}/unhold"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/unhold"}},"/async/V1/orders/{parent_id}":{"put":{"tags":["orders/{parent_id}"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"salesOrderAddressRepositoryV1SavePutBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{parent_id}"}},"/async/V1/products":{"post":{"tags":["products"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogProductRepositoryV1SavePostBody","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products"}},"/async/V1/products/attribute-sets":{"post":{"tags":["products/attribute-sets"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogAttributeSetManagementV1CreatePostBody","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets"}},"/async/V1/products/attribute-sets/attributes":{"post":{"tags":["products/attribute-sets/attributes"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogProductAttributeManagementV1AssignPostBody","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/attributes"}},"/async/V1/products/attribute-sets/groups":{"post":{"tags":["products/attribute-sets/groups"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogProductAttributeGroupRepositoryV1SavePostBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/groups"}},"/async/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["products/attribute-sets/groups/{groupId}"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/groups/{groupId}"}},"/async/V1/products/attribute-sets/{attributeSetId}":{"delete":{"tags":["products/attribute-sets/{attributeSetId}"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}"},"put":{"tags":["products/attribute-sets/{attributeSetId}"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"catalogAttributeSetRepositoryV1SavePutBody","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}"}},"/async/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["products/attribute-sets/{attributeSetId}/attributes/{attributeCode}"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}/attributes/{attributeCode}"}},"/async/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["products/attribute-sets/{attributeSetId}/groups"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"catalogProductAttributeGroupRepositoryV1SavePutBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}/groups"}},"/async/V1/products/attributes":{"post":{"tags":["products/attributes"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogProductAttributeRepositoryV1SavePostBody","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes"}},"/async/V1/products/attributes/{attributeCode}":{"put":{"tags":["products/attributes/{attributeCode}"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"catalogProductAttributeRepositoryV1SavePutBody","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}"},"delete":{"tags":["products/attributes/{attributeCode}"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}"}},"/async/V1/products/attributes/{attributeCode}/options":{"post":{"tags":["products/attributes/{attributeCode}/options"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"catalogProductAttributeOptionManagementV1AddPostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}/options"}},"/async/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["products/attributes/{attributeCode}/options/{optionId}"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}/options/{optionId}"}},"/async/V1/products/base-prices":{"post":{"tags":["products/base-prices"],"description":"Add or update product prices. Input item should correspond \\Magento\\Catalog\\Api\\Data\\CostInterface. If any items will have invalid price, store id or sku, they will be marked as failed and excluded from update list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogBasePriceStorageV1UpdatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogBasePriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/base-prices"}},"/async/V1/products/base-prices-information":{"post":{"tags":["products/base-prices-information"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogBasePriceStorageV1GetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogBasePriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/base-prices-information"}},"/async/V1/products/cost":{"post":{"tags":["products/cost"],"description":"Add or update product cost. Input item should correspond to \\Magento\\Catalog\\Api\\Data\\CostInterface. If any items will have invalid cost, store id or sku, they will be marked as failed and excluded from update list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogCostStorageV1UpdatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogCostStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost"}},"/async/V1/products/cost-delete":{"post":{"tags":["products/cost-delete"],"description":"Delete product cost. In case of at least one of skus is not found exception will be thrown. If error occurred during the delete exception will be thrown.","operationId":"catalogCostStorageV1DeletePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogCostStorageV1DeletePostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost-delete"}},"/async/V1/products/cost-information":{"post":{"tags":["products/cost-information"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogCostStorageV1GetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogCostStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost-information"}},"/async/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["products/downloadable-links/samples/{id}"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/downloadable-links/samples/{id}"}},"/async/V1/products/downloadable-links/{id}":{"delete":{"tags":["products/downloadable-links/{id}"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/downloadable-links/{id}"}},"/async/V1/products/options":{"post":{"tags":["products/options"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogProductCustomOptionRepositoryV1SavePostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/options"}},"/async/V1/products/options/{optionId}":{"put":{"tags":["products/options/{optionId}"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"catalogProductCustomOptionRepositoryV1SavePutBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/options/{optionId}"}},"/async/V1/products/special-price":{"post":{"tags":["products/special-price"],"description":"Add or update product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from update list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogSpecialPriceStorageV1UpdatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogSpecialPriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price"}},"/async/V1/products/special-price-delete":{"post":{"tags":["products/special-price-delete"],"description":"Delete product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from delete list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the delete exception will be thrown.","operationId":"catalogSpecialPriceStorageV1DeletePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogSpecialPriceStorageV1DeletePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price-delete"}},"/async/V1/products/special-price-information":{"post":{"tags":["products/special-price-information"],"description":"Return product's special price. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogSpecialPriceStorageV1GetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogSpecialPriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price-information"}},"/async/V1/products/tier-prices":{"post":{"tags":["products/tier-prices"],"description":"Add or update product prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from update list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogTierPriceStorageV1UpdatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogTierPriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices"},"put":{"tags":["products/tier-prices"],"description":"Remove existing tier prices and replace them with the new ones. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from replace list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogTierPriceStorageV1ReplacePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogTierPriceStorageV1ReplacePutBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices"}},"/async/V1/products/tier-prices-delete":{"post":{"tags":["products/tier-prices-delete"],"description":"Delete product tier prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from delete list and \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.","operationId":"catalogTierPriceStorageV1DeletePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogTierPriceStorageV1DeletePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices-delete"}},"/async/V1/products/tier-prices-information":{"post":{"tags":["products/tier-prices-information"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogTierPriceStorageV1GetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"catalogTierPriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices-information"}},"/async/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["products/{productSku}/stockItems/{itemId}"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{productSku}/stockItems/{itemId}"}},"/async/V1/products/{sku}":{"put":{"tags":["products/{sku}"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductRepositoryV1SavePutBody","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}"},"delete":{"tags":["products/{sku}"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}"}},"/async/V1/products/{sku}/downloadable-links":{"post":{"tags":["products/{sku}/downloadable-links"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"downloadableLinkRepositoryV1SavePostBody","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links"}},"/async/V1/products/{sku}/downloadable-links/samples":{"post":{"tags":["products/{sku}/downloadable-links/samples"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"downloadableSampleRepositoryV1SavePostBody","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links/samples"}},"/async/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["products/{sku}/downloadable-links/samples/{id}"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"downloadableSampleRepositoryV1SavePutBody","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links/samples/{id}"}},"/async/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["products/{sku}/downloadable-links/{id}"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"downloadableLinkRepositoryV1SavePutBody","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links/{id}"}},"/async/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["products/{sku}/group-prices/{customerGroupId}/tiers/{qty}"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"'all' can be used to specify 'ALL GROUPS'"},{"name":"qty","in":"path","type":"number","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/group-prices/{customerGroupId}/tiers/{qty}"}},"/async/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"'all' can be used to specify 'ALL GROUPS'"},{"name":"price","in":"path","type":"number","required":true},{"name":"qty","in":"path","type":"number","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}"}},"/async/V1/products/{sku}/links":{"post":{"tags":["products/{sku}/links"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductLinkManagementV1SetProductLinksPostBody","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links"},"put":{"tags":["products/{sku}/links"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductLinkRepositoryV1SavePutBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links"}},"/async/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["products/{sku}/links/{type}/{linkedProductSku}"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true},{"name":"linkedProductSku","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links/{type}/{linkedProductSku}"}},"/async/V1/products/{sku}/media":{"post":{"tags":["products/{sku}/media"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductAttributeMediaGalleryManagementV1CreatePostBody","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media"}},"/async/V1/products/{sku}/media/{entryId}":{"put":{"tags":["products/{sku}/media/{entryId}"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"catalogProductAttributeMediaGalleryManagementV1UpdatePutBody","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media/{entryId}"},"delete":{"tags":["products/{sku}/media/{entryId}"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media/{entryId}"}},"/async/V1/products/{sku}/options/{optionId}":{"delete":{"tags":["products/{sku}/options/{optionId}"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/options/{optionId}"}},"/async/V1/products/{sku}/websites":{"post":{"tags":["products/{sku}/websites"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductWebsiteLinkRepositoryV1SavePostBody","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/websites"},"put":{"tags":["products/{sku}/websites"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"catalogProductWebsiteLinkRepositoryV1SavePutBody","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/websites"}},"/async/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["products/{sku}/websites/{websiteId}"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/websites/{websiteId}"}},"/async/V1/requisition_lists":{"post":{"tags":["requisition_lists"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"requisitionListRequisitionListRepositoryV1SavePostBody","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"requisition_lists"}},"/async/V1/returns":{"post":{"tags":["returns"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"rmaRmaManagementV1SaveRmaPostBody","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns"}},"/async/V1/returns/{id}":{"delete":{"tags":["returns/{id}"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"rmaRmaRepositoryV1DeleteDeleteBody","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}"},"put":{"tags":["returns/{id}"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"rmaRmaManagementV1SaveRmaPutBody","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}"}},"/async/V1/returns/{id}/comments":{"post":{"tags":["returns/{id}/comments"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"rmaCommentManagementV1AddCommentPostBody","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/comments"}},"/async/V1/returns/{id}/tracking-numbers":{"post":{"tags":["returns/{id}/tracking-numbers"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"rmaTrackManagementV1AddTrackPostBody","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/tracking-numbers"}},"/async/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["returns/{id}/tracking-numbers/{trackId}"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/tracking-numbers/{trackId}"}},"/async/V1/reward/mine/use-reward":{"post":{"tags":["reward/mine/use-reward"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"reward/mine/use-reward"}},"/async/V1/salesRules":{"post":{"tags":["salesRules"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesRuleRuleRepositoryV1SavePostBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules"}},"/async/V1/salesRules/{ruleId}":{"put":{"tags":["salesRules/{ruleId}"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"salesRuleRuleRepositoryV1SavePutBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules/{ruleId}"},"delete":{"tags":["salesRules/{ruleId}"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules/{ruleId}"}},"/async/V1/sharedCatalog":{"post":{"tags":["sharedCatalog"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogSharedCatalogRepositoryV1SavePostBody","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog"}},"/async/V1/sharedCatalog/{id}":{"put":{"tags":["sharedCatalog/{id}"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"sharedCatalogSharedCatalogRepositoryV1SavePutBody","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}"}},"/async/V1/sharedCatalog/{id}/assignCategories":{"post":{"tags":["sharedCatalog/{id}/assignCategories"],"description":"Add categories into the shared catalog.","operationId":"sharedCatalogCategoryManagementV1AssignCategoriesPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"sharedCatalogCategoryManagementV1AssignCategoriesPostBody","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/assignCategories"}},"/async/V1/sharedCatalog/{id}/assignProducts":{"post":{"tags":["sharedCatalog/{id}/assignProducts"],"description":"Add products into the shared catalog.","operationId":"sharedCatalogProductManagementV1AssignProductsPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"sharedCatalogProductManagementV1AssignProductsPostBody","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/assignProducts"}},"/async/V1/sharedCatalog/{id}/unassignCategories":{"post":{"tags":["sharedCatalog/{id}/unassignCategories"],"description":"Remove the specified categories from the shared catalog.","operationId":"sharedCatalogCategoryManagementV1UnassignCategoriesPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"sharedCatalogCategoryManagementV1UnassignCategoriesPostBody","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/unassignCategories"}},"/async/V1/sharedCatalog/{id}/unassignProducts":{"post":{"tags":["sharedCatalog/{id}/unassignProducts"],"description":"Remove the specified products from the shared catalog.","operationId":"sharedCatalogProductManagementV1UnassignProductsPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"sharedCatalogProductManagementV1UnassignProductsPostBody","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/unassignProducts"}},"/async/V1/sharedCatalog/{sharedCatalogId}":{"delete":{"tags":["sharedCatalog/{sharedCatalogId}"],"description":"Delete a shared catalog by ID.","operationId":"sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}"}},"/async/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":{"post":{"tags":["sharedCatalog/{sharedCatalogId}/assignCompanies"],"description":"Assign companies to a shared catalog.","operationId":"sharedCatalogCompanyManagementV1AssignCompaniesPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"sharedCatalogCompanyManagementV1AssignCompaniesPostBody","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}/assignCompanies"}},"/async/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":{"post":{"tags":["sharedCatalog/{sharedCatalogId}/unassignCompanies"],"description":"Unassign companies from a shared catalog.","operationId":"sharedCatalogCompanyManagementV1UnassignCompaniesPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"sharedCatalogCompanyManagementV1UnassignCompaniesPostBody","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}/unassignCompanies"}},"/async/V1/shipment/":{"post":{"tags":["shipment/"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesShipmentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/"}},"/async/V1/shipment/track":{"post":{"tags":["shipment/track"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"salesShipmentTrackRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/track"}},"/async/V1/shipment/track/{id}":{"delete":{"tags":["shipment/track/{id}"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/track/{id}"}},"/async/V1/shipment/{id}/comments":{"post":{"tags":["shipment/{id}/comments"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"salesShipmentCommentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}/comments"}},"/async/V1/shipment/{id}/emails":{"post":{"tags":["shipment/{id}/emails"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}/emails"}},"/async/V1/taxClasses":{"post":{"tags":["taxClasses"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxTaxClassRepositoryV1SavePostBody","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses"}},"/async/V1/taxClasses/{classId}":{"put":{"tags":["taxClasses/{classId}"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"taxTaxClassRepositoryV1SavePutBody","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses/{classId}"}},"/async/V1/taxClasses/{taxClassId}":{"delete":{"tags":["taxClasses/{taxClassId}"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses/{taxClassId}"}},"/async/V1/taxRates":{"post":{"tags":["taxRates"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxTaxRateRepositoryV1SavePostBody","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates"},"put":{"tags":["taxRates"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxTaxRateRepositoryV1SavePutBody","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates"}},"/async/V1/taxRates/{rateId}":{"delete":{"tags":["taxRates/{rateId}"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates/{rateId}"}},"/async/V1/taxRules":{"post":{"tags":["taxRules"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxTaxRuleRepositoryV1SavePostBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules"},"put":{"tags":["taxRules"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxTaxRuleRepositoryV1SavePutBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules"}},"/async/V1/taxRules/{ruleId}":{"delete":{"tags":["taxRules/{ruleId}"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules/{ruleId}"}},"/async/V1/team/{companyId}":{"post":{"tags":["team/{companyId}"],"description":"Create a team in the company structure.","operationId":"companyTeamRepositoryV1CreatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyId","in":"path","type":"integer","required":true},{"name":"companyTeamRepositoryV1CreatePostBody","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/{companyId}"}},"/async/V1/team/{teamId}":{"delete":{"tags":["team/{teamId}"],"description":"Delete a team from the company structure.","operationId":"companyTeamRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/{teamId}"},"put":{"tags":["team/{teamId}"],"description":"Update a team in the company structure.","operationId":"companyTeamRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"teamId","in":"path","type":"string","required":true},{"name":"companyTeamRepositoryV1SavePutBody","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/{teamId}"}},"/async/V1/vertex-address-validation/vertex-address":{"post":{"tags":["vertex-address-validation/vertex-address"],"description":"","operationId":"vertexAddressValidationAddressManagementV1GetValidAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"vertexAddressValidationAddressManagementV1GetValidAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"vertex-address-validation/vertex-address"}},"/async/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpay-guest-carts/{cartId}/payment-information"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"worldpay-guest-carts/{cartId}/payment-information"}}},"definitions":{"error-response":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"$ref":"#/definitions/error-errors"},"code":{"type":"integer","description":"Error code"},"parameters":{"$ref":"#/definitions/error-parameters"},"trace":{"type":"string","description":"Stack trace"}},"required":["message"]},"error-errors":{"type":"array","description":"Errors list","items":{"$ref":"#/definitions/error-errors-item"}},"error-errors-item":{"type":"object","description":"Error details","properties":{"message":{"type":"string","description":"Error message"},"parameters":{"$ref":"#/definitions/error-parameters"}}},"error-parameters":{"type":"array","description":"Error parameters list","items":{"$ref":"#/definitions/error-parameters-item"}},"error-parameters-item":{"type":"object","description":"Error parameters item","properties":{"resources":{"type":"string","description":"ACL resource"},"fieldName":{"type":"string","description":"Missing or invalid field name"},"fieldValue":{"type":"string","description":"Incorrect field value"}}},"asynchronous-operations-data-async-response-interface":{"type":"object","description":"Interface AsyncResponseInterface Temporary data object to give response from webapi async router","properties":{"bulk_uuid":{"type":"string","description":"Bulk Uuid."},"request_items":{"type":"array","description":"The list of request items with status data.","items":{"$ref":"#/definitions/asynchronous-operations-data-item-status-interface"}},"errors":{"type":"boolean","description":"There errors during processing bulk"},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-async-response-extension-interface"}},"required":["bulk_uuid","request_items","errors"]},"asynchronous-operations-data-item-status-interface":{"type":"object","description":"ItemStatusInterface interface Temporary object with status of requested item. Indicate if entity param was Accepted|Rejected to bulk schedule","properties":{"id":{"type":"integer","description":"Entity Id."},"data_hash":{"type":"string","description":"md5 hash of entity params array."},"status":{"type":"string","description":"accepted|rejected"},"error_message":{"type":"string","description":"Error information."},"error_code":{"type":"integer","description":"Error code."}},"required":["id","data_hash","status"]},"asynchronous-operations-data-async-response-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\AsyncResponseInterface"},"eav-data-attribute-set-interface":{"type":"object","description":"Interface AttributeSetInterface","properties":{"attribute_set_id":{"type":"integer","description":"Attribute set ID"},"attribute_set_name":{"type":"string","description":"Attribute set name"},"sort_order":{"type":"integer","description":"Attribute set sort order index"},"entity_type_id":{"type":"integer","description":"Attribute set entity type id"},"extension_attributes":{"$ref":"#/definitions/eav-data-attribute-set-extension-interface"}},"required":["attribute_set_name","sort_order"]},"eav-data-attribute-set-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeSetInterface"},"customer-data-group-interface":{"type":"object","description":"Customer group interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"tax_class_id":{"type":"integer","description":"Tax class id"},"tax_class_name":{"type":"string","description":"Tax class name"},"extension_attributes":{"$ref":"#/definitions/customer-data-group-extension-interface"}},"required":["code","tax_class_id"]},"customer-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\GroupInterface"},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"group_id":{"type":"integer","description":"Group id"},"default_billing":{"type":"string","description":"Default billing address id"},"default_shipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"created_at":{"type":"string","description":"Created at time"},"updated_at":{"type":"string","description":"Updated at time"},"created_in":{"type":"string","description":"Created in area"},"dob":{"type":"string","description":"Date of birth"},"email":{"type":"string","description":"Email address"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"gender":{"type":"integer","description":"Gender"},"store_id":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"website_id":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disable_auto_group_change":{"type":"integer","description":"Disable auto group change flag."},"extension_attributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["email","firstname","lastname"]},"customer-data-address-interface":{"type":"object","description":"Customer address interface.","properties":{"id":{"type":"integer","description":"ID"},"customer_id":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"region_id":{"type":"integer","description":"Region ID"},"country_id":{"type":"string","description":"Country code in ISO_3166-2 format"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"default_shipping":{"type":"boolean","description":"If this address is default shipping address."},"default_billing":{"type":"boolean","description":"If this address is default billing address"},"extension_attributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"region_code":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"region_id":{"type":"integer","description":"Region id"},"extension_attributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["region_code","region","region_id"]},"customer-data-region-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\RegionInterface"},"customer-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\AddressInterface"},"framework-attribute-interface":{"type":"object","description":"Interface for custom attribute value.","properties":{"attribute_code":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attribute_code","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface","properties":{"company_attributes":{"$ref":"#/definitions/company-data-company-customer-interface"},"is_subscribed":{"type":"boolean"},"amazon_id":{"type":"string"},"vertex_customer_code":{"type":"string"}}},"company-data-company-customer-interface":{"type":"object","description":"Extended customer custom attributes interface.","properties":{"customer_id":{"type":"integer","description":"Customer ID."},"company_id":{"type":"integer","description":"Company ID."},"job_title":{"type":"string","description":"Get job title."},"status":{"type":"integer","description":"Customer status."},"telephone":{"type":"string","description":"Get telephone."},"extension_attributes":{"$ref":"#/definitions/company-data-company-customer-extension-interface"}}},"company-data-company-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\CompanyCustomerInterface"},"cms-data-page-interface":{"type":"object","description":"CMS page interface.","properties":{"id":{"type":"integer","description":"ID"},"identifier":{"type":"string","description":"Identifier"},"title":{"type":"string","description":"Title"},"page_layout":{"type":"string","description":"Page layout"},"meta_title":{"type":"string","description":"Meta title"},"meta_keywords":{"type":"string","description":"Meta keywords"},"meta_description":{"type":"string","description":"Meta description"},"content_heading":{"type":"string","description":"Content heading"},"content":{"type":"string","description":"Content"},"creation_time":{"type":"string","description":"Creation time"},"update_time":{"type":"string","description":"Update time"},"sort_order":{"type":"string","description":"Sort order"},"layout_update_xml":{"type":"string","description":"Layout update xml"},"custom_theme":{"type":"string","description":"Custom theme"},"custom_root_template":{"type":"string","description":"Custom root template"},"custom_layout_update_xml":{"type":"string","description":"Custom layout update xml"},"custom_theme_from":{"type":"string","description":"Custom theme from"},"custom_theme_to":{"type":"string","description":"Custom theme to"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-block-interface":{"type":"object","description":"CMS block interface.","properties":{"id":{"type":"integer","description":"ID"},"identifier":{"type":"string","description":"Identifier"},"title":{"type":"string","description":"Title"},"content":{"type":"string","description":"Content"},"creation_time":{"type":"string","description":"Creation time"},"update_time":{"type":"string","description":"Update time"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"catalog-data-product-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Id"},"sku":{"type":"string","description":"Sku"},"name":{"type":"string","description":"Name"},"attribute_set_id":{"type":"integer","description":"Attribute set id"},"price":{"type":"number","description":"Price"},"status":{"type":"integer","description":"Status"},"visibility":{"type":"integer","description":"Visibility"},"type_id":{"type":"string","description":"Type id"},"created_at":{"type":"string","description":"Created date"},"updated_at":{"type":"string","description":"Updated date"},"weight":{"type":"number","description":"Weight"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-extension-interface"},"product_links":{"type":"array","description":"Product links info","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"options":{"type":"array","description":"List of product options","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"media_gallery_entries":{"type":"array","description":"Media gallery entries","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"tier_prices":{"type":"array","description":"List of product tier prices","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["sku"]},"catalog-data-product-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductInterface","properties":{"website_ids":{"type":"array","items":{"type":"integer"}},"category_links":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-link-interface"}},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}},"downloadable_product_links":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadable_product_samples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"giftcard_amounts":{"type":"array","items":{"$ref":"#/definitions/gift-card-data-giftcard-amount-interface"}}}},"catalog-data-category-link-interface":{"type":"object","description":"","properties":{"position":{"type":"integer","description":"Position"},"category_id":{"type":"string","description":"Category id"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-link-extension-interface"}},"required":["category_id"]},"catalog-data-category-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryLinkInterface"},"catalog-inventory-data-stock-item-interface":{"type":"object","description":"Interface StockItem","properties":{"item_id":{"type":"integer"},"product_id":{"type":"integer"},"stock_id":{"type":"integer","description":"Stock identifier"},"qty":{"type":"number"},"is_in_stock":{"type":"boolean","description":"Stock Availability"},"is_qty_decimal":{"type":"boolean"},"show_default_notification_message":{"type":"boolean"},"use_config_min_qty":{"type":"boolean"},"min_qty":{"type":"number","description":"Minimal quantity available for item status in stock"},"use_config_min_sale_qty":{"type":"integer"},"min_sale_qty":{"type":"number","description":"Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation"},"use_config_max_sale_qty":{"type":"boolean"},"max_sale_qty":{"type":"number","description":"Maximum Qty Allowed in Shopping Cart data wrapper"},"use_config_backorders":{"type":"boolean"},"backorders":{"type":"integer","description":"Backorders status"},"use_config_notify_stock_qty":{"type":"boolean"},"notify_stock_qty":{"type":"number","description":"Notify for Quantity Below data wrapper"},"use_config_qty_increments":{"type":"boolean"},"qty_increments":{"type":"number","description":"Quantity Increments data wrapper"},"use_config_enable_qty_inc":{"type":"boolean"},"enable_qty_increments":{"type":"boolean","description":"Whether Quantity Increments is enabled"},"use_config_manage_stock":{"type":"boolean"},"manage_stock":{"type":"boolean","description":"Can Manage Stock"},"low_stock_date":{"type":"string"},"is_decimal_divided":{"type":"boolean"},"stock_status_changed_auto":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-item-extension-interface"}},"required":["qty","is_in_stock","is_qty_decimal","show_default_notification_message","use_config_min_qty","min_qty","use_config_min_sale_qty","min_sale_qty","use_config_max_sale_qty","max_sale_qty","use_config_backorders","backorders","use_config_notify_stock_qty","notify_stock_qty","use_config_qty_increments","qty_increments","use_config_enable_qty_inc","enable_qty_increments","use_config_manage_stock","manage_stock","low_stock_date","is_decimal_divided","stock_status_changed_auto"]},"catalog-inventory-data-stock-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockItemInterface"},"bundle-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"option_id":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"required":{"type":"boolean","description":"Is required option"},"type":{"type":"string","description":"Input type"},"position":{"type":"integer","description":"Option position"},"sku":{"type":"string","description":"Product sku"},"product_links":{"type":"array","description":"Product links","items":{"$ref":"#/definitions/bundle-data-link-interface"}},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-extension-interface"}}},"bundle-data-link-interface":{"type":"object","description":"Interface LinkInterface","properties":{"id":{"type":"string","description":"The identifier"},"sku":{"type":"string","description":"Linked product sku"},"option_id":{"type":"integer","description":"Option id"},"qty":{"type":"number","description":"Qty"},"position":{"type":"integer","description":"Position"},"is_default":{"type":"boolean","description":"Is default"},"price":{"type":"number","description":"Price"},"price_type":{"type":"integer","description":"Price type"},"can_change_quantity":{"type":"integer","description":"Whether quantity could be changed"},"extension_attributes":{"$ref":"#/definitions/bundle-data-link-extension-interface"}},"required":["is_default","price","price_type"]},"bundle-data-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\LinkInterface"},"bundle-data-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionInterface"},"configurable-product-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"id":{"type":"integer"},"attribute_id":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"is_use_default":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-value-interface"}},"extension_attributes":{"$ref":"#/definitions/configurable-product-data-option-extension-interface"},"product_id":{"type":"integer"}}},"configurable-product-data-option-value-interface":{"type":"object","description":"Interface OptionValueInterface","properties":{"value_index":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/configurable-product-data-option-value-extension-interface"}},"required":["value_index"]},"configurable-product-data-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\OptionValueInterface"},"configurable-product-data-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\OptionInterface"},"downloadable-data-link-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string"},"sort_order":{"type":"integer"},"is_shareable":{"type":"integer","description":"Shareable status"},"price":{"type":"number","description":"Price"},"number_of_downloads":{"type":"integer","description":"Of downloads per user"},"link_type":{"type":"string"},"link_file":{"type":"string","description":"relative file path"},"link_file_content":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"link_url":{"type":"string","description":"Link url or null when type is 'file'"},"sample_type":{"type":"string"},"sample_file":{"type":"string","description":"relative file path"},"sample_file_content":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sample_url":{"type":"string","description":"file URL"},"extension_attributes":{"$ref":"#/definitions/downloadable-data-link-extension-interface"}},"required":["sort_order","is_shareable","price","link_type","sample_type"]},"downloadable-data-file-content-interface":{"type":"object","description":"","properties":{"file_data":{"type":"string","description":"Data (base64 encoded content)"},"name":{"type":"string","description":"File name"},"extension_attributes":{"$ref":"#/definitions/downloadable-data-file-content-extension-interface"}},"required":["file_data","name"]},"downloadable-data-file-content-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\File\\ContentInterface"},"downloadable-data-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\LinkInterface"},"downloadable-data-sample-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string","description":"Title"},"sort_order":{"type":"integer","description":"Order index for sample"},"sample_type":{"type":"string"},"sample_file":{"type":"string","description":"relative file path"},"sample_file_content":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sample_url":{"type":"string","description":"file URL"},"extension_attributes":{"$ref":"#/definitions/downloadable-data-sample-extension-interface"}},"required":["title","sort_order","sample_type"]},"downloadable-data-sample-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\SampleInterface"},"gift-card-data-giftcard-amount-interface":{"type":"object","description":"Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts","properties":{"attribute_id":{"type":"integer"},"website_id":{"type":"integer"},"value":{"type":"number"},"website_value":{"type":"number"},"extension_attributes":{"$ref":"#/definitions/gift-card-data-giftcard-amount-extension-interface"}},"required":["attribute_id","website_id","value","website_value"]},"gift-card-data-giftcard-amount-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftcardAmountInterface"},"catalog-data-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string","description":"SKU"},"link_type":{"type":"string","description":"Link type"},"linked_product_sku":{"type":"string","description":"Linked product sku"},"linked_product_type":{"type":"string","description":"Linked product type (simple, virtual, etc)"},"position":{"type":"integer","description":"Linked item position"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-extension-interface"}},"required":["sku","link_type","linked_product_sku","linked_product_type","position"]},"catalog-data-product-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkInterface","properties":{"qty":{"type":"number"}}},"catalog-data-product-custom-option-interface":{"type":"object","description":"","properties":{"product_sku":{"type":"string","description":"Product SKU"},"option_id":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"type":{"type":"string","description":"Option type"},"sort_order":{"type":"integer","description":"Sort order"},"is_require":{"type":"boolean","description":"Is require"},"price":{"type":"number","description":"Price"},"price_type":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"file_extension":{"type":"string"},"max_characters":{"type":"integer"},"image_size_x":{"type":"integer"},"image_size_y":{"type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-values-interface"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-extension-interface"}},"required":["product_sku","title","type","sort_order","is_require"]},"catalog-data-product-custom-option-values-interface":{"type":"object","description":"","properties":{"title":{"type":"string","description":"Option title"},"sort_order":{"type":"integer","description":"Sort order"},"price":{"type":"number","description":"Price"},"price_type":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"option_type_id":{"type":"integer","description":"Option type id"}},"required":["title","sort_order","price","price_type"]},"catalog-data-product-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionInterface","properties":{"vertex_flex_field":{"type":"string"}}},"catalog-data-product-attribute-media-gallery-entry-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Gallery entry ID"},"media_type":{"type":"string","description":"Media type"},"label":{"type":"string","description":"Gallery entry alternative text"},"position":{"type":"integer","description":"Gallery entry position (sort order)"},"disabled":{"type":"boolean","description":"If gallery entry is hidden from product page"},"types":{"type":"array","description":"Gallery entry image types (thumbnail, image, small_image etc)","items":{"type":"string"}},"file":{"type":"string","description":"File path"},"content":{"$ref":"#/definitions/framework-data-image-content-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"}},"required":["media_type","label","position","disabled","types"]},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64_encoded_data":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64_encoded_data","type","name"]},"catalog-data-product-attribute-media-gallery-entry-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeMediaGalleryEntryInterface","properties":{"video_content":{"$ref":"#/definitions/framework-data-video-content-interface"}}},"framework-data-video-content-interface":{"type":"object","description":"Video Content data interface","properties":{"media_type":{"type":"string","description":"MIME type"},"video_provider":{"type":"string","description":"Provider"},"video_url":{"type":"string","description":"Video URL"},"video_title":{"type":"string","description":"Title"},"video_description":{"type":"string","description":"Video Description"},"video_metadata":{"type":"string","description":"Metadata"}},"required":["media_type","video_provider","video_url","video_title","video_description","video_metadata"]},"catalog-data-product-tier-price-interface":{"type":"object","description":"","properties":{"customer_group_id":{"type":"integer","description":"Customer group id"},"qty":{"type":"number","description":"Tier qty"},"value":{"type":"number","description":"Price value"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-tier-price-extension-interface"}},"required":["customer_group_id","qty","value"]},"catalog-data-product-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTierPriceInterface","properties":{"percentage_value":{"type":"number"},"website_id":{"type":"integer"}}},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"extension_attributes":{"$ref":"#/definitions/eav-data-attribute-extension-interface"},"is_wysiwyg_enabled":{"type":"boolean","description":"WYSIWYG flag"},"is_html_allowed_on_front":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"used_for_sort_by":{"type":"boolean","description":"It is used for sorting in product listing"},"is_filterable":{"type":"boolean","description":"It used in layered navigation"},"is_filterable_in_search":{"type":"boolean","description":"It is used in search results layered navigation"},"is_used_in_grid":{"type":"boolean","description":"It is used in catalog product grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in catalog product grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"apply_to":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"is_searchable":{"type":"string","description":"The attribute can be used in Quick Search"},"is_visible_in_advanced_search":{"type":"string","description":"The attribute can be used in Advanced Search"},"is_comparable":{"type":"string","description":"The attribute can be compared on the frontend"},"is_used_for_promo_rules":{"type":"string","description":"The attribute can be used for promo rules"},"is_visible_on_front":{"type":"string","description":"The attribute is visible on the frontend"},"used_in_product_listing":{"type":"string","description":"The attribute can be used in product listing"},"is_visible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"attribute_id":{"type":"integer","description":"Id of the attribute."},"attribute_code":{"type":"string","description":"Code of the attribute."},"frontend_input":{"type":"string","description":"HTML for input element."},"entity_type_id":{"type":"string","description":"Entity type id"},"is_required":{"type":"boolean","description":"Attribute is required."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"is_user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"default_frontend_label":{"type":"string","description":"Frontend label for default store"},"frontend_labels":{"type":"array","description":"Frontend label for each store","items":{"$ref":"#/definitions/eav-data-attribute-frontend-label-interface"}},"note":{"type":"string","description":"The note attribute for the element."},"backend_type":{"type":"string","description":"Backend type."},"backend_model":{"type":"string","description":"Backend model"},"source_model":{"type":"string","description":"Source model"},"default_value":{"type":"string","description":"Default value for the element."},"is_unique":{"type":"string","description":"This is a unique attribute"},"frontend_class":{"type":"string","description":"Frontend class of attribute"},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attribute_code","frontend_input","entity_type_id","is_required","frontend_labels"]},"eav-data-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeInterface","properties":{"is_pagebuilder_enabled":{"type":"boolean"}}},"eav-data-attribute-option-interface":{"type":"object","description":"Created from:","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"sort_order":{"type":"integer","description":"Option order"},"is_default":{"type":"boolean","description":"Default"},"store_labels":{"type":"array","description":"Option label for store scopes","items":{"$ref":"#/definitions/eav-data-attribute-option-label-interface"}}},"required":["label","value"]},"eav-data-attribute-option-label-interface":{"type":"object","description":"Interface AttributeOptionLabelInterface","properties":{"store_id":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-frontend-label-interface":{"type":"object","description":"Interface AttributeFrontendLabelInterface","properties":{"store_id":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-validation-rule-interface":{"type":"object","description":"Interface AttributeValidationRuleInterface","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"eav-data-attribute-group-interface":{"type":"object","description":"Interface AttributeGroupInterface","properties":{"attribute_group_id":{"type":"string","description":"Id"},"attribute_group_name":{"type":"string","description":"Name"},"attribute_set_id":{"type":"integer","description":"Attribute set id"},"extension_attributes":{"$ref":"#/definitions/eav-data-attribute-group-extension-interface"}}},"eav-data-attribute-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeGroupInterface","properties":{"attribute_group_code":{"type":"string"},"sort_order":{"type":"string"}}},"catalog-data-tier-price-interface":{"type":"object","description":"Tier price interface.","properties":{"price":{"type":"number","description":"Tier price."},"price_type":{"type":"string","description":"Tier price type."},"website_id":{"type":"integer","description":"Website id."},"sku":{"type":"string","description":"SKU."},"customer_group":{"type":"string","description":"Customer group."},"quantity":{"type":"number","description":"Quantity."},"extension_attributes":{"$ref":"#/definitions/catalog-data-tier-price-extension-interface"}},"required":["price","price_type","website_id","sku","customer_group","quantity"]},"catalog-data-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\TierPriceInterface"},"catalog-data-base-price-interface":{"type":"object","description":"Price interface.","properties":{"price":{"type":"number","description":"Price."},"store_id":{"type":"integer","description":"Store id."},"sku":{"type":"string","description":"SKU."},"extension_attributes":{"$ref":"#/definitions/catalog-data-base-price-extension-interface"}},"required":["price","store_id","sku"]},"catalog-data-base-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\BasePriceInterface"},"catalog-data-cost-interface":{"type":"object","description":"Cost interface.","properties":{"cost":{"type":"number","description":"Cost value."},"store_id":{"type":"integer","description":"Store id."},"sku":{"type":"string","description":"SKU."},"extension_attributes":{"$ref":"#/definitions/catalog-data-cost-extension-interface"}},"required":["cost","store_id","sku"]},"catalog-data-cost-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CostInterface"},"catalog-data-special-price-interface":{"type":"object","description":"Product Special Price Interface is used to encapsulate data that can be processed by efficient price API.","properties":{"price":{"type":"number","description":"Product special price value."},"store_id":{"type":"integer","description":"ID of store, that contains special price value."},"sku":{"type":"string","description":"SKU of product, that contains special price value."},"price_from":{"type":"string","description":"Start date for special price in Y-m-d H:i:s format."},"price_to":{"type":"string","description":"End date for special price in Y-m-d H:i:s format."},"extension_attributes":{"$ref":"#/definitions/catalog-data-special-price-extension-interface"}},"required":["price","store_id","sku","price_from","price_to"]},"catalog-data-special-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\SpecialPriceInterface"},"catalog-data-category-interface":{"type":"object","description":"Category data interface.","properties":{"id":{"type":"integer","description":"Category id."},"parent_id":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"is_active":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"children":{"type":"string","description":"Children ids comma separated."},"created_at":{"type":"string","description":"Category creation date and time."},"updated_at":{"type":"string","description":"Category last update date and time."},"path":{"type":"string","description":"Category full path."},"available_sort_by":{"type":"array","description":"Available sort by for category.","items":{"type":"string"}},"include_in_menu":{"type":"boolean","description":"Category is included in menu."},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"position":{"type":"integer"},"category_id":{"type":"string","description":"Category id"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-product-link-extension-interface"}},"required":["category_id"]},"catalog-data-category-product-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryProductLinkInterface"},"catalog-data-product-website-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"website_id":{"type":"integer","description":"Website ids"}},"required":["sku","website_id"]},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"created_at":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updated_at":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"converted_at":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"is_active":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"is_virtual":{"type":"boolean","description":"Virtual flag value. Otherwise, null."},"items":{"type":"array","description":"Array of items. Otherwise, null.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"items_count":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"items_qty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billing_address":{"$ref":"#/definitions/quote-data-address-interface"},"reserved_order_id":{"type":"string","description":"Reserved order ID. Otherwise, null."},"orig_order_id":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customer_is_guest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customer_note":{"type":"string","description":"Notice text"},"customer_note_notify":{"type":"boolean","description":"Customer notification flag"},"customer_tax_class_id":{"type":"integer","description":"Customer tax class ID."},"store_id":{"type":"integer","description":"Store identifier"},"extension_attributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","store_id"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"item_id":{"type":"integer","description":"Item ID. Otherwise, null."},"sku":{"type":"string","description":"Product SKU. Otherwise, null."},"qty":{"type":"number","description":"Product quantity."},"name":{"type":"string","description":"Product name. Otherwise, null."},"price":{"type":"number","description":"Product price. Otherwise, null."},"product_type":{"type":"string","description":"Product type. Otherwise, null."},"quote_id":{"type":"string","description":"Quote id."},"product_option":{"$ref":"#/definitions/quote-data-product-option-interface"},"extension_attributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quote_id"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-product-option-extension-interface"}}},"quote-data-product-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ProductOptionInterface","properties":{"custom_options":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundle_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"option_id":{"type":"string","description":"Option id"},"option_value":{"type":"string","description":"Option value"},"extension_attributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["option_id","option_value"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"file_info":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"option_id":{"type":"integer","description":"Bundle option id."},"option_qty":{"type":"integer","description":"Bundle option quantity."},"option_selections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extension_attributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["option_id","option_qty","option_selections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"option_id":{"type":"string","description":"Option SKU"},"option_value":{"type":"integer","description":"Item id"},"extension_attributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["option_id"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadable_links":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadable_links"]},"gift-card-data-gift-card-option-interface":{"type":"object","description":"Interface GiftCardOptionInterface","properties":{"giftcard_amount":{"type":"string","description":"Gift card amount."},"custom_giftcard_amount":{"type":"number","description":"Gift card open amount value."},"giftcard_sender_name":{"type":"string","description":"Gift card sender name."},"giftcard_recipient_name":{"type":"string","description":"Gift card recipient name."},"giftcard_sender_email":{"type":"string","description":"Gift card sender email."},"giftcard_recipient_email":{"type":"string","description":"Gift card recipient email."},"giftcard_message":{"type":"string","description":"Giftcard message."},"extension_attributes":{"$ref":"#/definitions/gift-card-data-gift-card-option-extension-interface"}},"required":["giftcard_amount","giftcard_sender_name","giftcard_recipient_name","giftcard_sender_email","giftcard_recipient_email"]},"gift-card-data-gift-card-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftCardOptionInterface","properties":{"giftcard_created_codes":{"type":"array","items":{"type":"string"}}}},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"negotiable_quote_item":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-interface"}}},"sales-rule-data-rule-discount-interface":{"type":"object","description":"Rule discount Interface","properties":{"discount_data":{"$ref":"#/definitions/sales-rule-data-discount-data-interface"},"rule_label":{"type":"string","description":"Rule Label"},"rule_id":{"type":"integer","description":"Rule ID"}},"required":["discount_data","rule_label","rule_id"]},"sales-rule-data-discount-data-interface":{"type":"object","description":"Discount Data Interface","properties":{"amount":{"type":"number","description":"Amount"},"base_amount":{"type":"number","description":"Base Amount"},"original_amount":{"type":"number","description":"Original Amount"},"base_original_amount":{"type":"number","description":"Base Original Amount"}},"required":["amount","base_amount","original_amount","base_original_amount"]},"negotiable-quote-data-negotiable-quote-item-interface":{"type":"object","description":"Interface CompanyQuoteConfigInterface","properties":{"item_id":{"type":"integer","description":"Quote item id"},"original_price":{"type":"number","description":"Quote item original price"},"original_tax_amount":{"type":"number","description":"Quote item original tax amount"},"original_discount_amount":{"type":"number","description":"Quote item original discount amount"},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"}},"required":["item_id","original_price","original_tax_amount","original_discount_amount"]},"negotiable-quote-data-negotiable-quote-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"region_id":{"type":"integer","description":"Region id"},"region_code":{"type":"string","description":"Region code"},"country_id":{"type":"string","description":"Country id"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"customer_id":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"same_as_billing":{"type":"integer","description":"Same as billing flag"},"customer_address_id":{"type":"integer","description":"Customer address id"},"save_in_address_book":{"type":"integer","description":"Save in address book flag"},"extension_attributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","region_id","region_code","country_id","street","telephone","postcode","city","firstname","lastname","email"]},"quote-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\AddressInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"gift_registry_id":{"type":"integer"}}},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"global_currency_code":{"type":"string","description":"Global currency code"},"base_currency_code":{"type":"string","description":"Base currency code"},"store_currency_code":{"type":"string","description":"Store currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"store_to_base_rate":{"type":"number","description":"Store currency to base currency rate"},"store_to_quote_rate":{"type":"number","description":"Store currency to quote currency rate"},"base_to_global_rate":{"type":"number","description":"Base currency to global currency rate"},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate"},"extension_attributes":{"$ref":"#/definitions/quote-data-currency-extension-interface"}}},"quote-data-currency-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CurrencyInterface"},"quote-data-cart-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartInterface","properties":{"shipping_assignments":{"type":"array","items":{"$ref":"#/definitions/quote-data-shipping-assignment-interface"}},"negotiable_quote":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-interface"},"amazon_order_reference_id":{"$ref":"#/definitions/amazon-payment-data-quote-link-interface"}}},"quote-data-shipping-assignment-interface":{"type":"object","description":"Interface ShippingAssignmentInterface","properties":{"shipping":{"$ref":"#/definitions/quote-data-shipping-interface"},"items":{"type":"array","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-assignment-extension-interface"}},"required":["shipping","items"]},"quote-data-shipping-interface":{"type":"object","description":"Interface ShippingInterface","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"method":{"type":"string","description":"Shipping method"},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-extension-interface"}},"required":["address","method"]},"quote-data-shipping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingInterface"},"quote-data-shipping-assignment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingAssignmentInterface"},"negotiable-quote-data-negotiable-quote-interface":{"type":"object","description":"Interface NegotiableQuoteInterface","properties":{"quote_id":{"type":"integer","description":"Negotiable quote ID."},"is_regular_quote":{"type":"boolean","description":"Is regular quote."},"status":{"type":"string","description":"Negotiable quote status."},"negotiated_price_type":{"type":"integer","description":"Negotiated price type."},"negotiated_price_value":{"type":"number","description":"Negotiated price value."},"shipping_price":{"type":"number","description":"Proposed shipping price."},"quote_name":{"type":"string","description":"Negotiable quote name."},"expiration_period":{"type":"string","description":"Expiration period."},"email_notification_status":{"type":"integer","description":"Email notification status."},"has_unconfirmed_changes":{"type":"boolean","description":"Has unconfirmed changes."},"is_shipping_tax_changed":{"type":"boolean","description":"Shipping tax changes."},"is_customer_price_changed":{"type":"boolean","description":"Customer price changes."},"notifications":{"type":"integer","description":"Quote notifications."},"applied_rule_ids":{"type":"string","description":"Quote rules."},"is_address_draft":{"type":"boolean","description":"Is address draft."},"deleted_sku":{"type":"string","description":"Deleted products sku."},"creator_id":{"type":"integer","description":"Quote creator id."},"creator_type":{"type":"integer","description":"Quote creator type."},"original_total_price":{"type":"number","description":"Quote original total price."},"base_original_total_price":{"type":"number","description":"Quote original total price in base currency."},"negotiated_total_price":{"type":"number","description":"Quote negotiated total price."},"base_negotiated_total_price":{"type":"number","description":"Quote negotiated total price in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-extension-interface"}},"required":["quote_id","is_regular_quote","status","negotiated_price_type","negotiated_price_value","shipping_price","quote_name","expiration_period","email_notification_status","has_unconfirmed_changes","is_shipping_tax_changed","is_customer_price_changed","notifications","applied_rule_ids","is_address_draft","deleted_sku","creator_id","creator_type"]},"negotiable-quote-data-negotiable-quote-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteInterface"},"amazon-payment-data-quote-link-interface":{"type":"object","description":"","properties":{"id":{"type":"string"},"amazon_order_reference_id":{"type":"string","description":"Amazon order reference id"},"quote_id":{"type":"integer","description":"Quote id"},"sandbox_simulation_reference":{"type":"string","description":"Sandbox simulation reference"},"confirmed":{"type":"boolean","description":"Quote confirmed with amazon"}},"required":["id","amazon_order_reference_id","quote_id","sandbox_simulation_reference","confirmed"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"po_number":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additional_data":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/quote-data-payment-extension-interface"}},"required":["method"]},"quote-data-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\PaymentInterface","properties":{"agreement_ids":{"type":"array","items":{"type":"string"}}}},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"quote-data-totals-additional-data-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsAdditionalDataInterface","properties":{"gift_messages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"Interface MessageInterface","properties":{"gift_message_id":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customer_id":{"type":"integer","description":"Customer ID. Otherwise, null."},"sender":{"type":"string","description":"Sender name."},"recipient":{"type":"string","description":"Recipient name."},"message":{"type":"string","description":"Message text."},"extension_attributes":{"$ref":"#/definitions/gift-message-data-message-extension-interface"}},"required":["sender","recipient","message"]},"gift-message-data-message-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftMessage\\Api\\Data\\MessageInterface","properties":{"entity_id":{"type":"string"},"entity_type":{"type":"string"},"wrapping_id":{"type":"integer"},"wrapping_allow_gift_receipt":{"type":"boolean"},"wrapping_add_printed_card":{"type":"boolean"}}},"sales-data-order-interface":{"type":"object","description":"Order interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.","properties":{"adjustment_negative":{"type":"number","description":"Negative adjustment value."},"adjustment_positive":{"type":"number","description":"Positive adjustment value."},"applied_rule_ids":{"type":"string","description":"Applied rule IDs."},"base_adjustment_negative":{"type":"number","description":"Base negative adjustment value."},"base_adjustment_positive":{"type":"number","description":"Base positive adjustment value."},"base_currency_code":{"type":"string","description":"Base currency code."},"base_discount_amount":{"type":"number","description":"Base discount amount."},"base_discount_canceled":{"type":"number","description":"Base discount canceled."},"base_discount_invoiced":{"type":"number","description":"Base discount invoiced."},"base_discount_refunded":{"type":"number","description":"Base discount refunded."},"base_grand_total":{"type":"number","description":"Base grand total."},"base_discount_tax_compensation_amount":{"type":"number","description":"Base discount tax compensation amount."},"base_discount_tax_compensation_invoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"base_discount_tax_compensation_refunded":{"type":"number","description":"Base discount tax compensation refunded."},"base_shipping_amount":{"type":"number","description":"Base shipping amount."},"base_shipping_canceled":{"type":"number","description":"Base shipping canceled."},"base_shipping_discount_amount":{"type":"number","description":"Base shipping discount amount."},"base_shipping_discount_tax_compensation_amnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"base_shipping_incl_tax":{"type":"number","description":"Base shipping including tax."},"base_shipping_invoiced":{"type":"number","description":"Base shipping invoiced."},"base_shipping_refunded":{"type":"number","description":"Base shipping refunded."},"base_shipping_tax_amount":{"type":"number","description":"Base shipping tax amount."},"base_shipping_tax_refunded":{"type":"number","description":"Base shipping tax refunded."},"base_subtotal":{"type":"number","description":"Base subtotal."},"base_subtotal_canceled":{"type":"number","description":"Base subtotal canceled."},"base_subtotal_incl_tax":{"type":"number","description":"Base subtotal including tax."},"base_subtotal_invoiced":{"type":"number","description":"Base subtotal invoiced."},"base_subtotal_refunded":{"type":"number","description":"Base subtotal refunded."},"base_tax_amount":{"type":"number","description":"Base tax amount."},"base_tax_canceled":{"type":"number","description":"Base tax canceled."},"base_tax_invoiced":{"type":"number","description":"Base tax invoiced."},"base_tax_refunded":{"type":"number","description":"Base tax refunded."},"base_total_canceled":{"type":"number","description":"Base total canceled."},"base_total_due":{"type":"number","description":"Base total due."},"base_total_invoiced":{"type":"number","description":"Base total invoiced."},"base_total_invoiced_cost":{"type":"number","description":"Base total invoiced cost."},"base_total_offline_refunded":{"type":"number","description":"Base total offline refunded."},"base_total_online_refunded":{"type":"number","description":"Base total online refunded."},"base_total_paid":{"type":"number","description":"Base total paid."},"base_total_qty_ordered":{"type":"number","description":"Base total quantity ordered."},"base_total_refunded":{"type":"number","description":"Base total refunded."},"base_to_global_rate":{"type":"number","description":"Base-to-global rate."},"base_to_order_rate":{"type":"number","description":"Base-to-order rate."},"billing_address_id":{"type":"integer","description":"Billing address ID."},"can_ship_partially":{"type":"integer","description":"Can-ship-partially flag value."},"can_ship_partially_item":{"type":"integer","description":"Can-ship-partially-item flag value."},"coupon_code":{"type":"string","description":"Coupon code."},"created_at":{"type":"string","description":"Created-at timestamp."},"customer_dob":{"type":"string","description":"Customer date-of-birth (DOB)."},"customer_email":{"type":"string","description":"Customer email address."},"customer_firstname":{"type":"string","description":"Customer first name."},"customer_gender":{"type":"integer","description":"Customer gender."},"customer_group_id":{"type":"integer","description":"Customer group ID."},"customer_id":{"type":"integer","description":"Customer ID."},"customer_is_guest":{"type":"integer","description":"Customer-is-guest flag value."},"customer_lastname":{"type":"string","description":"Customer last name."},"customer_middlename":{"type":"string","description":"Customer middle name."},"customer_note":{"type":"string","description":"Customer note."},"customer_note_notify":{"type":"integer","description":"Customer-note-notify flag value."},"customer_prefix":{"type":"string","description":"Customer prefix."},"customer_suffix":{"type":"string","description":"Customer suffix."},"customer_taxvat":{"type":"string","description":"Customer value-added tax (VAT)."},"discount_amount":{"type":"number","description":"Discount amount."},"discount_canceled":{"type":"number","description":"Discount canceled."},"discount_description":{"type":"string","description":"Discount description."},"discount_invoiced":{"type":"number","description":"Discount invoiced."},"discount_refunded":{"type":"number","description":"Discount refunded amount."},"edit_increment":{"type":"integer","description":"Edit increment value."},"email_sent":{"type":"integer","description":"Email-sent flag value."},"entity_id":{"type":"integer","description":"Order ID."},"ext_customer_id":{"type":"string","description":"External customer ID."},"ext_order_id":{"type":"string","description":"External order ID."},"forced_shipment_with_invoice":{"type":"integer","description":"Forced-shipment-with-invoice flag value."},"global_currency_code":{"type":"string","description":"Global currency code."},"grand_total":{"type":"number","description":"Grand total."},"discount_tax_compensation_amount":{"type":"number","description":"Discount tax compensation amount."},"discount_tax_compensation_invoiced":{"type":"number","description":"Discount tax compensation invoiced amount."},"discount_tax_compensation_refunded":{"type":"number","description":"Discount tax compensation refunded amount."},"hold_before_state":{"type":"string","description":"Hold before state."},"hold_before_status":{"type":"string","description":"Hold before status."},"increment_id":{"type":"string","description":"Increment ID."},"is_virtual":{"type":"integer","description":"Is-virtual flag value."},"order_currency_code":{"type":"string","description":"Order currency code."},"original_increment_id":{"type":"string","description":"Original increment ID."},"payment_authorization_amount":{"type":"number","description":"Payment authorization amount."},"payment_auth_expiration":{"type":"integer","description":"Payment authorization expiration date."},"protect_code":{"type":"string","description":"Protect code."},"quote_address_id":{"type":"integer","description":"Quote address ID."},"quote_id":{"type":"integer","description":"Quote ID."},"relation_child_id":{"type":"string","description":"Relation child ID."},"relation_child_real_id":{"type":"string","description":"Relation child real ID."},"relation_parent_id":{"type":"string","description":"Relation parent ID."},"relation_parent_real_id":{"type":"string","description":"Relation parent real ID."},"remote_ip":{"type":"string","description":"Remote IP address."},"shipping_amount":{"type":"number","description":"Shipping amount."},"shipping_canceled":{"type":"number","description":"Shipping canceled amount."},"shipping_description":{"type":"string","description":"Shipping description."},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount."},"shipping_discount_tax_compensation_amount":{"type":"number","description":"Shipping discount tax compensation amount."},"shipping_incl_tax":{"type":"number","description":"Shipping including tax amount."},"shipping_invoiced":{"type":"number","description":"Shipping invoiced amount."},"shipping_refunded":{"type":"number","description":"Shipping refunded amount."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount."},"shipping_tax_refunded":{"type":"number","description":"Shipping tax refunded amount."},"state":{"type":"string","description":"State."},"status":{"type":"string","description":"Status."},"store_currency_code":{"type":"string","description":"Store currency code."},"store_id":{"type":"integer","description":"Store ID."},"store_name":{"type":"string","description":"Store name."},"store_to_base_rate":{"type":"number","description":"Store-to-base rate."},"store_to_order_rate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotal_canceled":{"type":"number","description":"Subtotal canceled amount."},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax amount."},"subtotal_invoiced":{"type":"number","description":"Subtotal invoiced amount."},"subtotal_refunded":{"type":"number","description":"Subtotal refunded amount."},"tax_amount":{"type":"number","description":"Tax amount."},"tax_canceled":{"type":"number","description":"Tax canceled amount."},"tax_invoiced":{"type":"number","description":"Tax invoiced amount."},"tax_refunded":{"type":"number","description":"Tax refunded amount."},"total_canceled":{"type":"number","description":"Total canceled."},"total_due":{"type":"number","description":"Total due."},"total_invoiced":{"type":"number","description":"Total invoiced amount."},"total_item_count":{"type":"integer","description":"Total item count."},"total_offline_refunded":{"type":"number","description":"Total offline refunded amount."},"total_online_refunded":{"type":"number","description":"Total online refunded amount."},"total_paid":{"type":"number","description":"Total paid."},"total_qty_ordered":{"type":"number","description":"Total quantity ordered."},"total_refunded":{"type":"number","description":"Total amount refunded."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"x_forwarded_for":{"type":"string","description":"X-Forwarded-For field value."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"billing_address":{"$ref":"#/definitions/sales-data-order-address-interface"},"payment":{"$ref":"#/definitions/sales-data-order-payment-interface"},"status_histories":{"type":"array","description":"Array of status histories.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-order-extension-interface"}},"required":["base_grand_total","customer_email","grand_total","items"]},"sales-data-order-item-interface":{"type":"object","description":"Order item interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.","properties":{"additional_data":{"type":"string","description":"Additional data."},"amount_refunded":{"type":"number","description":"Amount refunded."},"applied_rule_ids":{"type":"string","description":"Applied rule IDs."},"base_amount_refunded":{"type":"number","description":"Base amount refunded."},"base_cost":{"type":"number","description":"Base cost."},"base_discount_amount":{"type":"number","description":"Base discount amount."},"base_discount_invoiced":{"type":"number","description":"Base discount invoiced."},"base_discount_refunded":{"type":"number","description":"Base discount refunded."},"base_discount_tax_compensation_amount":{"type":"number","description":"Base discount tax compensation amount."},"base_discount_tax_compensation_invoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"base_discount_tax_compensation_refunded":{"type":"number","description":"Base discount tax compensation refunded."},"base_original_price":{"type":"number","description":"Base original price."},"base_price":{"type":"number","description":"Base price."},"base_price_incl_tax":{"type":"number","description":"Base price including tax."},"base_row_invoiced":{"type":"number","description":"Base row invoiced."},"base_row_total":{"type":"number","description":"Base row total."},"base_row_total_incl_tax":{"type":"number","description":"Base row total including tax."},"base_tax_amount":{"type":"number","description":"Base tax amount."},"base_tax_before_discount":{"type":"number","description":"Base tax before discount."},"base_tax_invoiced":{"type":"number","description":"Base tax invoiced."},"base_tax_refunded":{"type":"number","description":"Base tax refunded."},"base_weee_tax_applied_amount":{"type":"number","description":"Base WEEE tax applied amount."},"base_weee_tax_applied_row_amnt":{"type":"number","description":"Base WEEE tax applied row amount."},"base_weee_tax_disposition":{"type":"number","description":"Base WEEE tax disposition."},"base_weee_tax_row_disposition":{"type":"number","description":"Base WEEE tax row disposition."},"created_at":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"discount_amount":{"type":"number","description":"Discount amount."},"discount_invoiced":{"type":"number","description":"Discount invoiced."},"discount_percent":{"type":"number","description":"Discount percent."},"discount_refunded":{"type":"number","description":"Discount refunded."},"event_id":{"type":"integer","description":"Event ID."},"ext_order_item_id":{"type":"string","description":"External order item ID."},"free_shipping":{"type":"integer","description":"Free-shipping flag value."},"gw_base_price":{"type":"number","description":"GW base price."},"gw_base_price_invoiced":{"type":"number","description":"GW base price invoiced."},"gw_base_price_refunded":{"type":"number","description":"GW base price refunded."},"gw_base_tax_amount":{"type":"number","description":"GW base tax amount."},"gw_base_tax_amount_invoiced":{"type":"number","description":"GW base tax amount invoiced."},"gw_base_tax_amount_refunded":{"type":"number","description":"GW base tax amount refunded."},"gw_id":{"type":"integer","description":"GW ID."},"gw_price":{"type":"number","description":"GW price."},"gw_price_invoiced":{"type":"number","description":"GW price invoiced."},"gw_price_refunded":{"type":"number","description":"GW price refunded."},"gw_tax_amount":{"type":"number","description":"GW tax amount."},"gw_tax_amount_invoiced":{"type":"number","description":"GW tax amount invoiced."},"gw_tax_amount_refunded":{"type":"number","description":"GW tax amount refunded."},"discount_tax_compensation_amount":{"type":"number","description":"Discount tax compensation amount."},"discount_tax_compensation_canceled":{"type":"number","description":"Discount tax compensation canceled."},"discount_tax_compensation_invoiced":{"type":"number","description":"Discount tax compensation invoiced."},"discount_tax_compensation_refunded":{"type":"number","description":"Discount tax compensation refunded."},"is_qty_decimal":{"type":"integer","description":"Is-quantity-decimal flag value."},"is_virtual":{"type":"integer","description":"Is-virtual flag value."},"item_id":{"type":"integer","description":"Item ID."},"locked_do_invoice":{"type":"integer","description":"Locked DO invoice flag value."},"locked_do_ship":{"type":"integer","description":"Locked DO ship flag value."},"name":{"type":"string","description":"Name."},"no_discount":{"type":"integer","description":"No-discount flag value."},"order_id":{"type":"integer","description":"Order ID."},"original_price":{"type":"number","description":"Original price."},"parent_item_id":{"type":"integer","description":"Parent item ID."},"price":{"type":"number","description":"Price."},"price_incl_tax":{"type":"number","description":"Price including tax."},"product_id":{"type":"integer","description":"Product ID."},"product_type":{"type":"string","description":"Product type."},"qty_backordered":{"type":"number","description":"Quantity backordered."},"qty_canceled":{"type":"number","description":"Quantity canceled."},"qty_invoiced":{"type":"number","description":"Quantity invoiced."},"qty_ordered":{"type":"number","description":"Quantity ordered."},"qty_refunded":{"type":"number","description":"Quantity refunded."},"qty_returned":{"type":"number","description":"Quantity returned."},"qty_shipped":{"type":"number","description":"Quantity shipped."},"quote_item_id":{"type":"integer","description":"Quote item ID."},"row_invoiced":{"type":"number","description":"Row invoiced."},"row_total":{"type":"number","description":"Row total."},"row_total_incl_tax":{"type":"number","description":"Row total including tax."},"row_weight":{"type":"number","description":"Row weight."},"sku":{"type":"string","description":"SKU."},"store_id":{"type":"integer","description":"Store ID."},"tax_amount":{"type":"number","description":"Tax amount."},"tax_before_discount":{"type":"number","description":"Tax before discount."},"tax_canceled":{"type":"number","description":"Tax canceled."},"tax_invoiced":{"type":"number","description":"Tax invoiced."},"tax_percent":{"type":"number","description":"Tax percent."},"tax_refunded":{"type":"number","description":"Tax refunded."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"weee_tax_applied":{"type":"string","description":"WEEE tax applied."},"weee_tax_applied_amount":{"type":"number","description":"WEEE tax applied amount."},"weee_tax_applied_row_amount":{"type":"number","description":"WEEE tax applied row amount."},"weee_tax_disposition":{"type":"number","description":"WEEE tax disposition."},"weee_tax_row_disposition":{"type":"number","description":"WEEE tax row disposition."},"weight":{"type":"number","description":"Weight."},"parent_item":{"$ref":"#/definitions/sales-data-order-item-interface"},"product_option":{"$ref":"#/definitions/catalog-data-product-option-interface"},"extension_attributes":{"$ref":"#/definitions/sales-data-order-item-extension-interface"}},"required":["sku"]},"catalog-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extension_attributes":{"$ref":"#/definitions/catalog-data-product-option-extension-interface"}}},"catalog-data-product-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductOptionInterface","properties":{"custom_options":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundle_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"}}},"sales-data-order-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderItemInterface","properties":{"gift_message":{"$ref":"#/definitions/gift-message-data-message-interface"},"gw_id":{"type":"string"},"gw_base_price":{"type":"string"},"gw_price":{"type":"string"},"gw_base_tax_amount":{"type":"string"},"gw_tax_amount":{"type":"string"},"gw_base_price_invoiced":{"type":"string"},"gw_price_invoiced":{"type":"string"},"gw_base_tax_amount_invoiced":{"type":"string"},"gw_tax_amount_invoiced":{"type":"string"},"gw_base_price_refunded":{"type":"string"},"gw_price_refunded":{"type":"string"},"gw_base_tax_amount_refunded":{"type":"string"},"gw_tax_amount_refunded":{"type":"string"},"vertex_tax_codes":{"type":"array","items":{"type":"string"}},"invoice_text_codes":{"type":"array","items":{"type":"string"}},"tax_codes":{"type":"array","items":{"type":"string"}}}},"sales-data-order-address-interface":{"type":"object","description":"Order address interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.","properties":{"address_type":{"type":"string","description":"Address type."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company."},"country_id":{"type":"string","description":"Country ID."},"customer_address_id":{"type":"integer","description":"Country address ID."},"customer_id":{"type":"integer","description":"Customer ID."},"email":{"type":"string","description":"Email address."},"entity_id":{"type":"integer","description":"Order address ID."},"fax":{"type":"string","description":"Fax number."},"firstname":{"type":"string","description":"First name."},"lastname":{"type":"string","description":"Last name."},"middlename":{"type":"string","description":"Middle name."},"parent_id":{"type":"integer","description":"Parent ID."},"postcode":{"type":"string","description":"Postal code."},"prefix":{"type":"string","description":"Prefix."},"region":{"type":"string","description":"Region."},"region_code":{"type":"string","description":"Region code."},"region_id":{"type":"integer","description":"Region ID."},"street":{"type":"array","description":"Array of any street values. Otherwise, null.","items":{"type":"string"}},"suffix":{"type":"string","description":"Suffix."},"telephone":{"type":"string","description":"Telephone number."},"vat_id":{"type":"string","description":"VAT ID."},"vat_is_valid":{"type":"integer","description":"VAT-is-valid flag value."},"vat_request_date":{"type":"string","description":"VAT request date."},"vat_request_id":{"type":"string","description":"VAT request ID."},"vat_request_success":{"type":"integer","description":"VAT-request-success flag value."},"extension_attributes":{"$ref":"#/definitions/sales-data-order-address-extension-interface"}},"required":["address_type","city","country_id","firstname","lastname","postcode","telephone"]},"sales-data-order-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderAddressInterface"},"sales-data-order-payment-interface":{"type":"object","description":"Order payment interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.","properties":{"account_status":{"type":"string","description":"Account status."},"additional_data":{"type":"string","description":"Additional data."},"additional_information":{"type":"array","description":"Array of additional information.","items":{"type":"string"}},"address_status":{"type":"string","description":"Address status."},"amount_authorized":{"type":"number","description":"Amount authorized."},"amount_canceled":{"type":"number","description":"Amount canceled."},"amount_ordered":{"type":"number","description":"Amount ordered."},"amount_paid":{"type":"number","description":"Amount paid."},"amount_refunded":{"type":"number","description":"Amount refunded."},"anet_trans_method":{"type":"string","description":"Anet transaction method."},"base_amount_authorized":{"type":"number","description":"Base amount authorized."},"base_amount_canceled":{"type":"number","description":"Base amount canceled."},"base_amount_ordered":{"type":"number","description":"Base amount ordered."},"base_amount_paid":{"type":"number","description":"Base amount paid."},"base_amount_paid_online":{"type":"number","description":"Base amount paid online."},"base_amount_refunded":{"type":"number","description":"Base amount refunded."},"base_amount_refunded_online":{"type":"number","description":"Base amount refunded online."},"base_shipping_amount":{"type":"number","description":"Base shipping amount."},"base_shipping_captured":{"type":"number","description":"Base shipping captured amount."},"base_shipping_refunded":{"type":"number","description":"Base shipping refunded amount."},"cc_approval":{"type":"string","description":"Credit card approval."},"cc_avs_status":{"type":"string","description":"Credit card avs status."},"cc_cid_status":{"type":"string","description":"Credit card CID status."},"cc_debug_request_body":{"type":"string","description":"Credit card debug request body."},"cc_debug_response_body":{"type":"string","description":"Credit card debug response body."},"cc_debug_response_serialized":{"type":"string","description":"Credit card debug response serialized."},"cc_exp_month":{"type":"string","description":"Credit card expiration month."},"cc_exp_year":{"type":"string","description":"Credit card expiration year."},"cc_last4":{"type":"string","description":"Last four digits of the credit card."},"cc_number_enc":{"type":"string","description":"Encrypted credit card number."},"cc_owner":{"type":"string","description":"Credit card number."},"cc_secure_verify":{"type":"string","description":"Credit card secure verify."},"cc_ss_issue":{"type":"string","description":"Credit card SS issue."},"cc_ss_start_month":{"type":"string","description":"Credit card SS start month."},"cc_ss_start_year":{"type":"string","description":"Credit card SS start year."},"cc_status":{"type":"string","description":"Credit card status."},"cc_status_description":{"type":"string","description":"Credit card status description."},"cc_trans_id":{"type":"string","description":"Credit card transaction ID."},"cc_type":{"type":"string","description":"Credit card type."},"echeck_account_name":{"type":"string","description":"eCheck account name."},"echeck_account_type":{"type":"string","description":"eCheck account type."},"echeck_bank_name":{"type":"string","description":"eCheck bank name."},"echeck_routing_number":{"type":"string","description":"eCheck routing number."},"echeck_type":{"type":"string","description":"eCheck type."},"entity_id":{"type":"integer","description":"Entity ID."},"last_trans_id":{"type":"string","description":"Last transaction ID."},"method":{"type":"string","description":"Method."},"parent_id":{"type":"integer","description":"Parent ID."},"po_number":{"type":"string","description":"PO number."},"protection_eligibility":{"type":"string","description":"Protection eligibility."},"quote_payment_id":{"type":"integer","description":"Quote payment ID."},"shipping_amount":{"type":"number","description":"Shipping amount."},"shipping_captured":{"type":"number","description":"Shipping captured."},"shipping_refunded":{"type":"number","description":"Shipping refunded."},"extension_attributes":{"$ref":"#/definitions/sales-data-order-payment-extension-interface"}},"required":["account_status","additional_information","cc_last4","method"]},"sales-data-order-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderPaymentInterface","properties":{"vault_payment_token":{"$ref":"#/definitions/vault-data-payment-token-interface"}}},"vault-data-payment-token-interface":{"type":"object","description":"Gateway vault payment token interface.","properties":{"entity_id":{"type":"integer","description":"Entity ID."},"customer_id":{"type":"integer","description":"Customer ID."},"public_hash":{"type":"string","description":"Public hash"},"payment_method_code":{"type":"string","description":"Payment method code"},"type":{"type":"string","description":"Type"},"created_at":{"type":"string","description":"Token creation timestamp"},"expires_at":{"type":"string","description":"Token expiration timestamp"},"gateway_token":{"type":"string","description":"Gateway token ID"},"token_details":{"type":"string","description":"Token details"},"is_active":{"type":"boolean","description":"Is active."},"is_visible":{"type":"boolean","description":"Is visible."}},"required":["public_hash","payment_method_code","type","gateway_token","token_details","is_active","is_visible"]},"sales-data-order-status-history-interface":{"type":"object","description":"Order status history interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.","properties":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Order status history ID."},"entity_name":{"type":"string","description":"Entity name."},"is_customer_notified":{"type":"integer","description":"Is-customer-notified flag value."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parent_id":{"type":"integer","description":"Parent ID."},"status":{"type":"string","description":"Status."},"extension_attributes":{"$ref":"#/definitions/sales-data-order-status-history-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"sales-data-order-status-history-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderStatusHistoryInterface"},"sales-data-order-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderInterface","properties":{"shipping_assignments":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipping-assignment-interface"}},"payment_additional_info":{"type":"array","items":{"$ref":"#/definitions/payment-data-payment-additional-info-interface"}},"applied_taxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"item_applied_taxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-item-interface"}},"converting_from_quote":{"type":"boolean"},"company_order_attributes":{"$ref":"#/definitions/company-data-company-order-interface"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"base_customer_balance_invoiced":{"type":"number"},"customer_balance_invoiced":{"type":"number"},"base_customer_balance_refunded":{"type":"number"},"customer_balance_refunded":{"type":"number"},"base_customer_balance_total_refunded":{"type":"number"},"customer_balance_total_refunded":{"type":"number"},"gift_cards":{"type":"array","items":{"$ref":"#/definitions/gift-card-account-data-gift-card-interface"}},"base_gift_cards_amount":{"type":"number"},"gift_cards_amount":{"type":"number"},"base_gift_cards_invoiced":{"type":"number"},"gift_cards_invoiced":{"type":"number"},"base_gift_cards_refunded":{"type":"number"},"gift_cards_refunded":{"type":"number"},"gift_message":{"$ref":"#/definitions/gift-message-data-message-interface"},"gw_id":{"type":"string"},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_base_price":{"type":"string"},"gw_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_card_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_base_tax_amount":{"type":"string"},"gw_tax_amount":{"type":"string"},"gw_items_base_tax_amount":{"type":"string"},"gw_items_tax_amount":{"type":"string"},"gw_card_base_tax_amount":{"type":"string"},"gw_card_tax_amount":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_base_price_invoiced":{"type":"string"},"gw_price_invoiced":{"type":"string"},"gw_items_base_price_invoiced":{"type":"string"},"gw_items_price_invoiced":{"type":"string"},"gw_card_base_price_invoiced":{"type":"string"},"gw_card_price_invoiced":{"type":"string"},"gw_base_tax_amount_invoiced":{"type":"string"},"gw_tax_amount_invoiced":{"type":"string"},"gw_items_base_tax_invoiced":{"type":"string"},"gw_items_tax_invoiced":{"type":"string"},"gw_card_base_tax_invoiced":{"type":"string"},"gw_card_tax_invoiced":{"type":"string"},"gw_base_price_refunded":{"type":"string"},"gw_price_refunded":{"type":"string"},"gw_items_base_price_refunded":{"type":"string"},"gw_items_price_refunded":{"type":"string"},"gw_card_base_price_refunded":{"type":"string"},"gw_card_price_refunded":{"type":"string"},"gw_base_tax_amount_refunded":{"type":"string"},"gw_tax_amount_refunded":{"type":"string"},"gw_items_base_tax_refunded":{"type":"string"},"gw_items_tax_refunded":{"type":"string"},"gw_card_base_tax_refunded":{"type":"string"},"gw_card_tax_refunded":{"type":"string"},"reward_points_balance":{"type":"integer"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"},"amazon_order_reference_id":{"$ref":"#/definitions/amazon-payment-data-order-link-interface"}}},"sales-data-shipping-assignment-interface":{"type":"object","description":"Interface ShippingAssignmentInterface","properties":{"shipping":{"$ref":"#/definitions/sales-data-shipping-interface"},"items":{"type":"array","description":"Order items of shipping assignment","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"stock_id":{"type":"integer","description":"Stock id"},"extension_attributes":{"$ref":"#/definitions/sales-data-shipping-assignment-extension-interface"}},"required":["shipping","items"]},"sales-data-shipping-interface":{"type":"object","description":"Interface ShippingInterface","properties":{"address":{"$ref":"#/definitions/sales-data-order-address-interface"},"method":{"type":"string","description":"Shipping method"},"total":{"$ref":"#/definitions/sales-data-total-interface"},"extension_attributes":{"$ref":"#/definitions/sales-data-shipping-extension-interface"}}},"sales-data-total-interface":{"type":"object","description":"Interface TotalInterface","properties":{"base_shipping_amount":{"type":"number","description":"Base shipping amount."},"base_shipping_canceled":{"type":"number","description":"Base shipping canceled."},"base_shipping_discount_amount":{"type":"number","description":"Base shipping discount amount."},"base_shipping_discount_tax_compensation_amnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"base_shipping_incl_tax":{"type":"number","description":"Base shipping including tax."},"base_shipping_invoiced":{"type":"number","description":"Base shipping invoiced."},"base_shipping_refunded":{"type":"number","description":"Base shipping refunded."},"base_shipping_tax_amount":{"type":"number","description":"Base shipping tax amount."},"base_shipping_tax_refunded":{"type":"number","description":"Base shipping tax refunded."},"shipping_amount":{"type":"number","description":"Shipping amount."},"shipping_canceled":{"type":"number","description":"Shipping canceled amount."},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount."},"shipping_discount_tax_compensation_amount":{"type":"number","description":"Shipping discount tax compensation amount."},"shipping_incl_tax":{"type":"number","description":"Shipping including tax amount."},"shipping_invoiced":{"type":"number","description":"Shipping invoiced amount."},"shipping_refunded":{"type":"number","description":"Shipping refunded amount."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount."},"shipping_tax_refunded":{"type":"number","description":"Shipping tax refunded amount."},"extension_attributes":{"$ref":"#/definitions/sales-data-total-extension-interface"}}},"sales-data-total-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TotalInterface"},"sales-data-shipping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShippingInterface"},"sales-data-shipping-assignment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShippingAssignmentInterface"},"payment-data-payment-additional-info-interface":{"type":"object","description":"Payment additional info interface.","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"tax-data-order-tax-details-applied-tax-interface":{"type":"object","description":"Interface OrderTaxDetailsAppliedTaxInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"amount":{"type":"number","description":"Tax amount"},"base_amount":{"type":"number","description":"Tax amount in base currency"},"extension_attributes":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"}},"required":["amount","base_amount"]},"tax-data-order-tax-details-applied-tax-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsAppliedTaxInterface","properties":{"rates":{"type":"array","items":{"$ref":"#/definitions/tax-data-applied-tax-rate-interface"}}}},"tax-data-applied-tax-rate-interface":{"type":"object","description":"Applied tax rate interface.","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"extension_attributes":{"$ref":"#/definitions/tax-data-applied-tax-rate-extension-interface"}}},"tax-data-applied-tax-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\AppliedTaxRateInterface"},"tax-data-order-tax-details-item-interface":{"type":"object","description":"Interface OrderTaxDetailsItemInterface","properties":{"type":{"type":"string","description":"Type (shipping, product, weee, gift wrapping, etc)"},"item_id":{"type":"integer","description":"Item id if this item is a product"},"associated_item_id":{"type":"integer","description":"Associated item id if this item is associated with another item, null otherwise"},"applied_taxes":{"type":"array","description":"Applied taxes","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"extension_attributes":{"$ref":"#/definitions/tax-data-order-tax-details-item-extension-interface"}}},"tax-data-order-tax-details-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsItemInterface"},"company-data-company-order-interface":{"type":"object","description":"Order company extension attributes interface. Adds new company attributes to orders.","properties":{"order_id":{"type":"integer","description":"Order ID."},"company_id":{"type":"integer","description":"Company ID."},"company_name":{"type":"string","description":"Company name."},"extension_attributes":{"$ref":"#/definitions/company-data-company-order-extension-interface"}}},"company-data-company-order-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\CompanyOrderInterface"},"gift-card-account-data-gift-card-interface":{"type":"object","description":"Gift Card data","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"amount":{"type":"number","description":"Amount"},"base_amount":{"type":"number","description":"Base Amount"}},"required":["id","code","amount","base_amount"]},"amazon-payment-data-order-link-interface":{"type":"object","description":"","properties":{"amazon_order_reference_id":{"type":"string","description":"Amazon order reference id"},"order_id":{"type":"integer","description":"Order id"}},"required":["amazon_order_reference_id","order_id"]},"sales-data-invoice-interface":{"type":"object","description":"Invoice interface. An invoice is a record of the receipt of payment for an order.","properties":{"base_currency_code":{"type":"string","description":"Base currency code."},"base_discount_amount":{"type":"number","description":"Base discount amount."},"base_grand_total":{"type":"number","description":"Base grand total."},"base_discount_tax_compensation_amount":{"type":"number","description":"Base discount tax compensation amount."},"base_shipping_amount":{"type":"number","description":"Base shipping amount."},"base_shipping_discount_tax_compensation_amnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"base_shipping_incl_tax":{"type":"number","description":"Base shipping including tax."},"base_shipping_tax_amount":{"type":"number","description":"Base shipping tax amount."},"base_subtotal":{"type":"number","description":"Base subtotal."},"base_subtotal_incl_tax":{"type":"number","description":"Base subtotal including tax."},"base_tax_amount":{"type":"number","description":"Base tax amount."},"base_total_refunded":{"type":"number","description":"Base total refunded."},"base_to_global_rate":{"type":"number","description":"Base-to-global rate."},"base_to_order_rate":{"type":"number","description":"Base-to-order rate."},"billing_address_id":{"type":"integer","description":"Billing address ID."},"can_void_flag":{"type":"integer","description":"Can void flag value."},"created_at":{"type":"string","description":"Created-at timestamp."},"discount_amount":{"type":"number","description":"Discount amount."},"discount_description":{"type":"string","description":"Discount description."},"email_sent":{"type":"integer","description":"Email-sent flag value."},"entity_id":{"type":"integer","description":"Invoice ID."},"global_currency_code":{"type":"string","description":"Global currency code."},"grand_total":{"type":"number","description":"Grand total."},"discount_tax_compensation_amount":{"type":"number","description":"Discount tax compensation amount."},"increment_id":{"type":"string","description":"Increment ID."},"is_used_for_refund":{"type":"integer","description":"Is-used-for-refund flag value."},"order_currency_code":{"type":"string","description":"Order currency code."},"order_id":{"type":"integer","description":"Order ID."},"shipping_address_id":{"type":"integer","description":"Shipping address ID."},"shipping_amount":{"type":"number","description":"Shipping amount."},"shipping_discount_tax_compensation_amount":{"type":"number","description":"Shipping discount tax compensation amount."},"shipping_incl_tax":{"type":"number","description":"Shipping including tax."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount."},"state":{"type":"integer","description":"State."},"store_currency_code":{"type":"string","description":"Store currency code."},"store_id":{"type":"integer","description":"Store ID."},"store_to_base_rate":{"type":"number","description":"Store-to-base rate."},"store_to_order_rate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax."},"tax_amount":{"type":"number","description":"Tax amount."},"total_qty":{"type":"number","description":"Total quantity."},"transaction_id":{"type":"string","description":"Transaction ID."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"items":{"type":"array","description":"Array of invoice items.","items":{"$ref":"#/definitions/sales-data-invoice-item-interface"}},"comments":{"type":"array","description":"Array of any invoice comments. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-extension-interface"}},"required":["order_id","total_qty","items"]},"sales-data-invoice-item-interface":{"type":"object","description":"Invoice item interface. An invoice is a record of the receipt of payment for an order. An invoice item is a purchased item in an invoice.","properties":{"additional_data":{"type":"string","description":"Additional data."},"base_cost":{"type":"number","description":"Base cost."},"base_discount_amount":{"type":"number","description":"Base discount amount."},"base_discount_tax_compensation_amount":{"type":"number","description":"Base discount tax compensation amount."},"base_price":{"type":"number","description":"Base price."},"base_price_incl_tax":{"type":"number","description":"Base price including tax."},"base_row_total":{"type":"number","description":"Base row total."},"base_row_total_incl_tax":{"type":"number","description":"Base row total including tax."},"base_tax_amount":{"type":"number","description":"Base tax amount."},"description":{"type":"string","description":"Description."},"discount_amount":{"type":"number","description":"Discount amount."},"entity_id":{"type":"integer","description":"Invoice item ID."},"discount_tax_compensation_amount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"parent_id":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"price_incl_tax":{"type":"number","description":"Price including tax."},"product_id":{"type":"integer","description":"Product ID."},"row_total":{"type":"number","description":"Row total."},"row_total_incl_tax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"tax_amount":{"type":"number","description":"Tax amount."},"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"},"order_item_id":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["sku","order_item_id","qty"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface","properties":{"vertex_tax_codes":{"type":"array","items":{"type":"string"}},"invoice_text_codes":{"type":"array","items":{"type":"string"}},"tax_codes":{"type":"array","items":{"type":"string"}}}},"sales-data-invoice-comment-interface":{"type":"object","description":"Invoice comment interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.","properties":{"is_customer_notified":{"type":"integer","description":"Is-customer-notified flag value."},"parent_id":{"type":"integer","description":"Parent ID."},"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Invoice ID."}},"required":["is_customer_notified","parent_id","comment","is_visible_on_front"]},"sales-data-invoice-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceCommentInterface"},"sales-data-invoice-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceInterface","properties":{"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"base_gift_cards_amount":{"type":"number"},"gift_cards_amount":{"type":"number"},"gw_base_price":{"type":"string"},"gw_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_card_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_base_tax_amount":{"type":"string"},"gw_tax_amount":{"type":"string"},"gw_items_base_tax_amount":{"type":"string"},"gw_items_tax_amount":{"type":"string"},"gw_card_base_tax_amount":{"type":"string"},"gw_card_tax_amount":{"type":"string"},"vertex_tax_calculation_shipping_address":{"$ref":"#/definitions/sales-data-order-address-interface"},"vertex_tax_calculation_billing_address":{"$ref":"#/definitions/sales-data-order-address-interface"},"vertex_tax_calculation_order":{"$ref":"#/definitions/sales-data-order-interface"}}},"sales-data-creditmemo-item-creation-interface":{"type":"object","description":"Interface CreditmemoItemCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-item-creation-extension-interface"},"order_item_id":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["order_item_id","qty"]},"sales-data-creditmemo-item-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemCreationInterface"},"sales-data-creditmemo-comment-creation-interface":{"type":"object","description":"Interface CreditmemoCommentCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","is_visible_on_front"]},"sales-data-creditmemo-comment-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentCreationInterface"},"sales-data-creditmemo-creation-arguments-interface":{"type":"object","description":"Interface CreditmemoCreationArgumentsInterface","properties":{"shipping_amount":{"type":"number","description":"Credit memo shipping amount."},"adjustment_positive":{"type":"number","description":"Credit memo positive adjustment."},"adjustment_negative":{"type":"number","description":"Credit memo negative adjustment."},"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-creation-arguments-extension-interface"}}},"sales-data-creditmemo-creation-arguments-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCreationArgumentsInterface","properties":{"return_to_stock_items":{"type":"array","items":{"type":"integer"}}}},"sales-data-creditmemo-interface":{"type":"object","description":"Credit memo interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.","properties":{"adjustment":{"type":"number","description":"Credit memo adjustment."},"adjustment_negative":{"type":"number","description":"Credit memo negative adjustment."},"adjustment_positive":{"type":"number","description":"Credit memo positive adjustment."},"base_adjustment":{"type":"number","description":"Credit memo base adjustment."},"base_adjustment_negative":{"type":"number","description":"Credit memo negative base adjustment."},"base_adjustment_positive":{"type":"number","description":"Credit memo positive base adjustment."},"base_currency_code":{"type":"string","description":"Credit memo base currency code."},"base_discount_amount":{"type":"number","description":"Credit memo base discount amount."},"base_grand_total":{"type":"number","description":"Credit memo base grand total."},"base_discount_tax_compensation_amount":{"type":"number","description":"Credit memo base discount tax compensation amount."},"base_shipping_amount":{"type":"number","description":"Credit memo base shipping amount."},"base_shipping_discount_tax_compensation_amnt":{"type":"number","description":"Credit memo base shipping discount tax compensation amount."},"base_shipping_incl_tax":{"type":"number","description":"Credit memo base shipping including tax."},"base_shipping_tax_amount":{"type":"number","description":"Credit memo base shipping tax amount."},"base_subtotal":{"type":"number","description":"Credit memo base subtotal."},"base_subtotal_incl_tax":{"type":"number","description":"Credit memo base subtotal including tax."},"base_tax_amount":{"type":"number","description":"Credit memo base tax amount."},"base_to_global_rate":{"type":"number","description":"Credit memo base-to-global rate."},"base_to_order_rate":{"type":"number","description":"Credit memo base-to-order rate."},"billing_address_id":{"type":"integer","description":"Credit memo billing address ID."},"created_at":{"type":"string","description":"Credit memo created-at timestamp."},"creditmemo_status":{"type":"integer","description":"Credit memo status."},"discount_amount":{"type":"number","description":"Credit memo discount amount."},"discount_description":{"type":"string","description":"Credit memo discount description."},"email_sent":{"type":"integer","description":"Credit memo email sent flag value."},"entity_id":{"type":"integer","description":"Credit memo ID."},"global_currency_code":{"type":"string","description":"Credit memo global currency code."},"grand_total":{"type":"number","description":"Credit memo grand total."},"discount_tax_compensation_amount":{"type":"number","description":"Credit memo discount tax compensation amount."},"increment_id":{"type":"string","description":"Credit memo increment ID."},"invoice_id":{"type":"integer","description":"Credit memo invoice ID."},"order_currency_code":{"type":"string","description":"Credit memo order currency code."},"order_id":{"type":"integer","description":"Credit memo order ID."},"shipping_address_id":{"type":"integer","description":"Credit memo shipping address ID."},"shipping_amount":{"type":"number","description":"Credit memo shipping amount."},"shipping_discount_tax_compensation_amount":{"type":"number","description":"Credit memo shipping discount tax compensation amount."},"shipping_incl_tax":{"type":"number","description":"Credit memo shipping including tax."},"shipping_tax_amount":{"type":"number","description":"Credit memo shipping tax amount."},"state":{"type":"integer","description":"Credit memo state."},"store_currency_code":{"type":"string","description":"Credit memo store currency code."},"store_id":{"type":"integer","description":"Credit memo store ID."},"store_to_base_rate":{"type":"number","description":"Credit memo store-to-base rate."},"store_to_order_rate":{"type":"number","description":"Credit memo store-to-order rate."},"subtotal":{"type":"number","description":"Credit memo subtotal."},"subtotal_incl_tax":{"type":"number","description":"Credit memo subtotal including tax."},"tax_amount":{"type":"number","description":"Credit memo tax amount."},"transaction_id":{"type":"string","description":"Credit memo transaction ID."},"updated_at":{"type":"string","description":"Credit memo updated-at timestamp."},"items":{"type":"array","description":"Array of credit memo items.","items":{"$ref":"#/definitions/sales-data-creditmemo-item-interface"}},"comments":{"type":"array","description":"Array of any credit memo comments. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-extension-interface"}},"required":["order_id","items"]},"sales-data-creditmemo-item-interface":{"type":"object","description":"Credit memo item interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo.","properties":{"additional_data":{"type":"string","description":"Additional data."},"base_cost":{"type":"number","description":"The base cost for a credit memo item."},"base_discount_amount":{"type":"number","description":"The base discount amount for a credit memo item."},"base_discount_tax_compensation_amount":{"type":"number","description":"The base discount tax compensation amount for a credit memo item."},"base_price":{"type":"number","description":"The base price for a credit memo item."},"base_price_incl_tax":{"type":"number","description":"Base price including tax."},"base_row_total":{"type":"number","description":"Base row total."},"base_row_total_incl_tax":{"type":"number","description":"Base row total including tax."},"base_tax_amount":{"type":"number","description":"Base tax amount."},"base_weee_tax_applied_amount":{"type":"number","description":"Base WEEE tax applied amount."},"base_weee_tax_applied_row_amnt":{"type":"number","description":"Base WEEE tax applied row amount."},"base_weee_tax_disposition":{"type":"number","description":"Base WEEE tax disposition."},"base_weee_tax_row_disposition":{"type":"number","description":"Base WEEE tax row disposition."},"description":{"type":"string","description":"Description."},"discount_amount":{"type":"number","description":"Discount amount."},"entity_id":{"type":"integer","description":"Credit memo item ID."},"discount_tax_compensation_amount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"order_item_id":{"type":"integer","description":"Order item ID."},"parent_id":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"price_incl_tax":{"type":"number","description":"Price including tax."},"product_id":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"row_total":{"type":"number","description":"Row total."},"row_total_incl_tax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"tax_amount":{"type":"number","description":"Tax amount."},"weee_tax_applied":{"type":"string","description":"WEEE tax applied."},"weee_tax_applied_amount":{"type":"number","description":"WEEE tax applied amount."},"weee_tax_applied_row_amount":{"type":"number","description":"WEEE tax applied row amount."},"weee_tax_disposition":{"type":"number","description":"WEEE tax disposition."},"weee_tax_row_disposition":{"type":"number","description":"WEEE tax row disposition."},"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-item-extension-interface"}},"required":["base_cost","base_price","entity_id","order_item_id","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface","properties":{"vertex_tax_codes":{"type":"array","items":{"type":"string"}},"invoice_text_codes":{"type":"array","items":{"type":"string"}},"tax_codes":{"type":"array","items":{"type":"string"}}}},"sales-data-creditmemo-comment-interface":{"type":"object","description":"Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.","properties":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Credit memo ID."},"is_customer_notified":{"type":"integer","description":"Is-customer-notified flag value."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parent_id":{"type":"integer","description":"Parent ID."},"extension_attributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"sales-data-creditmemo-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface","properties":{"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"base_gift_cards_amount":{"type":"number"},"gift_cards_amount":{"type":"number"},"gw_base_price":{"type":"string"},"gw_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_card_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_base_tax_amount":{"type":"string"},"gw_tax_amount":{"type":"string"},"gw_items_base_tax_amount":{"type":"string"},"gw_items_tax_amount":{"type":"string"},"gw_card_base_tax_amount":{"type":"string"},"gw_card_tax_amount":{"type":"string"}}},"sales-data-shipment-interface":{"type":"object","description":"Shipment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.","properties":{"billing_address_id":{"type":"integer","description":"Billing address ID."},"created_at":{"type":"string","description":"Created-at timestamp."},"customer_id":{"type":"integer","description":"Customer ID."},"email_sent":{"type":"integer","description":"Email-sent flag value."},"entity_id":{"type":"integer","description":"Shipment ID."},"increment_id":{"type":"string","description":"Increment ID."},"order_id":{"type":"integer","description":"Order ID."},"packages":{"type":"array","description":"Array of packages, if any. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-shipment-package-interface"}},"shipment_status":{"type":"integer","description":"Shipment status."},"shipping_address_id":{"type":"integer","description":"Shipping address ID."},"shipping_label":{"type":"string","description":"Shipping label."},"store_id":{"type":"integer","description":"Store ID."},"total_qty":{"type":"number","description":"Total quantity."},"total_weight":{"type":"number","description":"Total weight."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-shipment-item-interface"}},"tracks":{"type":"array","description":"Array of tracks.","items":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"comments":{"type":"array","description":"Array of comments.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-extension-interface"}},"required":["order_id","items","tracks","comments"]},"sales-data-shipment-package-interface":{"type":"object","description":"Shipment package interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-package-extension-interface"}}},"sales-data-shipment-package-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentPackageInterface"},"sales-data-shipment-item-interface":{"type":"object","description":"Shipment item interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A product is an item in a shipment.","properties":{"additional_data":{"type":"string","description":"Additional data."},"description":{"type":"string","description":"Description."},"entity_id":{"type":"integer","description":"Shipment item ID."},"name":{"type":"string","description":"Name."},"parent_id":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"product_id":{"type":"integer","description":"Product ID."},"row_total":{"type":"number","description":"Row total."},"sku":{"type":"string","description":"SKU."},"weight":{"type":"number","description":"Weight."},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-item-extension-interface"},"order_item_id":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["order_item_id","qty"]},"sales-data-shipment-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentItemInterface"},"sales-data-shipment-track-interface":{"type":"object","description":"Shipment track interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. Merchants and customers can track shipments.","properties":{"order_id":{"type":"integer","description":"The order_id for the shipment package."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Shipment package ID."},"parent_id":{"type":"integer","description":"Parent ID."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"qty":{"type":"number","description":"Quantity."},"description":{"type":"string","description":"Description."},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"},"track_number":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrier_code":{"type":"string","description":"Carrier code."}},"required":["order_id","parent_id","weight","qty","description","track_number","title","carrier_code"]},"sales-data-shipment-track-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentTrackInterface"},"sales-data-shipment-comment-interface":{"type":"object","description":"Shipment comment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.","properties":{"is_customer_notified":{"type":"integer","description":"Is-customer-notified flag value."},"parent_id":{"type":"integer","description":"Parent ID."},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Invoice ID."}},"required":["is_customer_notified","parent_id","comment","is_visible_on_front"]},"sales-data-shipment-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentCommentInterface"},"sales-data-shipment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentInterface","properties":{"source_code":{"type":"string"}}},"sales-data-shipment-item-creation-interface":{"type":"object","description":"Input argument for shipment item creation Interface ShipmentItemCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-item-creation-extension-interface"},"order_item_id":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["order_item_id","qty"]},"sales-data-shipment-item-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentItemCreationInterface"},"sales-data-shipment-comment-creation-interface":{"type":"object","description":"Interface ShipmentCommentCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","is_visible_on_front"]},"sales-data-shipment-comment-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentCommentCreationInterface"},"sales-data-shipment-track-creation-interface":{"type":"object","description":"Shipment Track Creation interface.","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-track-creation-extension-interface"},"track_number":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrier_code":{"type":"string","description":"Carrier code."}},"required":["track_number","title","carrier_code"]},"sales-data-shipment-track-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentTrackCreationInterface"},"sales-data-shipment-package-creation-interface":{"type":"object","description":"Shipment package interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-package-creation-extension-interface"}}},"sales-data-shipment-package-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentPackageCreationInterface"},"sales-data-shipment-creation-arguments-interface":{"type":"object","description":"Interface for creation arguments for Shipment.","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-creation-arguments-extension-interface"}}},"sales-data-shipment-creation-arguments-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\ShipmentCreationArgumentsInterface","properties":{"source_code":{"type":"string"}}},"sales-data-invoice-item-creation-interface":{"type":"object","description":"Input argument for invoice creation Interface InvoiceItemCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-item-creation-extension-interface"},"order_item_id":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["order_item_id","qty"]},"sales-data-invoice-item-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemCreationInterface"},"sales-data-invoice-comment-creation-interface":{"type":"object","description":"Interface InvoiceCommentCreationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"is_visible_on_front":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","is_visible_on_front"]},"sales-data-invoice-comment-creation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceCommentCreationInterface"},"sales-data-invoice-creation-arguments-interface":{"type":"object","description":"Interface for creation arguments for Invoice.","properties":{"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-creation-arguments-extension-interface"}}},"sales-data-invoice-creation-arguments-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceCreationArgumentsInterface"},"requisition-list-data-requisition-list-interface":{"type":"object","description":"Interface RequisitionListInterface","properties":{"id":{"type":"integer","description":"Requisition List ID"},"customer_id":{"type":"integer","description":"Customer ID"},"name":{"type":"string","description":"Requisition List Name"},"updated_at":{"type":"string","description":"Requisition List Update Time"},"description":{"type":"string","description":"Requisition List Description"},"items":{"type":"array","description":"Requisition List Items","items":{"$ref":"#/definitions/requisition-list-data-requisition-list-item-interface"}},"extension_attributes":{"$ref":"#/definitions/requisition-list-data-requisition-list-extension-interface"}},"required":["id","customer_id","name","updated_at","description","items"]},"requisition-list-data-requisition-list-item-interface":{"type":"object","description":"Interface RequisitionListItemInterface","properties":{"id":{"type":"integer","description":"Requisition List ID."},"sku":{"type":"integer","description":"Product SKU."},"requisition_list_id":{"type":"integer","description":"Requisition List ID."},"qty":{"type":"number","description":"Product Qty."},"options":{"type":"array","description":"Requisition list item options.","items":{"type":"string"}},"store_id":{"type":"integer","description":"Store ID."},"added_at":{"type":"string","description":"Added_at value."},"extension_attributes":{"$ref":"#/definitions/requisition-list-data-requisition-list-item-extension-interface"}},"required":["id","sku","requisition_list_id","qty","options","store_id","added_at"]},"requisition-list-data-requisition-list-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\RequisitionList\\Api\\Data\\RequisitionListItemInterface"},"requisition-list-data-requisition-list-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\RequisitionList\\Api\\Data\\RequisitionListInterface"},"checkout-data-shipping-information-interface":{"type":"object","description":"Interface ShippingInformationInterface","properties":{"shipping_address":{"$ref":"#/definitions/quote-data-address-interface"},"billing_address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shipping_address","shipping_method_code","shipping_carrier_code"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"Interface TotalsInformationInterface","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["address"]},"checkout-data-totals-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\TotalsInformationInterface"},"sales-rule-data-rule-interface":{"type":"object","description":"Interface RuleInterface","properties":{"rule_id":{"type":"integer","description":"Rule id"},"name":{"type":"string","description":"Rule name"},"store_labels":{"type":"array","description":"Display label","items":{"$ref":"#/definitions/sales-rule-data-rule-label-interface"}},"description":{"type":"string","description":"Description"},"website_ids":{"type":"array","description":"A list of websites the rule applies to","items":{"type":"integer"}},"customer_group_ids":{"type":"array","description":"Ids of customer groups that the rule applies to","items":{"type":"integer"}},"from_date":{"type":"string","description":"The start date when the coupon is active"},"to_date":{"type":"string","description":"The end date when the coupon is active"},"uses_per_customer":{"type":"integer","description":"Number of uses per customer"},"is_active":{"type":"boolean","description":"The coupon is active"},"condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"action_condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"stop_rules_processing":{"type":"boolean","description":"To stop rule processing"},"is_advanced":{"type":"boolean","description":"Is this field needed"},"product_ids":{"type":"array","description":"Product ids","items":{"type":"integer"}},"sort_order":{"type":"integer","description":"Sort order"},"simple_action":{"type":"string","description":"Simple action of the rule"},"discount_amount":{"type":"number","description":"Discount amount"},"discount_qty":{"type":"number","description":"Maximum qty discount is applied"},"discount_step":{"type":"integer","description":"Discount step"},"apply_to_shipping":{"type":"boolean","description":"The rule applies to shipping"},"times_used":{"type":"integer","description":"How many times the rule has been used"},"is_rss":{"type":"boolean","description":"Whether the rule is in RSS"},"coupon_type":{"type":"string","description":"Coupon type"},"use_auto_generation":{"type":"boolean","description":"To auto generate coupon"},"uses_per_coupon":{"type":"integer","description":"Limit of uses per coupon"},"simple_free_shipping":{"type":"string","description":"To grant free shipping"},"extension_attributes":{"$ref":"#/definitions/sales-rule-data-rule-extension-interface"}},"required":["website_ids","customer_group_ids","uses_per_customer","is_active","stop_rules_processing","is_advanced","sort_order","discount_amount","discount_step","apply_to_shipping","times_used","is_rss","coupon_type","use_auto_generation","uses_per_coupon"]},"sales-rule-data-rule-label-interface":{"type":"object","description":"Interface RuleLabelInterface","properties":{"store_id":{"type":"integer","description":"StoreId"},"store_label":{"type":"string","description":"The label for the store"},"extension_attributes":{"$ref":"#/definitions/sales-rule-data-rule-label-extension-interface"}},"required":["store_id","store_label"]},"sales-rule-data-rule-label-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\RuleLabelInterface"},"sales-rule-data-condition-interface":{"type":"object","description":"Interface ConditionInterface","properties":{"condition_type":{"type":"string","description":"Condition type"},"conditions":{"type":"array","description":"List of conditions","items":{"$ref":"#/definitions/sales-rule-data-condition-interface"}},"aggregator_type":{"type":"string","description":"The aggregator type"},"operator":{"type":"string","description":"The operator of the condition"},"attribute_name":{"type":"string","description":"The attribute name of the condition"},"value":{"type":"string","description":"The value of the condition"},"extension_attributes":{"$ref":"#/definitions/sales-rule-data-condition-extension-interface"}},"required":["condition_type","operator","value"]},"sales-rule-data-condition-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\ConditionInterface"},"sales-rule-data-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\RuleInterface","properties":{"reward_points_delta":{"type":"integer"}}},"sales-rule-data-coupon-interface":{"type":"object","description":"Interface CouponInterface","properties":{"coupon_id":{"type":"integer","description":"Coupon id"},"rule_id":{"type":"integer","description":"The id of the rule associated with the coupon"},"code":{"type":"string","description":"Coupon code"},"usage_limit":{"type":"integer","description":"Usage limit"},"usage_per_customer":{"type":"integer","description":"Usage limit per customer"},"times_used":{"type":"integer","description":"The number of times the coupon has been used"},"expiration_date":{"type":"string","description":"Expiration date"},"is_primary":{"type":"boolean","description":"The coupon is primary coupon for the rule that it's associated with"},"created_at":{"type":"string","description":"When the coupon is created"},"type":{"type":"integer","description":"Of coupon"},"extension_attributes":{"$ref":"#/definitions/sales-rule-data-coupon-extension-interface"}},"required":["rule_id","times_used","is_primary"]},"sales-rule-data-coupon-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponInterface","properties":{"ddg_extension_attributes":{"$ref":"#/definitions/dotdigitalgroup-email-data-coupon-attribute-interface"}}},"dotdigitalgroup-email-data-coupon-attribute-interface":{"type":"object","description":"","properties":{"email":{"type":"string"},"expires_at":{"type":"string"}}},"sales-rule-data-coupon-generation-spec-interface":{"type":"object","description":"CouponGenerationSpecInterface","properties":{"rule_id":{"type":"integer","description":"The id of the rule associated with the coupon"},"format":{"type":"string","description":"Format of generated coupon code"},"quantity":{"type":"integer","description":"Of coupons to generate"},"length":{"type":"integer","description":"Length of coupon code"},"prefix":{"type":"string","description":"The prefix"},"suffix":{"type":"string","description":"The suffix"},"delimiter_at_every":{"type":"integer","description":"The spacing where the delimiter should exist"},"delimiter":{"type":"string","description":"The delimiter"},"extension_attributes":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"}},"required":["rule_id","format","quantity","length"]},"sales-rule-data-coupon-generation-spec-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponGenerationSpecInterface"},"tax-data-tax-rate-interface":{"type":"object","description":"Tax rate interface.","properties":{"id":{"type":"integer","description":"Id"},"tax_country_id":{"type":"string","description":"Country id"},"tax_region_id":{"type":"integer","description":"Region id"},"region_name":{"type":"string","description":"Region name"},"tax_postcode":{"type":"string","description":"Postcode"},"zip_is_range":{"type":"integer","description":"Zip is range"},"zip_from":{"type":"integer","description":"Zip range from"},"zip_to":{"type":"integer","description":"Zip range to"},"rate":{"type":"number","description":"Tax rate in percentage"},"code":{"type":"string","description":"Tax rate code"},"titles":{"type":"array","description":"Tax rate titles","items":{"$ref":"#/definitions/tax-data-tax-rate-title-interface"}},"extension_attributes":{"$ref":"#/definitions/tax-data-tax-rate-extension-interface"}},"required":["tax_country_id","rate","code"]},"tax-data-tax-rate-title-interface":{"type":"object","description":"Tax rate title interface.","properties":{"store_id":{"type":"string","description":"Store id"},"value":{"type":"string","description":"Title value"},"extension_attributes":{"$ref":"#/definitions/tax-data-tax-rate-title-extension-interface"}},"required":["store_id","value"]},"tax-data-tax-rate-title-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRateTitleInterface"},"tax-data-tax-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRateInterface"},"tax-data-tax-rule-interface":{"type":"object","description":"Tax rule interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Tax rule code"},"priority":{"type":"integer","description":"Priority"},"position":{"type":"integer","description":"Sort order."},"customer_tax_class_ids":{"type":"array","description":"Customer tax class id","items":{"type":"integer"}},"product_tax_class_ids":{"type":"array","description":"Product tax class id","items":{"type":"integer"}},"tax_rate_ids":{"type":"array","description":"Tax rate ids","items":{"type":"integer"}},"calculate_subtotal":{"type":"boolean","description":"Calculate subtotal."},"extension_attributes":{"$ref":"#/definitions/tax-data-tax-rule-extension-interface"}},"required":["code","priority","position","customer_tax_class_ids","product_tax_class_ids","tax_rate_ids"]},"tax-data-tax-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRuleInterface"},"tax-data-tax-class-interface":{"type":"object","description":"Tax class interface.","properties":{"class_id":{"type":"integer","description":"Tax class ID."},"class_name":{"type":"string","description":"Tax class name."},"class_type":{"type":"string","description":"Tax class type."},"extension_attributes":{"$ref":"#/definitions/tax-data-tax-class-extension-interface"}},"required":["class_name","class_type"]},"tax-data-tax-class-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxClassInterface"},"company-data-company-interface":{"type":"object","description":"Interface for Company entity.","properties":{"id":{"type":"integer","description":"Id."},"status":{"type":"integer","description":"Status."},"company_name":{"type":"string","description":"Company name."},"legal_name":{"type":"string","description":"Legal name."},"company_email":{"type":"string","description":"Company email."},"vat_tax_id":{"type":"string","description":"Vat tax id."},"reseller_id":{"type":"string","description":"Reseller Id."},"comment":{"type":"string","description":"Comment."},"street":{"type":"array","description":"Street.","items":{"type":"string"}},"city":{"type":"string","description":"City."},"country_id":{"type":"string","description":"Country."},"region":{"type":"string","description":"Region."},"region_id":{"type":"string","description":"Region Id."},"postcode":{"type":"string","description":"Postcode."},"telephone":{"type":"string","description":"Telephone."},"customer_group_id":{"type":"integer","description":"Customer Group Id."},"sales_representative_id":{"type":"integer","description":"Sales Representative Id."},"reject_reason":{"type":"string","description":"Reject Reason."},"rejected_at":{"type":"string","description":"Rejected at time."},"super_user_id":{"type":"integer","description":"Company admin customer id."},"extension_attributes":{"$ref":"#/definitions/company-data-company-extension-interface"}},"required":["street","customer_group_id","sales_representative_id","reject_reason","rejected_at","super_user_id"]},"company-data-company-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\CompanyInterface","properties":{"applicable_payment_method":{"type":"integer"},"available_payment_methods":{"type":"string"},"use_config_settings":{"type":"integer"},"quote_config":{"$ref":"#/definitions/negotiable-quote-data-company-quote-config-interface"}}},"negotiable-quote-data-company-quote-config-interface":{"type":"object","description":"Interface CompanyQuoteConfigInterface","properties":{"company_id":{"type":"string","description":"Company id"},"is_quote_enabled":{"type":"boolean","description":"Quote enabled for company"},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-company-quote-config-extension-interface"}},"required":["is_quote_enabled"]},"negotiable-quote-data-company-quote-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CompanyQuoteConfigInterface"},"company-data-team-interface":{"type":"object","description":"Team interface","properties":{"id":{"type":"integer","description":"ID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"extension_attributes":{"$ref":"#/definitions/company-data-team-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"company-data-team-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\TeamInterface"},"company-data-role-interface":{"type":"object","description":"Role data transfer object interface.","properties":{"id":{"type":"integer","description":"Role id."},"role_name":{"type":"string","description":"Role name."},"permissions":{"type":"array","description":"Permissions.","items":{"$ref":"#/definitions/company-data-permission-interface"}},"company_id":{"type":"integer","description":"Company id."},"extension_attributes":{"$ref":"#/definitions/company-data-role-extension-interface"}},"required":["permissions"]},"company-data-permission-interface":{"type":"object","description":"Permission interface.","properties":{"id":{"type":"integer","description":"Id."},"role_id":{"type":"integer","description":"Role id."},"resource_id":{"type":"string","description":"Resource id."},"permission":{"type":"string","description":"Permission."}},"required":["resource_id","permission"]},"company-data-role-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\RoleInterface"},"gift-card-account-data-gift-card-account-interface":{"type":"object","description":"Gift Card Account data","properties":{"gift_cards":{"type":"array","description":"Cards codes.","items":{"type":"string"}},"gift_cards_amount":{"type":"number","description":"Cards amount in quote currency."},"base_gift_cards_amount":{"type":"number","description":"Cards amount in base currency."},"gift_cards_amount_used":{"type":"number","description":"Cards amount used in quote currency."},"base_gift_cards_amount_used":{"type":"number","description":"Cards amount used in base currency."},"extension_attributes":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-extension-interface"}},"required":["gift_cards_amount","base_gift_cards_amount","gift_cards_amount_used","base_gift_cards_amount_used"]},"gift-card-account-data-gift-card-account-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCardAccount\\Api\\Data\\GiftCardAccountInterface"},"negotiable-quote-data-attachment-content-interface":{"type":"object","description":"Attachment files content interface.","properties":{"base64_encoded_data":{"type":"string","description":"Media data (base64 encoded content)."},"type":{"type":"string","description":"MIME type."},"name":{"type":"string","description":"File name."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-extension-interface"}},"required":["base64_encoded_data","type","name"]},"negotiable-quote-data-attachment-content-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\AttachmentContentInterface"},"shared-catalog-data-shared-catalog-interface":{"type":"object","description":"SharedCatalogInterface interface.","properties":{"id":{"type":"integer","description":"ID."},"name":{"type":"string","description":"Shared Catalog name."},"description":{"type":"string","description":"Shared Catalog description."},"customer_group_id":{"type":"integer","description":"Customer Group Id."},"type":{"type":"integer","description":"Shared Catalog type."},"created_at":{"type":"string","description":"Created time for Shared Catalog."},"created_by":{"type":"integer","description":"Admin id for Shared Catalog."},"store_id":{"type":"integer","description":"Store group id for Shared Catalog."},"tax_class_id":{"type":"integer","description":"Tax class id."}},"required":["name","description","customer_group_id","type","created_at","created_by","store_id","tax_class_id"]},"gift-wrapping-data-wrapping-interface":{"type":"object","description":"Interface WrappingInterface","properties":{"wrapping_id":{"type":"integer"},"design":{"type":"string"},"status":{"type":"integer"},"base_price":{"type":"number"},"image_name":{"type":"string"},"image_base64_content":{"type":"string"},"base_currency_code":{"type":"string"},"website_ids":{"type":"array","items":{"type":"integer"}},"image_url":{"type":"string","description":"Wrapping image URL."},"extension_attributes":{"$ref":"#/definitions/gift-wrapping-data-wrapping-extension-interface"}},"required":["design","status","base_price"]},"gift-wrapping-data-wrapping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftWrapping\\Api\\Data\\WrappingInterface"},"inventory-api-data-source-interface":{"type":"object","description":"Represents physical storage, i.e. brick and mortar store or warehouse Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"source_code":{"type":"string","description":"Source code"},"name":{"type":"string","description":"Source name"},"email":{"type":"string","description":"Source email"},"contact_name":{"type":"string","description":"Source contact name"},"enabled":{"type":"boolean","description":"If source is enabled. For new entity can be null"},"description":{"type":"string","description":"Source description"},"latitude":{"type":"number","description":"Source latitude"},"longitude":{"type":"number","description":"Source longitude"},"country_id":{"type":"string","description":"Source country id"},"region_id":{"type":"integer","description":"Region id if source has registered region."},"region":{"type":"string","description":"Region title if source has custom region"},"city":{"type":"string","description":"Source city"},"street":{"type":"string","description":"Source street name"},"postcode":{"type":"string","description":"Source post code"},"phone":{"type":"string","description":"Source phone number"},"fax":{"type":"string","description":"Source fax"},"use_default_carrier_config":{"type":"boolean","description":"Is need to use default config"},"carrier_links":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-carrier-link-interface"}},"extension_attributes":{"$ref":"#/definitions/inventory-api-data-source-extension-interface"}}},"inventory-api-data-source-carrier-link-interface":{"type":"object","description":"Represents relation between some physical storage and shipping method Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"carrier_code":{"type":"string","description":"Carrier code"},"position":{"type":"integer","description":"Position"},"extension_attributes":{"$ref":"#/definitions/inventory-api-data-source-carrier-link-extension-interface"}}},"inventory-api-data-source-carrier-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventoryApi\\Api\\Data\\SourceCarrierLinkInterface"},"inventory-api-data-source-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventoryApi\\Api\\Data\\SourceInterface"},"inventory-api-data-stock-interface":{"type":"object","description":"Represents product aggregation among some different physical storages (in technical words, it is an index) Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"stock_id":{"type":"integer","description":"Stock id"},"name":{"type":"string","description":"Stock name"},"extension_attributes":{"$ref":"#/definitions/inventory-api-data-stock-extension-interface"}}},"inventory-api-data-stock-extension-interface":{"type":"object","description":"TODO: temporal fix of extension classes generation during installation ExtensionInterface class for @see \\Magento\\InventoryApi\\Api\\Data\\StockInterface","properties":{"sales_channels":{"type":"array","items":{"$ref":"#/definitions/inventory-sales-api-data-sales-channel-interface"}}}},"inventory-sales-api-data-sales-channel-interface":{"type":"object","description":"Represents sales channels (which are a linkage between stocks and websites, customer groups, etc.) Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"type":{"type":"string","description":"Sales channel type"},"code":{"type":"string","description":"Sales channel code"},"extension_attributes":{"$ref":"#/definitions/inventory-sales-api-data-sales-channel-extension-interface"}}},"inventory-sales-api-data-sales-channel-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventorySalesApi\\Api\\Data\\SalesChannelInterface"},"inventory-api-data-stock-source-link-interface":{"type":"object","description":"Represents relation between Stock and Source entities. Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"stock_id":{"type":"integer","description":"Stock id"},"source_code":{"type":"string","description":"Source code of the link"},"priority":{"type":"integer","description":"Priority of the link"},"extension_attributes":{"$ref":"#/definitions/inventory-api-data-stock-source-link-extension-interface"}}},"inventory-api-data-stock-source-link-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventoryApi\\Api\\Data\\StockSourceLinkInterface"},"inventory-api-data-source-item-interface":{"type":"object","description":"Represents amount of product on physical storage Entity id getter is missed because entity identifies by compound identifier (sku and source_code) Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"sku":{"type":"string","description":"Source item sku"},"source_code":{"type":"string","description":"Source code"},"quantity":{"type":"number","description":"Source item quantity"},"status":{"type":"integer","description":"Source item status (One of self::STATUS_*)"},"extension_attributes":{"$ref":"#/definitions/inventory-api-data-source-item-extension-interface"}}},"inventory-api-data-source-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventoryApi\\Api\\Data\\SourceItemInterface"},"inventory-catalog-api-data-partial-inventory-transfer-item-interface":{"type":"object","description":"Specifies item and quantity for partial inventory transfer.","properties":{"sku":{"type":"string"},"qty":{"type":"number"}},"required":["sku","qty"]},"inventory-low-quantity-notification-api-data-source-item-configuration-interface":{"type":"object","description":"Represents a Source Item Configuration object Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"source_code":{"type":"string","description":"Source code"},"notify_stock_qty":{"type":"number","description":"Notify stock qty"},"sku":{"type":"string","description":"SKU"},"extension_attributes":{"$ref":"#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface"}}},"inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventoryLowQuantityNotificationApi\\Api\\Data\\SourceItemConfigurationInterface"},"inventory-source-selection-api-data-inventory-request-interface":{"type":"object","description":"Request products in a given Qty and StockId","properties":{"stock_id":{"type":"integer","description":"Stock Id"},"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/inventory-source-selection-api-data-item-request-interface"}},"extension_attributes":{"$ref":"#/definitions/inventory-source-selection-api-data-inventory-request-extension-interface"}},"required":["stock_id","items"]},"inventory-source-selection-api-data-item-request-interface":{"type":"object","description":"Represents requested quantity for particular product","properties":{"sku":{"type":"string","description":"SKU"},"qty":{"type":"number","description":"Product Quantity"},"extension_attributes":{"$ref":"#/definitions/inventory-source-selection-api-data-item-request-extension-interface"}},"required":["sku","qty"]},"inventory-source-selection-api-data-item-request-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventorySourceSelectionApi\\Api\\Data\\ItemRequestInterface"},"inventory-source-selection-api-data-inventory-request-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\InventorySourceSelectionApi\\Api\\Data\\InventoryRequestInterface","properties":{"destination_address":{"$ref":"#/definitions/inventory-source-selection-api-data-address-interface"}}},"inventory-source-selection-api-data-address-interface":{"type":"object","description":"Data interface for shipping source or shipping destination","properties":{"country":{"type":"string","description":"Shipping country"},"postcode":{"type":"string","description":"Shipping postcode"},"street":{"type":"string","description":"Shipping street address"},"region":{"type":"string","description":"Shipping region"},"city":{"type":"string","description":"Shipping city"}},"required":["country","postcode","street","region","city"]},"rma-data-track-interface":{"type":"object","description":"Interface TrackInterface","properties":{"entity_id":{"type":"integer","description":"Entity id"},"rma_entity_id":{"type":"integer","description":"Rma entity id"},"track_number":{"type":"string","description":"Track number"},"carrier_title":{"type":"string","description":"Carrier title"},"carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/rma-data-track-extension-interface"}},"required":["entity_id","rma_entity_id","track_number","carrier_title","carrier_code"]},"rma-data-track-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\TrackInterface"},"rma-data-rma-interface":{"type":"object","description":"Interface RmaInterface","properties":{"increment_id":{"type":"string","description":"Entity_id"},"entity_id":{"type":"integer","description":"Entity_id"},"order_id":{"type":"integer","description":"Order_id"},"order_increment_id":{"type":"string","description":"Order_increment_id"},"store_id":{"type":"integer","description":"Store_id"},"customer_id":{"type":"integer","description":"Customer_id"},"date_requested":{"type":"string","description":"Date_requested"},"customer_custom_email":{"type":"string","description":"Customer_custom_email"},"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/rma-data-item-interface"}},"status":{"type":"string","description":"Status"},"comments":{"type":"array","description":"Comments list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"tracks":{"type":"array","description":"Tracks list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"extension_attributes":{"$ref":"#/definitions/rma-data-rma-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["increment_id","entity_id","order_id","order_increment_id","store_id","customer_id","date_requested","customer_custom_email","items","status","comments","tracks"]},"rma-data-item-interface":{"type":"object","description":"Interface CategoryInterface","properties":{"entity_id":{"type":"integer","description":"Id"},"rma_entity_id":{"type":"integer","description":"RMA id"},"order_item_id":{"type":"integer","description":"Order_item_id"},"qty_requested":{"type":"integer","description":"Qty_requested"},"qty_authorized":{"type":"integer","description":"Qty_authorized"},"qty_approved":{"type":"integer","description":"Qty_approved"},"qty_returned":{"type":"integer","description":"Qty_returned"},"reason":{"type":"string","description":"Reason"},"condition":{"type":"string","description":"Condition"},"resolution":{"type":"string","description":"Resolution"},"status":{"type":"string","description":"Status"},"extension_attributes":{"$ref":"#/definitions/rma-data-item-extension-interface"}},"required":["entity_id","rma_entity_id","order_item_id","qty_requested","qty_authorized","qty_approved","qty_returned","reason","condition","resolution","status"]},"rma-data-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\ItemInterface"},"rma-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"comment":{"type":"string","description":"Comment"},"rma_entity_id":{"type":"integer","description":"Rma Id"},"created_at":{"type":"string","description":"Created_at"},"entity_id":{"type":"integer","description":"Entity_id"},"customer_notified":{"type":"boolean","description":"Is_customer_notified"},"visible_on_front":{"type":"boolean","description":"Is_visible_on_front"},"status":{"type":"string","description":"Status"},"admin":{"type":"boolean","description":"Is_admin"},"extension_attributes":{"$ref":"#/definitions/rma-data-comment-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["comment","rma_entity_id","created_at","entity_id","customer_notified","visible_on_front","status","admin"]},"rma-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\CommentInterface"},"rma-data-rma-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\RmaInterface"},"company-credit-data-credit-limit-interface":{"type":"object","description":"Credit Limit data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_id":{"type":"integer","description":"Company id."},"credit_limit":{"type":"number","description":"Credit Limit."},"balance":{"type":"number","description":"Balance."},"currency_code":{"type":"string","description":"Currency Code."},"exceed_limit":{"type":"boolean","description":"Exceed Limit."},"available_limit":{"type":"number","description":"Available Limit."},"credit_comment":{"type":"string","description":"Credit comment for company credit history."},"extension_attributes":{"$ref":"#/definitions/company-credit-data-credit-limit-extension-interface"}},"required":["exceed_limit"]},"company-credit-data-credit-limit-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CompanyCredit\\Api\\Data\\CreditLimitInterface"},"company-credit-data-credit-balance-options-interface":{"type":"object","description":"Credit balance data transfer object interface.","properties":{"purchase_order":{"type":"string","description":"Purchase order number."},"order_increment":{"type":"string","description":"Order increment."},"currency_display":{"type":"string","description":"Currency display."},"currency_base":{"type":"string","description":"Currency base."}},"required":["purchase_order","order_increment","currency_display","currency_base"]}},"x-tagGroups":[{"name":"addresses","tags":["addresses/{addressId}"]},{"name":"adobestock","tags":["adobestock/asset/{id}"]},{"name":"amazon billing address","tags":["amazon-billing-address/{amazonOrderReferenceId}"]},{"name":"amazon shipping address","tags":["amazon-shipping-address/{amazonOrderReferenceId}"]},{"name":"amazon","tags":["amazon/order-ref"]},{"name":"bundle products","tags":["bundle-products/options/add","bundle-products/options/{optionId}","bundle-products/{sku}/links/{id}","bundle-products/{sku}/links/{optionId}","bundle-products/{sku}/options/{optionId}","bundle-products/{sku}/options/{optionId}/children/{childSku}"]},{"name":"carts","tags":["carts/","carts/guest-carts/{cartId}/giftCards","carts/guest-carts/{cartId}/giftCards/{giftCardCode}","carts/mine","carts/mine/balance/apply","carts/mine/billing-address","carts/mine/collect-totals","carts/mine/coupons","carts/mine/coupons/{couponCode}","carts/mine/estimate-shipping-methods","carts/mine/estimate-shipping-methods-by-address-id","carts/mine/gift-message","carts/mine/gift-message/{itemId}","carts/mine/giftCards","carts/mine/giftCards/{giftCardCode}","carts/mine/items","carts/mine/items/{itemId}","carts/mine/order","carts/mine/payment-information","carts/mine/selected-payment-method","carts/mine/set-payment-information","carts/mine/shipping-information","carts/mine/totals-information","carts/{cartId}","carts/{cartId}/billing-address","carts/{cartId}/coupons","carts/{cartId}/coupons/{couponCode}","carts/{cartId}/estimate-shipping-methods","carts/{cartId}/estimate-shipping-methods-by-address-id","carts/{cartId}/gift-message","carts/{cartId}/gift-message/{itemId}","carts/{cartId}/giftCards","carts/{cartId}/giftCards/{giftCardCode}","carts/{cartId}/items/{itemId}","carts/{cartId}/order","carts/{cartId}/selected-payment-method","carts/{cartId}/shipping-information","carts/{cartId}/totals-information","carts/{quoteId}/items"]},{"name":"categories","tags":["categories","categories/{categoryId}","categories/{categoryId}/move","categories/{categoryId}/products","categories/{categoryId}/products/{sku}","categories/{id}"]},{"name":"cmsBlock","tags":["cmsBlock","cmsBlock/{blockId}","cmsBlock/{id}"]},{"name":"cmsPage","tags":["cmsPage","cmsPage/{id}","cmsPage/{pageId}"]},{"name":"company","tags":["company/","company/assignRoles","company/role/","company/role/{id}","company/role/{roleId}","company/{companyId}"]},{"name":"companyCredits","tags":["companyCredits/history/{historyId}","companyCredits/{creditId}/decreaseBalance","companyCredits/{creditId}/increaseBalance","companyCredits/{id}"]},{"name":"configurable products","tags":["configurable-products/variation","configurable-products/{sku}/child","configurable-products/{sku}/children/{childSku}","configurable-products/{sku}/options","configurable-products/{sku}/options/{id}"]},{"name":"coupons","tags":["coupons","coupons/deleteByCodes","coupons/deleteByIds","coupons/generate","coupons/{couponId}"]},{"name":"creditmemo","tags":["creditmemo","creditmemo/refund","creditmemo/{id}","creditmemo/{id}/comments","creditmemo/{id}/emails"]},{"name":"customerGroups","tags":["customerGroups","customerGroups/default/{id}","customerGroups/{id}"]},{"name":"customers","tags":["customers","customers/confirm","customers/isEmailAvailable","customers/me","customers/me/activate","customers/me/password","customers/password","customers/resetPassword","customers/validate","customers/{customerId}","customers/{customerId}/carts","customers/{email}/activate"]},{"name":"eav","tags":["eav/attribute-sets","eav/attribute-sets/{attributeSetId}"]},{"name":"gift wrappings","tags":["gift-wrappings","gift-wrappings/{id}","gift-wrappings/{wrappingId}"]},{"name":"giftregistry","tags":["giftregistry/mine/estimate-shipping-methods"]},{"name":"guest carts","tags":["guest-carts","guest-carts/{cartId}","guest-carts/{cartId}/billing-address","guest-carts/{cartId}/collect-totals","guest-carts/{cartId}/coupons","guest-carts/{cartId}/coupons/{couponCode}","guest-carts/{cartId}/estimate-shipping-methods","guest-carts/{cartId}/gift-message","guest-carts/{cartId}/gift-message/{itemId}","guest-carts/{cartId}/items","guest-carts/{cartId}/items/{itemId}","guest-carts/{cartId}/order","guest-carts/{cartId}/payment-information","guest-carts/{cartId}/selected-payment-method","guest-carts/{cartId}/set-payment-information","guest-carts/{cartId}/shipping-information","guest-carts/{cartId}/totals-information"]},{"name":"guest giftregistry","tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"]},{"name":"hierarchy","tags":["hierarchy/move/{id}"]},{"name":"integration","tags":["integration/admin/token","integration/customer/token"]},{"name":"inventory","tags":["inventory/bulk-partial-source-transfer","inventory/bulk-product-source-assign","inventory/bulk-product-source-transfer","inventory/bulk-product-source-unassign","inventory/low-quantity-notification","inventory/low-quantity-notifications-delete","inventory/source-items","inventory/source-items-delete","inventory/source-selection-algorithm-result","inventory/sources","inventory/sources/{sourceCode}","inventory/stock-source-links","inventory/stock-source-links-delete","inventory/stocks","inventory/stocks/{stockId}"]},{"name":"invoice","tags":["invoice/{invoiceId}/refund"]},{"name":"invoices","tags":["invoices/","invoices/comments","invoices/{id}/capture","invoices/{id}/emails","invoices/{id}/void"]},{"name":"msp 2fa","tags":["msp-2fa/default-provider-code/{userId}","msp-2fa/reset-provider/{userId}/{providerCode}","msp-2fa/trusted-devices/{tokenId}","msp-2fa/user-providers/{userId}"]},{"name":"negotiable carts","tags":["negotiable-carts/{cartId}/billing-address","negotiable-carts/{cartId}/coupons","negotiable-carts/{cartId}/coupons/{couponCode}","negotiable-carts/{cartId}/estimate-shipping-methods","negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id","negotiable-carts/{cartId}/giftCards","negotiable-carts/{cartId}/giftCards/{giftCardCode}","negotiable-carts/{cartId}/payment-information","negotiable-carts/{cartId}/set-payment-information","negotiable-carts/{cartId}/shipping-information"]},{"name":"negotiableQuote","tags":["negotiableQuote/decline","negotiableQuote/pricesUpdated","negotiableQuote/request","negotiableQuote/submitToCustomer","negotiableQuote/{quoteId}","negotiableQuote/{quoteId}/shippingMethod"]},{"name":"order","tags":["order/{orderId}/invoice","order/{orderId}/refund","order/{orderId}/ship"]},{"name":"orders","tags":["orders","orders/create","orders/{id}/cancel","orders/{id}/comments","orders/{id}/emails","orders/{id}/hold","orders/{id}/unhold","orders/{parent_id}"]},{"name":"products","tags":["products","products/attribute-sets","products/attribute-sets/attributes","products/attribute-sets/groups","products/attribute-sets/groups/{groupId}","products/attribute-sets/{attributeSetId}","products/attribute-sets/{attributeSetId}/attributes/{attributeCode}","products/attribute-sets/{attributeSetId}/groups","products/attributes","products/attributes/{attributeCode}","products/attributes/{attributeCode}/options","products/attributes/{attributeCode}/options/{optionId}","products/base-prices","products/base-prices-information","products/cost","products/cost-delete","products/cost-information","products/downloadable-links/samples/{id}","products/downloadable-links/{id}","products/options","products/options/{optionId}","products/special-price","products/special-price-delete","products/special-price-information","products/tier-prices","products/tier-prices-delete","products/tier-prices-information","products/{productSku}/stockItems/{itemId}","products/{sku}","products/{sku}/downloadable-links","products/{sku}/downloadable-links/samples","products/{sku}/downloadable-links/samples/{id}","products/{sku}/downloadable-links/{id}","products/{sku}/group-prices/{customerGroupId}/tiers/{qty}","products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}","products/{sku}/links","products/{sku}/links/{type}/{linkedProductSku}","products/{sku}/media","products/{sku}/media/{entryId}","products/{sku}/options/{optionId}","products/{sku}/websites","products/{sku}/websites/{websiteId}"]},{"name":"requisition_lists","tags":["requisition_lists"]},{"name":"returns","tags":["returns","returns/{id}","returns/{id}/comments","returns/{id}/tracking-numbers","returns/{id}/tracking-numbers/{trackId}"]},{"name":"reward","tags":["reward/mine/use-reward"]},{"name":"salesRules","tags":["salesRules","salesRules/{ruleId}"]},{"name":"sharedCatalog","tags":["sharedCatalog","sharedCatalog/{id}","sharedCatalog/{id}/assignCategories","sharedCatalog/{id}/assignProducts","sharedCatalog/{id}/unassignCategories","sharedCatalog/{id}/unassignProducts","sharedCatalog/{sharedCatalogId}","sharedCatalog/{sharedCatalogId}/assignCompanies","sharedCatalog/{sharedCatalogId}/unassignCompanies"]},{"name":"shipment","tags":["shipment/","shipment/track","shipment/track/{id}","shipment/{id}/comments","shipment/{id}/emails"]},{"name":"taxClasses","tags":["taxClasses","taxClasses/{classId}","taxClasses/{taxClassId}"]},{"name":"taxRates","tags":["taxRates","taxRates/{rateId}"]},{"name":"taxRules","tags":["taxRules","taxRules/{ruleId}"]},{"name":"team","tags":["team/{companyId}","team/{teamId}"]},{"name":"vertex address validation","tags":["vertex-address-validation/vertex-address"]},{"name":"worldpay guest carts","tags":["worldpay-guest-carts/{cartId}/payment-information"]}]} diff --git a/src/redoc/2.3/async-customer-rest-api.html b/src/redoc/2.3/async-customer-rest-api.html deleted file mode 100644 index 3382ac55030..00000000000 --- a/src/redoc/2.3/async-customer-rest-api.html +++ /dev/null @@ -1,5 +0,0 @@ ---- -guide_version: 2.3 -layout: redoc -specUrl: async-customer-schema.json ---- \ No newline at end of file diff --git a/src/redoc/2.3/async-customer-schema.json b/src/redoc/2.3/async-customer-schema.json deleted file mode 100644 index e75e54e561e..00000000000 --- a/src/redoc/2.3/async-customer-schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.3.5","title":"Magento Asynchronous Customer REST endpoints - All inclusive"},"host":"example.com","basePath":"/rest/default/async","schemes":["https"],"tags":[{"name":"amazon-billing-address/{amazonOrderReferenceId}"},{"name":"amazon-shipping-address/{amazonOrderReferenceId}"},{"name":"amazon/order-ref"},{"name":"carts/guest-carts/{cartId}/giftCards"},{"name":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"carts/mine"},{"name":"carts/mine/balance/apply"},{"name":"carts/mine/collect-totals"},{"name":"carts/mine/payment-information"},{"name":"carts/mine/set-payment-information"},{"name":"customers"},{"name":"customers/isEmailAvailable"},{"name":"customers/me/activate"},{"name":"customers/me/password"},{"name":"customers/password"},{"name":"customers/resetPassword"},{"name":"giftregistry/mine/estimate-shipping-methods"},{"name":"guest-carts"},{"name":"guest-carts/{cartId}"},{"name":"guest-carts/{cartId}/billing-address"},{"name":"guest-carts/{cartId}/collect-totals"},{"name":"guest-carts/{cartId}/coupons"},{"name":"guest-carts/{cartId}/coupons/{couponCode}"},{"name":"guest-carts/{cartId}/estimate-shipping-methods"},{"name":"guest-carts/{cartId}/gift-message"},{"name":"guest-carts/{cartId}/gift-message/{itemId}"},{"name":"guest-carts/{cartId}/items"},{"name":"guest-carts/{cartId}/items/{itemId}"},{"name":"guest-carts/{cartId}/order"},{"name":"guest-carts/{cartId}/payment-information"},{"name":"guest-carts/{cartId}/selected-payment-method"},{"name":"guest-carts/{cartId}/set-payment-information"},{"name":"guest-carts/{cartId}/shipping-information"},{"name":"guest-carts/{cartId}/totals-information"},{"name":"guest-giftregistry/{cartId}/estimate-shipping-methods"},{"name":"integration/admin/token"},{"name":"integration/customer/token"},{"name":"negotiable-carts/{cartId}/billing-address"},{"name":"negotiable-carts/{cartId}/coupons"},{"name":"negotiable-carts/{cartId}/coupons/{couponCode}"},{"name":"negotiable-carts/{cartId}/estimate-shipping-methods"},{"name":"negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"},{"name":"negotiable-carts/{cartId}/giftCards"},{"name":"negotiable-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"negotiable-carts/{cartId}/payment-information"},{"name":"negotiable-carts/{cartId}/set-payment-information"},{"name":"negotiable-carts/{cartId}/shipping-information"},{"name":"requisition_lists"},{"name":"reward/mine/use-reward"},{"name":"vertex-address-validation/vertex-address"},{"name":"worldpay-guest-carts/{cartId}/payment-information"}],"paths":{"/async/V1/amazon-billing-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-billing-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetBillingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetBillingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-billing-address/{amazonOrderReferenceId}"}},"/async/V1/amazon-shipping-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-shipping-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetShippingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetShippingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-shipping-address/{amazonOrderReferenceId}"}},"/async/V1/amazon/order-ref":{"delete":{"tags":["amazon/order-ref"],"description":"","operationId":"amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon/order-ref"}},"/async/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["carts/guest-carts/{cartId}/giftCards"],"description":"Add gift card to the cart.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards"}},"/async/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["carts/guest-carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1/carts/mine":{"put":{"tags":["carts/mine"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartRepositoryV1SavePutBody","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine"}},"/async/V1/carts/mine/balance/apply":{"post":{"tags":["carts/mine/balance/apply"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/balance/apply"}},"/async/V1/carts/mine/collect-totals":{"put":{"tags":["carts/mine/collect-totals"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteCartTotalManagementV1CollectTotalsPutBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"shippingCarrierCode":{"type":"string","description":"The carrier code."},"shippingMethodCode":{"type":"string","description":"The shipping method code."},"additionalData":{"$ref":"#/definitions/quote-data-totals-additional-data-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collect-totals"}},"/async/V1/carts/mine/payment-information":{"post":{"tags":["carts/mine/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/payment-information"}},"/async/V1/carts/mine/set-payment-information":{"post":{"tags":["carts/mine/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"checkoutPaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/set-payment-information"}},"/async/V1/customers":{"post":{"tags":["customers"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1CreateAccountPostBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers"}},"/async/V1/customers/isEmailAvailable":{"post":{"tags":["customers/isEmailAvailable"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1IsEmailAvailablePostBody","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/isEmailAvailable"}},"/async/V1/customers/me/activate":{"put":{"tags":["customers/me/activate"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ActivateByIdPutBody","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/activate"}},"/async/V1/customers/me/password":{"put":{"tags":["customers/me/password"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ChangePasswordByIdPutBody","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/password"}},"/async/V1/customers/password":{"put":{"tags":["customers/password"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1InitiatePasswordResetPutBody","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/password"}},"/async/V1/customers/resetPassword":{"post":{"tags":["customers/resetPassword"],"description":"Reset customer password.","operationId":"customerAccountManagementV1ResetPasswordPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ResetPasswordPostBody","in":"body","schema":{"required":["email","resetToken","newPassword"],"properties":{"email":{"type":"string","description":"If empty value given then the customer will be matched by the RP token."},"resetToken":{"type":"string"},"newPassword":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/resetPassword"}},"/async/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftregistry/mine/estimate-shipping-methods"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"giftregistry/mine/estimate-shipping-methods"}},"/async/V1/guest-carts":{"post":{"tags":["guest-carts"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts"}},"/async/V1/guest-carts/{cartId}":{"put":{"tags":["guest-carts/{cartId}"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartManagementV1AssignCustomerPutBody","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}"}},"/async/V1/guest-carts/{cartId}/billing-address":{"post":{"tags":["guest-carts/{cartId}/billing-address"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/billing-address"}},"/async/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["guest-carts/{cartId}/collect-totals"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartTotalManagementV1CollectTotalsPutBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"shippingCarrierCode":{"type":"string","description":"The carrier code."},"shippingMethodCode":{"type":"string","description":"The shipping method code."},"additionalData":{"$ref":"#/definitions/quote-data-totals-additional-data-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collect-totals"}},"/async/V1/guest-carts/{cartId}/coupons":{"delete":{"tags":["guest-carts/{cartId}/coupons"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons"}},"/async/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["guest-carts/{cartId}/coupons/{couponCode}"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons/{couponCode}"}},"/async/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/estimate-shipping-methods"}},"/async/V1/guest-carts/{cartId}/gift-message":{"post":{"tags":["guest-carts/{cartId}/gift-message"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"giftMessageGuestCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message"}},"/async/V1/guest-carts/{cartId}/gift-message/{itemId}":{"post":{"tags":["guest-carts/{cartId}/gift-message/{itemId}"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"giftMessageGuestItemRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message/{itemId}"}},"/async/V1/guest-carts/{cartId}/items":{"post":{"tags":["guest-carts/{cartId}/items"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items"}},"/async/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePutBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"},"delete":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"}},"/async/V1/guest-carts/{cartId}/order":{"put":{"tags":["guest-carts/{cartId}/order"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/order"}},"/async/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["guest-carts/{cartId}/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-information"}},"/async/V1/guest-carts/{cartId}/selected-payment-method":{"put":{"tags":["guest-carts/{cartId}/selected-payment-method"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestPaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/selected-payment-method"}},"/async/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["guest-carts/{cartId}/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/set-payment-information"}},"/async/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["guest-carts/{cartId}/shipping-information"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/shipping-information"}},"/async/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["guest-carts/{cartId}/totals-information"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/totals-information"}},"/async/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-giftregistry/{cartId}/estimate-shipping-methods"}},"/async/V1/integration/admin/token":{"post":{"tags":["integration/admin/token"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/admin/token"}},"/async/V1/integration/customer/token":{"post":{"tags":["integration/customer/token"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/customer/token"}},"/async/V1/negotiable-carts/{cartId}/billing-address":{"post":{"tags":["negotiable-carts/{cartId}/billing-address"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"negotiableQuoteBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/billing-address"}},"/async/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiable-carts/{cartId}/coupons"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons"}},"/async/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiable-carts/{cartId}/coupons/{couponCode}"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons/{couponCode}"}},"/async/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiable-carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/estimate-shipping-methods"}},"/async/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPostBody","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id"}},"/async/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiable-carts/{cartId}/giftCards"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards"}},"/async/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiable-carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiable-carts/{cartId}/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/payment-information"}},"/async/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiable-carts/{cartId}/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/set-payment-information"}},"/async/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiable-carts/{cartId}/shipping-information"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/shipping-information"}},"/async/V1/requisition_lists":{"post":{"tags":["requisition_lists"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"requisitionListRequisitionListRepositoryV1SavePostBody","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"requisition_lists"}},"/async/V1/reward/mine/use-reward":{"post":{"tags":["reward/mine/use-reward"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"reward/mine/use-reward"}},"/async/V1/vertex-address-validation/vertex-address":{"post":{"tags":["vertex-address-validation/vertex-address"],"description":"","operationId":"vertexAddressValidationAddressManagementV1GetValidAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"vertexAddressValidationAddressManagementV1GetValidAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"vertex-address-validation/vertex-address"}},"/async/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpay-guest-carts/{cartId}/payment-information"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"worldpay-guest-carts/{cartId}/payment-information"}}},"definitions":{"error-response":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"$ref":"#/definitions/error-errors"},"code":{"type":"integer","description":"Error code"},"parameters":{"$ref":"#/definitions/error-parameters"},"trace":{"type":"string","description":"Stack trace"}},"required":["message"]},"error-errors":{"type":"array","description":"Errors list","items":{"$ref":"#/definitions/error-errors-item"}},"error-errors-item":{"type":"object","description":"Error details","properties":{"message":{"type":"string","description":"Error message"},"parameters":{"$ref":"#/definitions/error-parameters"}}},"error-parameters":{"type":"array","description":"Error parameters list","items":{"$ref":"#/definitions/error-parameters-item"}},"error-parameters-item":{"type":"object","description":"Error parameters item","properties":{"resources":{"type":"string","description":"ACL resource"},"fieldName":{"type":"string","description":"Missing or invalid field name"},"fieldValue":{"type":"string","description":"Incorrect field value"}}},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"group_id":{"type":"integer","description":"Group id"},"default_billing":{"type":"string","description":"Default billing address id"},"default_shipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"created_at":{"type":"string","description":"Created at time"},"updated_at":{"type":"string","description":"Updated at time"},"created_in":{"type":"string","description":"Created in area"},"dob":{"type":"string","description":"Date of birth"},"email":{"type":"string","description":"Email address"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"gender":{"type":"integer","description":"Gender"},"store_id":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"website_id":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disable_auto_group_change":{"type":"integer","description":"Disable auto group change flag."},"extension_attributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["email","firstname","lastname"]},"customer-data-address-interface":{"type":"object","description":"Customer address interface.","properties":{"id":{"type":"integer","description":"ID"},"customer_id":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"region_id":{"type":"integer","description":"Region ID"},"country_id":{"type":"string","description":"Country code in ISO_3166-2 format"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"default_shipping":{"type":"boolean","description":"If this address is default shipping address."},"default_billing":{"type":"boolean","description":"If this address is default billing address"},"extension_attributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"region_code":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"region_id":{"type":"integer","description":"Region id"},"extension_attributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["region_code","region","region_id"]},"customer-data-region-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\RegionInterface"},"customer-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\AddressInterface"},"framework-attribute-interface":{"type":"object","description":"Interface for custom attribute value.","properties":{"attribute_code":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attribute_code","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface","properties":{"company_attributes":{"$ref":"#/definitions/company-data-company-customer-interface"},"is_subscribed":{"type":"boolean"},"amazon_id":{"type":"string"},"vertex_customer_code":{"type":"string"}}},"company-data-company-customer-interface":{"type":"object","description":"Extended customer custom attributes interface.","properties":{"customer_id":{"type":"integer","description":"Customer ID."},"company_id":{"type":"integer","description":"Company ID."},"job_title":{"type":"string","description":"Get job title."},"status":{"type":"integer","description":"Customer status."},"telephone":{"type":"string","description":"Get telephone."},"extension_attributes":{"$ref":"#/definitions/company-data-company-customer-extension-interface"}}},"company-data-company-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\CompanyCustomerInterface"},"asynchronous-operations-data-async-response-interface":{"type":"object","description":"Interface AsyncResponseInterface Temporary data object to give response from webapi async router","properties":{"bulk_uuid":{"type":"string","description":"Bulk Uuid."},"request_items":{"type":"array","description":"The list of request items with status data.","items":{"$ref":"#/definitions/asynchronous-operations-data-item-status-interface"}},"errors":{"type":"boolean","description":"There errors during processing bulk"},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-async-response-extension-interface"}},"required":["bulk_uuid","request_items","errors"]},"asynchronous-operations-data-item-status-interface":{"type":"object","description":"ItemStatusInterface interface Temporary object with status of requested item. Indicate if entity param was Accepted|Rejected to bulk schedule","properties":{"id":{"type":"integer","description":"Entity Id."},"data_hash":{"type":"string","description":"md5 hash of entity params array."},"status":{"type":"string","description":"accepted|rejected"},"error_message":{"type":"string","description":"Error information."},"error_code":{"type":"integer","description":"Error code."}},"required":["id","data_hash","status"]},"asynchronous-operations-data-async-response-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\AsyncResponseInterface"},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"created_at":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updated_at":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"converted_at":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"is_active":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"is_virtual":{"type":"boolean","description":"Virtual flag value. Otherwise, null."},"items":{"type":"array","description":"Array of items. Otherwise, null.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"items_count":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"items_qty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billing_address":{"$ref":"#/definitions/quote-data-address-interface"},"reserved_order_id":{"type":"string","description":"Reserved order ID. Otherwise, null."},"orig_order_id":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customer_is_guest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customer_note":{"type":"string","description":"Notice text"},"customer_note_notify":{"type":"boolean","description":"Customer notification flag"},"customer_tax_class_id":{"type":"integer","description":"Customer tax class ID."},"store_id":{"type":"integer","description":"Store identifier"},"extension_attributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","store_id"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"item_id":{"type":"integer","description":"Item ID. Otherwise, null."},"sku":{"type":"string","description":"Product SKU. Otherwise, null."},"qty":{"type":"number","description":"Product quantity."},"name":{"type":"string","description":"Product name. Otherwise, null."},"price":{"type":"number","description":"Product price. Otherwise, null."},"product_type":{"type":"string","description":"Product type. Otherwise, null."},"quote_id":{"type":"string","description":"Quote id."},"product_option":{"$ref":"#/definitions/quote-data-product-option-interface"},"extension_attributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quote_id"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-product-option-extension-interface"}}},"quote-data-product-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ProductOptionInterface","properties":{"custom_options":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundle_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"option_id":{"type":"string","description":"Option id"},"option_value":{"type":"string","description":"Option value"},"extension_attributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["option_id","option_value"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"file_info":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64_encoded_data":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64_encoded_data","type","name"]},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"option_id":{"type":"integer","description":"Bundle option id."},"option_qty":{"type":"integer","description":"Bundle option quantity."},"option_selections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extension_attributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["option_id","option_qty","option_selections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"option_id":{"type":"string","description":"Option SKU"},"option_value":{"type":"integer","description":"Item id"},"extension_attributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["option_id"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadable_links":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadable_links"]},"gift-card-data-gift-card-option-interface":{"type":"object","description":"Interface GiftCardOptionInterface","properties":{"giftcard_amount":{"type":"string","description":"Gift card amount."},"custom_giftcard_amount":{"type":"number","description":"Gift card open amount value."},"giftcard_sender_name":{"type":"string","description":"Gift card sender name."},"giftcard_recipient_name":{"type":"string","description":"Gift card recipient name."},"giftcard_sender_email":{"type":"string","description":"Gift card sender email."},"giftcard_recipient_email":{"type":"string","description":"Gift card recipient email."},"giftcard_message":{"type":"string","description":"Giftcard message."},"extension_attributes":{"$ref":"#/definitions/gift-card-data-gift-card-option-extension-interface"}},"required":["giftcard_amount","giftcard_sender_name","giftcard_recipient_name","giftcard_sender_email","giftcard_recipient_email"]},"gift-card-data-gift-card-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftCardOptionInterface","properties":{"giftcard_created_codes":{"type":"array","items":{"type":"string"}}}},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"negotiable_quote_item":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-interface"}}},"sales-rule-data-rule-discount-interface":{"type":"object","description":"Rule discount Interface","properties":{"discount_data":{"$ref":"#/definitions/sales-rule-data-discount-data-interface"},"rule_label":{"type":"string","description":"Rule Label"},"rule_id":{"type":"integer","description":"Rule ID"}},"required":["discount_data","rule_label","rule_id"]},"sales-rule-data-discount-data-interface":{"type":"object","description":"Discount Data Interface","properties":{"amount":{"type":"number","description":"Amount"},"base_amount":{"type":"number","description":"Base Amount"},"original_amount":{"type":"number","description":"Original Amount"},"base_original_amount":{"type":"number","description":"Base Original Amount"}},"required":["amount","base_amount","original_amount","base_original_amount"]},"negotiable-quote-data-negotiable-quote-item-interface":{"type":"object","description":"Interface CompanyQuoteConfigInterface","properties":{"item_id":{"type":"integer","description":"Quote item id"},"original_price":{"type":"number","description":"Quote item original price"},"original_tax_amount":{"type":"number","description":"Quote item original tax amount"},"original_discount_amount":{"type":"number","description":"Quote item original discount amount"},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"}},"required":["item_id","original_price","original_tax_amount","original_discount_amount"]},"negotiable-quote-data-negotiable-quote-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"region_id":{"type":"integer","description":"Region id"},"region_code":{"type":"string","description":"Region code"},"country_id":{"type":"string","description":"Country id"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"customer_id":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"same_as_billing":{"type":"integer","description":"Same as billing flag"},"customer_address_id":{"type":"integer","description":"Customer address id"},"save_in_address_book":{"type":"integer","description":"Save in address book flag"},"extension_attributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","region_id","region_code","country_id","street","telephone","postcode","city","firstname","lastname","email"]},"quote-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\AddressInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"gift_registry_id":{"type":"integer"}}},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"global_currency_code":{"type":"string","description":"Global currency code"},"base_currency_code":{"type":"string","description":"Base currency code"},"store_currency_code":{"type":"string","description":"Store currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"store_to_base_rate":{"type":"number","description":"Store currency to base currency rate"},"store_to_quote_rate":{"type":"number","description":"Store currency to quote currency rate"},"base_to_global_rate":{"type":"number","description":"Base currency to global currency rate"},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate"},"extension_attributes":{"$ref":"#/definitions/quote-data-currency-extension-interface"}}},"quote-data-currency-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CurrencyInterface"},"quote-data-cart-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartInterface","properties":{"shipping_assignments":{"type":"array","items":{"$ref":"#/definitions/quote-data-shipping-assignment-interface"}},"negotiable_quote":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-interface"},"amazon_order_reference_id":{"$ref":"#/definitions/amazon-payment-data-quote-link-interface"}}},"quote-data-shipping-assignment-interface":{"type":"object","description":"Interface ShippingAssignmentInterface","properties":{"shipping":{"$ref":"#/definitions/quote-data-shipping-interface"},"items":{"type":"array","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-assignment-extension-interface"}},"required":["shipping","items"]},"quote-data-shipping-interface":{"type":"object","description":"Interface ShippingInterface","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"method":{"type":"string","description":"Shipping method"},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-extension-interface"}},"required":["address","method"]},"quote-data-shipping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingInterface"},"quote-data-shipping-assignment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingAssignmentInterface"},"negotiable-quote-data-negotiable-quote-interface":{"type":"object","description":"Interface NegotiableQuoteInterface","properties":{"quote_id":{"type":"integer","description":"Negotiable quote ID."},"is_regular_quote":{"type":"boolean","description":"Is regular quote."},"status":{"type":"string","description":"Negotiable quote status."},"negotiated_price_type":{"type":"integer","description":"Negotiated price type."},"negotiated_price_value":{"type":"number","description":"Negotiated price value."},"shipping_price":{"type":"number","description":"Proposed shipping price."},"quote_name":{"type":"string","description":"Negotiable quote name."},"expiration_period":{"type":"string","description":"Expiration period."},"email_notification_status":{"type":"integer","description":"Email notification status."},"has_unconfirmed_changes":{"type":"boolean","description":"Has unconfirmed changes."},"is_shipping_tax_changed":{"type":"boolean","description":"Shipping tax changes."},"is_customer_price_changed":{"type":"boolean","description":"Customer price changes."},"notifications":{"type":"integer","description":"Quote notifications."},"applied_rule_ids":{"type":"string","description":"Quote rules."},"is_address_draft":{"type":"boolean","description":"Is address draft."},"deleted_sku":{"type":"string","description":"Deleted products sku."},"creator_id":{"type":"integer","description":"Quote creator id."},"creator_type":{"type":"integer","description":"Quote creator type."},"original_total_price":{"type":"number","description":"Quote original total price."},"base_original_total_price":{"type":"number","description":"Quote original total price in base currency."},"negotiated_total_price":{"type":"number","description":"Quote negotiated total price."},"base_negotiated_total_price":{"type":"number","description":"Quote negotiated total price in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-extension-interface"}},"required":["quote_id","is_regular_quote","status","negotiated_price_type","negotiated_price_value","shipping_price","quote_name","expiration_period","email_notification_status","has_unconfirmed_changes","is_shipping_tax_changed","is_customer_price_changed","notifications","applied_rule_ids","is_address_draft","deleted_sku","creator_id","creator_type"]},"negotiable-quote-data-negotiable-quote-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteInterface"},"amazon-payment-data-quote-link-interface":{"type":"object","description":"","properties":{"id":{"type":"string"},"amazon_order_reference_id":{"type":"string","description":"Amazon order reference id"},"quote_id":{"type":"integer","description":"Quote id"},"sandbox_simulation_reference":{"type":"string","description":"Sandbox simulation reference"},"confirmed":{"type":"boolean","description":"Quote confirmed with amazon"}},"required":["id","amazon_order_reference_id","quote_id","sandbox_simulation_reference","confirmed"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"po_number":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additional_data":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/quote-data-payment-extension-interface"}},"required":["method"]},"quote-data-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\PaymentInterface","properties":{"agreement_ids":{"type":"array","items":{"type":"string"}}}},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"quote-data-totals-additional-data-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsAdditionalDataInterface","properties":{"gift_messages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"Interface MessageInterface","properties":{"gift_message_id":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customer_id":{"type":"integer","description":"Customer ID. Otherwise, null."},"sender":{"type":"string","description":"Sender name."},"recipient":{"type":"string","description":"Recipient name."},"message":{"type":"string","description":"Message text."},"extension_attributes":{"$ref":"#/definitions/gift-message-data-message-extension-interface"}},"required":["sender","recipient","message"]},"gift-message-data-message-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftMessage\\Api\\Data\\MessageInterface","properties":{"entity_id":{"type":"string"},"entity_type":{"type":"string"},"wrapping_id":{"type":"integer"},"wrapping_allow_gift_receipt":{"type":"boolean"},"wrapping_add_printed_card":{"type":"boolean"}}},"requisition-list-data-requisition-list-interface":{"type":"object","description":"Interface RequisitionListInterface","properties":{"id":{"type":"integer","description":"Requisition List ID"},"customer_id":{"type":"integer","description":"Customer ID"},"name":{"type":"string","description":"Requisition List Name"},"updated_at":{"type":"string","description":"Requisition List Update Time"},"description":{"type":"string","description":"Requisition List Description"},"items":{"type":"array","description":"Requisition List Items","items":{"$ref":"#/definitions/requisition-list-data-requisition-list-item-interface"}},"extension_attributes":{"$ref":"#/definitions/requisition-list-data-requisition-list-extension-interface"}},"required":["id","customer_id","name","updated_at","description","items"]},"requisition-list-data-requisition-list-item-interface":{"type":"object","description":"Interface RequisitionListItemInterface","properties":{"id":{"type":"integer","description":"Requisition List ID."},"sku":{"type":"integer","description":"Product SKU."},"requisition_list_id":{"type":"integer","description":"Requisition List ID."},"qty":{"type":"number","description":"Product Qty."},"options":{"type":"array","description":"Requisition list item options.","items":{"type":"string"}},"store_id":{"type":"integer","description":"Store ID."},"added_at":{"type":"string","description":"Added_at value."},"extension_attributes":{"$ref":"#/definitions/requisition-list-data-requisition-list-item-extension-interface"}},"required":["id","sku","requisition_list_id","qty","options","store_id","added_at"]},"requisition-list-data-requisition-list-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\RequisitionList\\Api\\Data\\RequisitionListItemInterface"},"requisition-list-data-requisition-list-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\RequisitionList\\Api\\Data\\RequisitionListInterface"},"checkout-data-shipping-information-interface":{"type":"object","description":"Interface ShippingInformationInterface","properties":{"shipping_address":{"$ref":"#/definitions/quote-data-address-interface"},"billing_address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shipping_address","shipping_method_code","shipping_carrier_code"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"Interface TotalsInformationInterface","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["address"]},"checkout-data-totals-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\TotalsInformationInterface"},"gift-card-account-data-gift-card-account-interface":{"type":"object","description":"Gift Card Account data","properties":{"gift_cards":{"type":"array","description":"Cards codes.","items":{"type":"string"}},"gift_cards_amount":{"type":"number","description":"Cards amount in quote currency."},"base_gift_cards_amount":{"type":"number","description":"Cards amount in base currency."},"gift_cards_amount_used":{"type":"number","description":"Cards amount used in quote currency."},"base_gift_cards_amount_used":{"type":"number","description":"Cards amount used in base currency."},"extension_attributes":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-extension-interface"}},"required":["gift_cards_amount","base_gift_cards_amount","gift_cards_amount_used","base_gift_cards_amount_used"]},"gift-card-account-data-gift-card-account-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCardAccount\\Api\\Data\\GiftCardAccountInterface"}},"x-tagGroups":[{"name":"amazon billing address","tags":["amazon-billing-address/{amazonOrderReferenceId}"]},{"name":"amazon shipping address","tags":["amazon-shipping-address/{amazonOrderReferenceId}"]},{"name":"amazon","tags":["amazon/order-ref"]},{"name":"carts","tags":["carts/guest-carts/{cartId}/giftCards","carts/guest-carts/{cartId}/giftCards/{giftCardCode}","carts/mine","carts/mine/balance/apply","carts/mine/collect-totals","carts/mine/payment-information","carts/mine/set-payment-information"]},{"name":"customers","tags":["customers","customers/isEmailAvailable","customers/me/activate","customers/me/password","customers/password","customers/resetPassword"]},{"name":"giftregistry","tags":["giftregistry/mine/estimate-shipping-methods"]},{"name":"guest carts","tags":["guest-carts","guest-carts/{cartId}","guest-carts/{cartId}/billing-address","guest-carts/{cartId}/collect-totals","guest-carts/{cartId}/coupons","guest-carts/{cartId}/coupons/{couponCode}","guest-carts/{cartId}/estimate-shipping-methods","guest-carts/{cartId}/gift-message","guest-carts/{cartId}/gift-message/{itemId}","guest-carts/{cartId}/items","guest-carts/{cartId}/items/{itemId}","guest-carts/{cartId}/order","guest-carts/{cartId}/payment-information","guest-carts/{cartId}/selected-payment-method","guest-carts/{cartId}/set-payment-information","guest-carts/{cartId}/shipping-information","guest-carts/{cartId}/totals-information"]},{"name":"guest giftregistry","tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"]},{"name":"integration","tags":["integration/admin/token","integration/customer/token"]},{"name":"negotiable carts","tags":["negotiable-carts/{cartId}/billing-address","negotiable-carts/{cartId}/coupons","negotiable-carts/{cartId}/coupons/{couponCode}","negotiable-carts/{cartId}/estimate-shipping-methods","negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id","negotiable-carts/{cartId}/giftCards","negotiable-carts/{cartId}/giftCards/{giftCardCode}","negotiable-carts/{cartId}/payment-information","negotiable-carts/{cartId}/set-payment-information","negotiable-carts/{cartId}/shipping-information"]},{"name":"requisition_lists","tags":["requisition_lists"]},{"name":"reward","tags":["reward/mine/use-reward"]},{"name":"vertex address validation","tags":["vertex-address-validation/vertex-address"]},{"name":"worldpay guest carts","tags":["worldpay-guest-carts/{cartId}/payment-information"]}]} diff --git a/src/redoc/2.3/async-guest-rest-api.html b/src/redoc/2.3/async-guest-rest-api.html deleted file mode 100644 index c7404f00e05..00000000000 --- a/src/redoc/2.3/async-guest-rest-api.html +++ /dev/null @@ -1,5 +0,0 @@ ---- -guide_version: 2.3 -layout: redoc -specUrl: async-guest-schema.json ---- \ No newline at end of file diff --git a/src/redoc/2.3/async-guest-schema.json b/src/redoc/2.3/async-guest-schema.json deleted file mode 100644 index d256e610595..00000000000 --- a/src/redoc/2.3/async-guest-schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.3.5","title":"Magento Asynchronous Guest REST endpoints - All inclusive"},"host":"example.com","basePath":"/rest/default/async","schemes":["https"],"tags":[{"name":"amazon-billing-address/{amazonOrderReferenceId}"},{"name":"amazon-shipping-address/{amazonOrderReferenceId}"},{"name":"amazon/order-ref"},{"name":"carts/guest-carts/{cartId}/giftCards"},{"name":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"customers"},{"name":"customers/isEmailAvailable"},{"name":"customers/password"},{"name":"customers/resetPassword"},{"name":"guest-carts"},{"name":"guest-carts/{cartId}/billing-address"},{"name":"guest-carts/{cartId}/collect-totals"},{"name":"guest-carts/{cartId}/coupons"},{"name":"guest-carts/{cartId}/coupons/{couponCode}"},{"name":"guest-carts/{cartId}/estimate-shipping-methods"},{"name":"guest-carts/{cartId}/gift-message"},{"name":"guest-carts/{cartId}/gift-message/{itemId}"},{"name":"guest-carts/{cartId}/items"},{"name":"guest-carts/{cartId}/items/{itemId}"},{"name":"guest-carts/{cartId}/order"},{"name":"guest-carts/{cartId}/payment-information"},{"name":"guest-carts/{cartId}/selected-payment-method"},{"name":"guest-carts/{cartId}/set-payment-information"},{"name":"guest-carts/{cartId}/shipping-information"},{"name":"guest-carts/{cartId}/totals-information"},{"name":"guest-giftregistry/{cartId}/estimate-shipping-methods"},{"name":"integration/admin/token"},{"name":"integration/customer/token"},{"name":"vertex-address-validation/vertex-address"},{"name":"worldpay-guest-carts/{cartId}/payment-information"}],"paths":{"/async/V1amazon-billing-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-billing-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetBillingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetBillingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-billing-address/{amazonOrderReferenceId}"}},"/async/V1amazon-shipping-address/{amazonOrderReferenceId}":{"put":{"tags":["amazon-shipping-address/{amazonOrderReferenceId}"],"description":"","operationId":"amazonPaymentAddressManagementV1GetShippingAddressPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"amazonOrderReferenceId","in":"path","type":"string","required":true},{"name":"amazonPaymentAddressManagementV1GetShippingAddressPutBody","in":"body","schema":{"required":["addressConsentToken"],"properties":{"addressConsentToken":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-shipping-address/{amazonOrderReferenceId}"}},"/async/V1amazon/order-ref":{"delete":{"tags":["amazon/order-ref"],"description":"","operationId":"amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon/order-ref"}},"/async/V1carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["carts/guest-carts/{cartId}/giftCards"],"description":"Add gift card to the cart.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards"}},"/async/V1carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["carts/guest-carts/{cartId}/giftCards/{giftCardCode}"],"description":"Remove GiftCard Account entity.","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"}},"/async/V1customers":{"post":{"tags":["customers"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1CreateAccountPostBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers"}},"/async/V1customers/isEmailAvailable":{"post":{"tags":["customers/isEmailAvailable"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1IsEmailAvailablePostBody","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/isEmailAvailable"}},"/async/V1customers/password":{"put":{"tags":["customers/password"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1InitiatePasswordResetPutBody","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/password"}},"/async/V1customers/resetPassword":{"post":{"tags":["customers/resetPassword"],"description":"Reset customer password.","operationId":"customerAccountManagementV1ResetPasswordPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerAccountManagementV1ResetPasswordPostBody","in":"body","schema":{"required":["email","resetToken","newPassword"],"properties":{"email":{"type":"string","description":"If empty value given then the customer will be matched by the RP token."},"resetToken":{"type":"string"},"newPassword":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/resetPassword"}},"/async/V1guest-carts":{"post":{"tags":["guest-carts"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts"}},"/async/V1guest-carts/{cartId}/billing-address":{"post":{"tags":["guest-carts/{cartId}/billing-address"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/billing-address"}},"/async/V1guest-carts/{cartId}/collect-totals":{"put":{"tags":["guest-carts/{cartId}/collect-totals"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartTotalManagementV1CollectTotalsPutBody","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"shippingCarrierCode":{"type":"string","description":"The carrier code."},"shippingMethodCode":{"type":"string","description":"The shipping method code."},"additionalData":{"$ref":"#/definitions/quote-data-totals-additional-data-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collect-totals"}},"/async/V1guest-carts/{cartId}/coupons":{"delete":{"tags":["guest-carts/{cartId}/coupons"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons"}},"/async/V1guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["guest-carts/{cartId}/coupons/{couponCode}"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons/{couponCode}"}},"/async/V1guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-carts/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/estimate-shipping-methods"}},"/async/V1guest-carts/{cartId}/gift-message":{"post":{"tags":["guest-carts/{cartId}/gift-message"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"giftMessageGuestCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message"}},"/async/V1guest-carts/{cartId}/gift-message/{itemId}":{"post":{"tags":["guest-carts/{cartId}/gift-message/{itemId}"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"giftMessageGuestItemRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message/{itemId}"}},"/async/V1guest-carts/{cartId}/items":{"post":{"tags":["guest-carts/{cartId}/items"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items"}},"/async/V1guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"quoteGuestCartItemRepositoryV1SavePutBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"},"delete":{"tags":["guest-carts/{cartId}/items/{itemId}"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"}},"/async/V1guest-carts/{cartId}/order":{"put":{"tags":["guest-carts/{cartId}/order"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/order"}},"/async/V1guest-carts/{cartId}/payment-information":{"post":{"tags":["guest-carts/{cartId}/payment-information"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-information"}},"/async/V1guest-carts/{cartId}/selected-payment-method":{"put":{"tags":["guest-carts/{cartId}/selected-payment-method"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"quoteGuestPaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/selected-payment-method"}},"/async/V1guest-carts/{cartId}/set-payment-information":{"post":{"tags":["guest-carts/{cartId}/set-payment-information"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/set-payment-information"}},"/async/V1guest-carts/{cartId}/shipping-information":{"post":{"tags":["guest-carts/{cartId}/shipping-information"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/shipping-information"}},"/async/V1guest-carts/{cartId}/totals-information":{"post":{"tags":["guest-carts/{cartId}/totals-information"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"checkoutGuestTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/totals-information"}},"/async/V1guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-giftregistry/{cartId}/estimate-shipping-methods"}},"/async/V1integration/admin/token":{"post":{"tags":["integration/admin/token"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/admin/token"}},"/async/V1integration/customer/token":{"post":{"tags":["integration/customer/token"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/customer/token"}},"/async/V1vertex-address-validation/vertex-address":{"post":{"tags":["vertex-address-validation/vertex-address"],"description":"","operationId":"vertexAddressValidationAddressManagementV1GetValidAddressPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"vertexAddressValidationAddressManagementV1GetValidAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"vertex-address-validation/vertex-address"}},"/async/V1worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpay-guest-carts/{cartId}/payment-information"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPostBody","in":"body","schema":{"required":["email","paymentMethod"],"properties":{"email":{"type":"string"},"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object","xml":{"name":"request"}}}],"responses":{"202":{"description":"202 Accepted.","schema":{"$ref":"#/definitions/asynchronous-operations-data-async-response-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"worldpay-guest-carts/{cartId}/payment-information"}}},"definitions":{"error-response":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"$ref":"#/definitions/error-errors"},"code":{"type":"integer","description":"Error code"},"parameters":{"$ref":"#/definitions/error-parameters"},"trace":{"type":"string","description":"Stack trace"}},"required":["message"]},"error-errors":{"type":"array","description":"Errors list","items":{"$ref":"#/definitions/error-errors-item"}},"error-errors-item":{"type":"object","description":"Error details","properties":{"message":{"type":"string","description":"Error message"},"parameters":{"$ref":"#/definitions/error-parameters"}}},"error-parameters":{"type":"array","description":"Error parameters list","items":{"$ref":"#/definitions/error-parameters-item"}},"error-parameters-item":{"type":"object","description":"Error parameters item","properties":{"resources":{"type":"string","description":"ACL resource"},"fieldName":{"type":"string","description":"Missing or invalid field name"},"fieldValue":{"type":"string","description":"Incorrect field value"}}},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"group_id":{"type":"integer","description":"Group id"},"default_billing":{"type":"string","description":"Default billing address id"},"default_shipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"created_at":{"type":"string","description":"Created at time"},"updated_at":{"type":"string","description":"Updated at time"},"created_in":{"type":"string","description":"Created in area"},"dob":{"type":"string","description":"Date of birth"},"email":{"type":"string","description":"Email address"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"gender":{"type":"integer","description":"Gender"},"store_id":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"website_id":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disable_auto_group_change":{"type":"integer","description":"Disable auto group change flag."},"extension_attributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["email","firstname","lastname"]},"customer-data-address-interface":{"type":"object","description":"Customer address interface.","properties":{"id":{"type":"integer","description":"ID"},"customer_id":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"region_id":{"type":"integer","description":"Region ID"},"country_id":{"type":"string","description":"Country code in ISO_3166-2 format"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"default_shipping":{"type":"boolean","description":"If this address is default shipping address."},"default_billing":{"type":"boolean","description":"If this address is default billing address"},"extension_attributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"region_code":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"region_id":{"type":"integer","description":"Region id"},"extension_attributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["region_code","region","region_id"]},"customer-data-region-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\RegionInterface"},"customer-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\AddressInterface"},"framework-attribute-interface":{"type":"object","description":"Interface for custom attribute value.","properties":{"attribute_code":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attribute_code","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface","properties":{"company_attributes":{"$ref":"#/definitions/company-data-company-customer-interface"},"is_subscribed":{"type":"boolean"},"amazon_id":{"type":"string"},"vertex_customer_code":{"type":"string"}}},"company-data-company-customer-interface":{"type":"object","description":"Extended customer custom attributes interface.","properties":{"customer_id":{"type":"integer","description":"Customer ID."},"company_id":{"type":"integer","description":"Company ID."},"job_title":{"type":"string","description":"Get job title."},"status":{"type":"integer","description":"Customer status."},"telephone":{"type":"string","description":"Get telephone."},"extension_attributes":{"$ref":"#/definitions/company-data-company-customer-extension-interface"}}},"company-data-company-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\CompanyCustomerInterface"},"asynchronous-operations-data-async-response-interface":{"type":"object","description":"Interface AsyncResponseInterface Temporary data object to give response from webapi async router","properties":{"bulk_uuid":{"type":"string","description":"Bulk Uuid."},"request_items":{"type":"array","description":"The list of request items with status data.","items":{"$ref":"#/definitions/asynchronous-operations-data-item-status-interface"}},"errors":{"type":"boolean","description":"There errors during processing bulk"},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-async-response-extension-interface"}},"required":["bulk_uuid","request_items","errors"]},"asynchronous-operations-data-item-status-interface":{"type":"object","description":"ItemStatusInterface interface Temporary object with status of requested item. Indicate if entity param was Accepted|Rejected to bulk schedule","properties":{"id":{"type":"integer","description":"Entity Id."},"data_hash":{"type":"string","description":"md5 hash of entity params array."},"status":{"type":"string","description":"accepted|rejected"},"error_message":{"type":"string","description":"Error information."},"error_code":{"type":"integer","description":"Error code."}},"required":["id","data_hash","status"]},"asynchronous-operations-data-async-response-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\AsyncResponseInterface"},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"po_number":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additional_data":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/quote-data-payment-extension-interface"}},"required":["method"]},"quote-data-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\PaymentInterface","properties":{"agreement_ids":{"type":"array","items":{"type":"string"}}}},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"region_id":{"type":"integer","description":"Region id"},"region_code":{"type":"string","description":"Region code"},"country_id":{"type":"string","description":"Country id"},"street":{"type":"array","description":"Street","items":{"type":"string"}},"company":{"type":"string","description":"Company"},"telephone":{"type":"string","description":"Telephone number"},"fax":{"type":"string","description":"Fax number"},"postcode":{"type":"string","description":"Postcode"},"city":{"type":"string","description":"City name"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"middlename":{"type":"string","description":"Middle name"},"prefix":{"type":"string","description":"Prefix"},"suffix":{"type":"string","description":"Suffix"},"vat_id":{"type":"string","description":"Vat id"},"customer_id":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"same_as_billing":{"type":"integer","description":"Same as billing flag"},"customer_address_id":{"type":"integer","description":"Customer address id"},"save_in_address_book":{"type":"integer","description":"Save in address book flag"},"extension_attributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","region_id","region_code","country_id","street","telephone","postcode","city","firstname","lastname","email"]},"quote-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\AddressInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"gift_registry_id":{"type":"integer"}}},"sales-rule-data-rule-discount-interface":{"type":"object","description":"Rule discount Interface","properties":{"discount_data":{"$ref":"#/definitions/sales-rule-data-discount-data-interface"},"rule_label":{"type":"string","description":"Rule Label"},"rule_id":{"type":"integer","description":"Rule ID"}},"required":["discount_data","rule_label","rule_id"]},"sales-rule-data-discount-data-interface":{"type":"object","description":"Discount Data Interface","properties":{"amount":{"type":"number","description":"Amount"},"base_amount":{"type":"number","description":"Base Amount"},"original_amount":{"type":"number","description":"Original Amount"},"base_original_amount":{"type":"number","description":"Base Original Amount"}},"required":["amount","base_amount","original_amount","base_original_amount"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"item_id":{"type":"integer","description":"Item ID. Otherwise, null."},"sku":{"type":"string","description":"Product SKU. Otherwise, null."},"qty":{"type":"number","description":"Product quantity."},"name":{"type":"string","description":"Product name. Otherwise, null."},"price":{"type":"number","description":"Product price. Otherwise, null."},"product_type":{"type":"string","description":"Product type. Otherwise, null."},"quote_id":{"type":"string","description":"Quote id."},"product_option":{"$ref":"#/definitions/quote-data-product-option-interface"},"extension_attributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quote_id"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-product-option-extension-interface"}}},"quote-data-product-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ProductOptionInterface","properties":{"custom_options":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundle_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"option_id":{"type":"string","description":"Option id"},"option_value":{"type":"string","description":"Option value"},"extension_attributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["option_id","option_value"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"file_info":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64_encoded_data":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64_encoded_data","type","name"]},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"option_id":{"type":"integer","description":"Bundle option id."},"option_qty":{"type":"integer","description":"Bundle option quantity."},"option_selections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extension_attributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["option_id","option_qty","option_selections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"option_id":{"type":"string","description":"Option SKU"},"option_value":{"type":"integer","description":"Item id"},"extension_attributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["option_id"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadable_links":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadable_links"]},"gift-card-data-gift-card-option-interface":{"type":"object","description":"Interface GiftCardOptionInterface","properties":{"giftcard_amount":{"type":"string","description":"Gift card amount."},"custom_giftcard_amount":{"type":"number","description":"Gift card open amount value."},"giftcard_sender_name":{"type":"string","description":"Gift card sender name."},"giftcard_recipient_name":{"type":"string","description":"Gift card recipient name."},"giftcard_sender_email":{"type":"string","description":"Gift card sender email."},"giftcard_recipient_email":{"type":"string","description":"Gift card recipient email."},"giftcard_message":{"type":"string","description":"Giftcard message."},"extension_attributes":{"$ref":"#/definitions/gift-card-data-gift-card-option-extension-interface"}},"required":["giftcard_amount","giftcard_sender_name","giftcard_recipient_name","giftcard_sender_email","giftcard_recipient_email"]},"gift-card-data-gift-card-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftCardOptionInterface","properties":{"giftcard_created_codes":{"type":"array","items":{"type":"string"}}}},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"discounts":{"type":"array","items":{"$ref":"#/definitions/sales-rule-data-rule-discount-interface"}},"negotiable_quote_item":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-interface"}}},"negotiable-quote-data-negotiable-quote-item-interface":{"type":"object","description":"Interface CompanyQuoteConfigInterface","properties":{"item_id":{"type":"integer","description":"Quote item id"},"original_price":{"type":"number","description":"Quote item original price"},"original_tax_amount":{"type":"number","description":"Quote item original tax amount"},"original_discount_amount":{"type":"number","description":"Quote item original discount amount"},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface"}},"required":["item_id","original_price","original_tax_amount","original_discount_amount"]},"negotiable-quote-data-negotiable-quote-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemInterface"},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extension_attributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"quote-data-totals-additional-data-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsAdditionalDataInterface","properties":{"gift_messages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"Interface MessageInterface","properties":{"gift_message_id":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customer_id":{"type":"integer","description":"Customer ID. Otherwise, null."},"sender":{"type":"string","description":"Sender name."},"recipient":{"type":"string","description":"Recipient name."},"message":{"type":"string","description":"Message text."},"extension_attributes":{"$ref":"#/definitions/gift-message-data-message-extension-interface"}},"required":["sender","recipient","message"]},"gift-message-data-message-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftMessage\\Api\\Data\\MessageInterface","properties":{"entity_id":{"type":"string"},"entity_type":{"type":"string"},"wrapping_id":{"type":"integer"},"wrapping_allow_gift_receipt":{"type":"boolean"},"wrapping_add_printed_card":{"type":"boolean"}}},"checkout-data-shipping-information-interface":{"type":"object","description":"Interface ShippingInformationInterface","properties":{"shipping_address":{"$ref":"#/definitions/quote-data-address-interface"},"billing_address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shipping_address","shipping_method_code","shipping_carrier_code"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"Interface TotalsInformationInterface","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shipping_method_code":{"type":"string","description":"Shipping method code"},"shipping_carrier_code":{"type":"string","description":"Carrier code"},"extension_attributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["address"]},"checkout-data-totals-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\TotalsInformationInterface"},"gift-card-account-data-gift-card-account-interface":{"type":"object","description":"Gift Card Account data","properties":{"gift_cards":{"type":"array","description":"Cards codes.","items":{"type":"string"}},"gift_cards_amount":{"type":"number","description":"Cards amount in quote currency."},"base_gift_cards_amount":{"type":"number","description":"Cards amount in base currency."},"gift_cards_amount_used":{"type":"number","description":"Cards amount used in quote currency."},"base_gift_cards_amount_used":{"type":"number","description":"Cards amount used in base currency."},"extension_attributes":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-extension-interface"}},"required":["gift_cards_amount","base_gift_cards_amount","gift_cards_amount_used","base_gift_cards_amount_used"]},"gift-card-account-data-gift-card-account-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCardAccount\\Api\\Data\\GiftCardAccountInterface"}},"x-tagGroups":[{"name":"amazon billing address","tags":["amazon-billing-address/{amazonOrderReferenceId}"]},{"name":"amazon shipping address","tags":["amazon-shipping-address/{amazonOrderReferenceId}"]},{"name":"amazon","tags":["amazon/order-ref"]},{"name":"carts","tags":["carts/guest-carts/{cartId}/giftCards","carts/guest-carts/{cartId}/giftCards/{giftCardCode}"]},{"name":"customers","tags":["customers","customers/isEmailAvailable","customers/password","customers/resetPassword"]},{"name":"guest carts","tags":["guest-carts","guest-carts/{cartId}/billing-address","guest-carts/{cartId}/collect-totals","guest-carts/{cartId}/coupons","guest-carts/{cartId}/coupons/{couponCode}","guest-carts/{cartId}/estimate-shipping-methods","guest-carts/{cartId}/gift-message","guest-carts/{cartId}/gift-message/{itemId}","guest-carts/{cartId}/items","guest-carts/{cartId}/items/{itemId}","guest-carts/{cartId}/order","guest-carts/{cartId}/payment-information","guest-carts/{cartId}/selected-payment-method","guest-carts/{cartId}/set-payment-information","guest-carts/{cartId}/shipping-information","guest-carts/{cartId}/totals-information"]},{"name":"guest giftregistry","tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"]},{"name":"integration","tags":["integration/admin/token","integration/customer/token"]},{"name":"vertex address validation","tags":["vertex-address-validation/vertex-address"]},{"name":"worldpay guest carts","tags":["worldpay-guest-carts/{cartId}/payment-information"]}]} diff --git a/src/redoc/2.3/index.md b/src/redoc/2.3/index.md index 2f7df8d710f..9d79a90edd6 100644 --- a/src/redoc/2.3/index.md +++ b/src/redoc/2.3/index.md @@ -3,6 +3,7 @@ layout: default group: rest-api title: REST API reference guide_version: '2.3' +redirect_to: https://developer.adobe.com/commerce/webapi/rest/ --- Magento exposes different REST endpoints depending on the type of user making the requests. diff --git a/src/whats-new.md b/src/whats-new.md index 7cee9c145fd..be8c1f81e6a 100644 --- a/src/whats-new.md +++ b/src/whats-new.md @@ -1,6 +1,7 @@ --- layout: full-width title: What's new on DevDocs +redirect_to: https://experienceleague.adobe.com/docs/commerce-operations/operational-guides/home.html --- {% assign whatsnew = site.data.whats-new %} diff --git a/src/whatsnew-feed.xml b/src/whatsnew-feed.xml deleted file mode 100644 index 2bf97916aa9..00000000000 --- a/src/whatsnew-feed.xml +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: none ---- - - - - {% assign whatsnew = site.data.whats-new %} - {% assign page_link = site.url | append: site.baseurl | append: whatsnew.link %} - {{ whatsnew.title }} - {{ whatsnew.description }} - - {{ whatsnew.updated | date_to_rfc822 }} - {{ site.time | date_to_rfc822 }} - Jekyll v{{ jekyll.version }} - {% for entry in whatsnew.entries limit: 20 %} - {% assign link = entry.link %} - {% unless link %} - {% assign link = page_link %} - {% endunless %} - - {{ entry.type }} - {{ entry.date | date_to_rfc822 }} - - {{ entry.description | strip | markdownify| xml_escape }} - - {% endfor %} - \ No newline at end of file From 8f6a3fb501e7ccf8dd8d6935c955f3d85f962b97 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Mon, 5 Aug 2024 14:01:18 -0500 Subject: [PATCH 12/14] Update ruby dependencies (#3250) * Update ruby dependencies * Delete unnecessary dependencies * Disable unnecessary plugins * Downgrade jekyll to resolve dependency conflict on CI * Bypass testing tasks --- Gemfile | 22 ++++--- Gemfile.lock | 150 ++++++++++++---------------------------------- rakelib/test.rake | 32 +++++----- 3 files changed, 69 insertions(+), 135 deletions(-) diff --git a/Gemfile b/Gemfile index 6d194bd0a21..633d70e8fa0 100644 --- a/Gemfile +++ b/Gemfile @@ -3,28 +3,32 @@ source 'https://rubygems.org' gem 'devdocs', git: 'https://github.com/commerce-docs/devdocs-theme.git' -gem 'jekyll' +gem 'jekyll', '4.2.2' gem 'rake' -gem 'whatsup_github' +# gem 'whatsup_github' -gem 'wdm', platform: :mswin +# gem 'wdm', platform: :mswin group :test do gem 'html-proofer' gem 'launchy' - gem 'mdl' + # gem 'mdl' end -group :optimization do - gem 'image_optim' - gem 'image_optim_pack' -end +# group :optimization do +# gem 'image_optim' +# gem 'image_optim_pack' +# end group :jekyll_plugins do - gem 'jekyll-algolia', '~> 1.0' + # gem 'jekyll-algolia', '~> 1.0' gem 'jekyll-optional-front-matter' gem 'jekyll-redirect-from' gem 'jekyll-relative-links' gem 'jekyll-sitemap' gem 'jekyll-titles-from-headings' end + +group :resolutions do + gem 'ffi', '1.15.5' +end \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 0eaf975a125..0a07caf6c14 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,6 +1,6 @@ GIT remote: https://github.com/commerce-docs/devdocs-theme.git - revision: ec880cfbf9f79abe5628be4eab95db30a58839fa + revision: 04462e71c495bb63ecdf0fd61ca679b116da9026 specs: devdocs (20) jekyll (>= 4.0) @@ -8,33 +8,19 @@ GIT GEM remote: https://rubygems.org/ specs: - addressable (2.8.1) - public_suffix (>= 2.0.2, < 6.0) - algolia_html_extractor (2.6.4) - json (~> 2.0) - nokogiri (~> 1.10) - algoliasearch (1.27.5) - httpclient (~> 2.8, >= 2.8.3) - json (>= 1.5.1) - chef-utils (18.0.185) - concurrent-ruby + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + childprocess (5.0.0) colorator (1.1.0) - concurrent-ruby (1.1.10) + concurrent-ruby (1.3.3) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) ethon (0.16.0) ffi (>= 1.15.0) eventmachine (1.2.7) - exifr (1.3.10) - faraday (2.7.2) - faraday-net_http (>= 2.0, < 3.1) - ruby2_keywords (>= 0.0.4) - faraday-net_http (3.0.2) ffi (1.15.5) - filesize (0.2.0) forwardable-extended (2.6.0) - fspath (3.1.2) html-proofer (4.4.3) addressable (~> 2.3) mercenary (~> 0.3) @@ -45,53 +31,28 @@ GEM yell (~> 2.0) zeitwerk (~> 2.5) http_parser.rb (0.8.0) - httpclient (2.8.3) - i18n (1.12.0) + i18n (1.14.5) concurrent-ruby (~> 1.0) - image_optim (0.31.2) - exifr (~> 1.2, >= 1.2.2) - fspath (~> 3.0) - image_size (>= 1.5, < 4) - in_threads (~> 1.3) - progress (~> 3.0, >= 3.0.1) - image_optim_pack (0.9.1.20221210) - fspath (>= 2.1, < 4) - image_optim (~> 0.19) - image_optim_pack (0.9.1.20221210-x86_64-darwin) - fspath (>= 2.1, < 4) - image_optim (~> 0.19) - image_size (3.2.0) - in_threads (1.6.0) - jekyll (4.3.1) + jekyll (4.2.2) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) i18n (~> 1.0) - jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-sass-converter (~> 2.0) jekyll-watch (~> 2.0) - kramdown (~> 2.3, >= 2.3.1) + kramdown (~> 2.3) kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (>= 0.3.6, < 0.5) + mercenary (~> 0.4.0) pathutil (~> 0.9) - rouge (>= 3.0, < 5.0) + rouge (~> 3.0) safe_yaml (~> 1.0) - terminal-table (>= 1.8, < 4.0) - webrick (~> 1.7) - jekyll-algolia (1.7.1) - algolia_html_extractor (~> 2.6) - algoliasearch (~> 1.26) - filesize (~> 0.1) - jekyll (>= 3.6, < 5.0) - json (~> 2.0) - nokogiri (~> 1.6) - progressbar (~> 1.9) - verbal_expressions (~> 0.1.5) + terminal-table (~> 2.0) jekyll-optional-front-matter (0.3.2) jekyll (>= 3.0, < 5.0) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) + jekyll-relative-links (0.7.0) jekyll (>= 3.3, < 5.0) jekyll-sass-converter (2.2.0) sassc (> 2.0.1, < 3.0) @@ -101,78 +62,50 @@ GEM jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - json (2.6.3) kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) - launchy (2.5.0) - addressable (~> 2.7) - liquid (4.0.3) - listen (3.7.1) + launchy (3.0.1) + addressable (~> 2.8) + childprocess (~> 5.0) + liquid (4.0.4) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) - mdl (0.12.0) - kramdown (~> 2.3) - kramdown-parser-gfm (~> 1.1) - mixlib-cli (~> 2.1, >= 2.1.1) - mixlib-config (>= 2.2.1, < 4) - mixlib-shellout mercenary (0.4.0) - mini_portile2 (2.8.1) - mixlib-cli (2.1.8) - mixlib-config (3.0.27) - tomlrb - mixlib-shellout (3.2.7) - chef-utils - netrc (0.11.0) - nokogiri (1.14.3) - mini_portile2 (~> 2.8.0) + mini_portile2 (2.8.7) + nokogiri (1.15.6) + mini_portile2 (~> 2.8.2) racc (~> 1.4) - nokogiri (1.14.3-arm64-darwin) + nokogiri (1.15.6-arm64-darwin) racc (~> 1.4) - nokogiri (1.14.3-x86_64-darwin) + nokogiri (1.15.6-x86_64-darwin) racc (~> 1.4) - octokit (6.0.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) - parallel (1.22.1) + parallel (1.25.1) pathutil (0.16.2) forwardable-extended (~> 2.6) - progress (3.6.0) - progressbar (1.11.0) - public_suffix (5.0.1) - racc (1.6.2) + public_suffix (5.1.1) + racc (1.8.1) rainbow (3.1.1) - rake (13.0.6) + rake (13.2.1) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.2.5) - rouge (4.0.0) - ruby2_keywords (0.0.5) + rexml (3.3.4) + strscan + rouge (3.30.0) safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) - sawyer (0.9.2) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) - terminal-table (3.0.2) - unicode-display_width (>= 1.1.1, < 3) - thor (1.2.1) - tomlrb (2.0.3) - typhoeus (1.4.0) + strscan (3.1.0) + terminal-table (2.0.0) + unicode-display_width (~> 1.1, >= 1.1.1) + typhoeus (1.4.1) ethon (>= 0.9.0) - unicode-display_width (2.3.0) - verbal_expressions (0.1.5) - wdm (0.1.1) - webrick (1.7.0) - whatsup_github (0.5.0) - netrc (~> 0.11) - octokit (~> 6.0) - thor (~> 1.2) + unicode-display_width (1.8.0) yell (2.2.2) - zeitwerk (2.6.6) + zeitwerk (2.6.17) PLATFORMS arm64-darwin-22 @@ -184,21 +117,16 @@ PLATFORMS DEPENDENCIES devdocs! + ffi (= 1.15.5) html-proofer - image_optim - image_optim_pack - jekyll - jekyll-algolia (~> 1.0) + jekyll (= 4.2.2) jekyll-optional-front-matter jekyll-redirect-from jekyll-relative-links jekyll-sitemap jekyll-titles-from-headings launchy - mdl rake - wdm - whatsup_github BUNDLED WITH 2.1.4 diff --git a/rakelib/test.rake b/rakelib/test.rake index a0cdaa83b8b..21b49b78460 100644 --- a/rakelib/test.rake +++ b/rakelib/test.rake @@ -16,9 +16,10 @@ namespace :test do desc 'Check the existing _site for broken INTERNAL links' task :html do - puts 'Checking HTML ...'.magenta + # puts 'Checking HTML ...'.magenta - LinkChecker.check_site + # LinkChecker.check_site + puts 'Link checking has been disabled since the project is no longer supported'.magenta end desc 'Check the existing _site for broken links and report to a separate file' @@ -48,19 +49,20 @@ namespace :test do desc 'Test Markdown style with mdl' task :md do - puts 'Testing Markdown style with mdl ...'.magenta - print 'List the rules: $ '.magenta - sh 'bin/mdl -l --style=_checks/styles/style-rules-prod' - puts 'Linting ...'.magenta - output = - `bin/mdl \ - --style=_checks/styles/style-rules-prod \ - --ignore-front-matter \ - --git-recurse \ - -- .` - puts output.yellow - abort 'Fix the reported issues'.red unless output.empty? - puts 'No issues found'.green + # puts 'Testing Markdown style with mdl ...'.magenta + # print 'List the rules: $ '.magenta + # sh 'bin/mdl -l --style=_checks/styles/style-rules-prod' + # puts 'Linting ...'.magenta + # output = + # `bin/mdl \ + # --style=_checks/styles/style-rules-prod \ + # --ignore-front-matter \ + # --git-recurse \ + # -- .` + # puts output.yellow + # abort 'Fix the reported issues'.red unless output.empty? + # puts 'No issues found'.green + puts 'Markdown testing has been disabled since the project is no longer supported'.magenta end desc 'Find unused images. To exclude by regex pattern, use the "exclude_img" argument. Example of excluding a "layout" directory: "rake test:unused_includes exclude_img=/layout/"' From 3eefbf4f0d920b05e52293563367a4b6d2e19804 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Thu, 22 Aug 2024 16:20:40 -0500 Subject: [PATCH 13/14] Bump rexml from 3.3.4 to 3.3.6 (#3251) Bumps [rexml](https://github.com/ruby/rexml) from 3.3.4 to 3.3.6. - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.4...v3.3.6) --- updated-dependencies: - dependency-name: rexml dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 0a07caf6c14..7c5117154af 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -92,7 +92,7 @@ GEM rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.3.4) + rexml (3.3.6) strscan rouge (3.30.0) safe_yaml (1.0.5) From f99b4927ca0b0c75eb4910ecd718da00957f9491 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov <12731225+dshevtsov@users.noreply.github.com> Date: Fri, 15 Nov 2024 16:59:04 -0600 Subject: [PATCH 14/14] Update Readme (#3252) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95519bbe817..169996e61be 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This project contains the source code of the Adobe Commerce and Magento Open Sou > >[Adobe Commerce Documentation](https://experienceleague.adobe.com/docs/commerce.html) (Adobe Experience League)—Plan, implement, operate, upgrade, and maintain your Commerce projects > -> Some content was consolidated or moved to different guides. If you have trouble finding a topic, see the [Migrated topics](https://devdocs.magento.com/migrated.html). +> Some content was consolidated or moved to different guides. If you have trouble finding a topic, see the [Migrated topics](https://commerce-docs.github.io/devdocs-archive/migrated-topics.html). > > We welcome contributions to migrated content! You can find similar links to GitHub on the Adobe sites. >